commit 861d401f23776d1d82a5e11491c3bff9771934ef Author: asantibanez Date: Sun Oct 18 23:54:30 2020 -0500 Initial commit diff --git a/.editorconfig b/.editorconfig new file mode 100755 index 0000000..cd8eb86 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at http://editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.gitattributes b/.gitattributes new file mode 100755 index 0000000..bb6265e --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore all test and documentation with "export-ignore". +/.gitattributes export-ignore +/.gitignore export-ignore +/.travis.yml export-ignore +/phpunit.xml.dist export-ignore +/.scrutinizer.yml export-ignore +/tests export-ignore +/.editorconfig export-ignore diff --git a/.gitignore b/.gitignore new file mode 100755 index 0000000..e02cac5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.idea +build +composer.lock +docs +vendor +coverage diff --git a/.scrutinizer.yml b/.scrutinizer.yml new file mode 100755 index 0000000..df16b68 --- /dev/null +++ b/.scrutinizer.yml @@ -0,0 +1,19 @@ +filter: + excluded_paths: [tests/*] + +checks: + php: + remove_extra_empty_lines: true + remove_php_closing_tag: true + remove_trailing_whitespace: true + fix_use_statements: + remove_unused: true + preserve_multiple: false + preserve_blanklines: true + order_alphabetically: true + fix_php_opening_tag: true + fix_linefeed: true + fix_line_ending: true + fix_identation_4spaces: true + fix_doc_comments: true + diff --git a/.styleci.yml b/.styleci.yml new file mode 100755 index 0000000..f4d3cbc --- /dev/null +++ b/.styleci.yml @@ -0,0 +1,4 @@ +preset: laravel + +disabled: + - single_class_element_per_statement diff --git a/.travis.yml b/.travis.yml new file mode 100755 index 0000000..24c2d6c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,21 @@ +language: php + +php: + - 7.1 + - 7.2 + - 7.3 + +env: + matrix: + - COMPOSER_FLAGS="--prefer-lowest" + - COMPOSER_FLAGS="" + +before_script: + - travis_retry composer self-update + - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source + +script: + - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover + +after_script: + - php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100755 index 0000000..6466968 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `livewire-charts` will be documented in this file + +## 1.0.0 - 201X-XX-XX + +- initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100755 index 0000000..b4ae1c4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +Please read and understand the contribution guide before creating an issue or pull request. + +## Etiquette + +This project is open source, and as such, the maintainers give their free time to build and maintain the source code +held within. They make the code freely available in the hope that it will be of use to other developers. It would be +extremely unfair for them to suffer abuse or anger for their hard work. + +Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the +world that developers are civilized and selfless people. + +It's the duty of the maintainer to ensure that all submissions to the project are of sufficient +quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. + +## Viability + +When requesting or submitting new features, first consider whether it might be useful to others. Open +source projects are used by many developers, who may have entirely different needs to your own. Think about +whether or not your feature is likely to be used by other users of the project. + +## Procedure + +Before filing an issue: + +- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. +- Check to make sure your feature suggestion isn't already present within the project. +- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. +- Check the pull requests tab to ensure that the feature isn't already in progress. + +Before submitting a pull request: + +- Check the codebase to ensure that your feature doesn't already exist. +- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. + +## Requirements + +If the project maintainer has any additional requirements, you will find them listed here. + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer). + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +**Happy coding**! diff --git a/LICENSE.md b/LICENSE.md new file mode 100755 index 0000000..4122030 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) Andrés Santibáñez + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100755 index 0000000..333cd31 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Very short description of the package + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/asantibanez/livewire-charts.svg?style=flat-square)](https://packagist.org/packages/asantibanez/livewire-charts) +[![Build Status](https://img.shields.io/travis/asantibanez/livewire-charts/master.svg?style=flat-square)](https://travis-ci.org/asantibanez/livewire-charts) +[![Quality Score](https://img.shields.io/scrutinizer/g/asantibanez/livewire-charts.svg?style=flat-square)](https://scrutinizer-ci.com/g/asantibanez/livewire-charts) +[![Total Downloads](https://img.shields.io/packagist/dt/asantibanez/livewire-charts.svg?style=flat-square)](https://packagist.org/packages/asantibanez/livewire-charts) + +This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors. + +## Installation + +You can install the package via composer: + +```bash +composer require asantibanez/livewire-charts +``` + +## Usage + +``` php +// Usage description here +``` + +### Testing + +``` bash +composer test +``` + +### Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +### Security + +If you discover any security related issues, please email santibanez.andres@gmail.com instead of using the issue tracker. + +## Credits + +- [Andrés Santibáñez](https://github.com/asantibanez) +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. + +## Laravel Package Boilerplate + +This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com). \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100755 index 0000000..2f5f43a --- /dev/null +++ b/composer.json @@ -0,0 +1,55 @@ +{ + "name": "asantibanez/livewire-charts", + "description": "Livewire Charts", + "keywords": [ + "asantibanez", + "livewire-charts" + ], + "homepage": "https://github.com/asantibanez/livewire-charts", + "license": "MIT", + "type": "library", + "authors": [ + { + "name": "Andrés Santibáñez", + "email": "santibanez.andres@gmail.com", + "role": "Developer" + } + ], + "require": { + "php": "^7.2|^7.3|^7.4", + "illuminate/support": "^7.0|^8.0", + "livewire/livewire": "^2.3" + }, + "require-dev": { + "orchestra/testbench": "^4.0|^5.0", + "phpunit/phpunit": "^8.0" + }, + "autoload": { + "psr-4": { + "Asantibanez\\LivewireCharts\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "Asantibanez\\LivewireCharts\\Tests\\": "tests" + } + }, + "scripts": { + "test": "vendor/bin/phpunit", + "test-coverage": "vendor/bin/phpunit --coverage-html coverage" + + }, + "config": { + "sort-packages": true + }, + "extra": { + "laravel": { + "providers": [ + "Asantibanez\\LivewireCharts\\LivewireChartsServiceProvider" + ], + "aliases": { + "LivewireCharts": "Asantibanez\\LivewireCharts\\LivewireChartsFacade" + } + } + } +} diff --git a/config/config.php b/config/config.php new file mode 100755 index 0000000..48d0ee9 --- /dev/null +++ b/config/config.php @@ -0,0 +1,8 @@ + + + + + tests + + + + + src/ + + + + + + + + + + diff --git a/resources/views/livewire-column-chart.blade.php b/resources/views/livewire-column-chart.blade.php new file mode 100644 index 0000000..79ca4b2 --- /dev/null +++ b/resources/views/livewire-column-chart.blade.php @@ -0,0 +1,95 @@ +
+
+ + +
+ diff --git a/resources/views/livewire-line-chart.blade.php b/resources/views/livewire-line-chart.blade.php new file mode 100644 index 0000000..fac1ef7 --- /dev/null +++ b/resources/views/livewire-line-chart.blade.php @@ -0,0 +1,97 @@ +
+
+ + +
+ diff --git a/resources/views/livewire-pie-chart.blade.php b/resources/views/livewire-pie-chart.blade.php new file mode 100644 index 0000000..cde4dbf --- /dev/null +++ b/resources/views/livewire-pie-chart.blade.php @@ -0,0 +1,85 @@ +
+
+ + +
+ diff --git a/src/Charts/LivewireColumnChart.php b/src/Charts/LivewireColumnChart.php new file mode 100644 index 0000000..16fe6e5 --- /dev/null +++ b/src/Charts/LivewireColumnChart.php @@ -0,0 +1,36 @@ +columnChartModel = $columnChartModel->toArray(); + } + + public function onColumnClick($column) + { + $onColumnClickEventName = data_get($this->columnChartModel, 'onColumnClickEventName', null); + + if ($onColumnClickEventName === null) { + return; + } + + $this->emit($onColumnClickEventName, $column); + } + + public function render() + { + return view('livewire-charts::livewire-column-chart'); + } +} diff --git a/src/Charts/LivewireLineChart.php b/src/Charts/LivewireLineChart.php new file mode 100755 index 0000000..e76c5a0 --- /dev/null +++ b/src/Charts/LivewireLineChart.php @@ -0,0 +1,36 @@ +lineChartModel = $lineChartModel->toArray(); + } + + public function onPointClick($point) + { + $onPointClickEventName = data_get($this->lineChartModel, 'onPointClickEventName', null); + + if ($onPointClickEventName === null) { + return; + } + + $this->emit($onPointClickEventName, $point); + } + + public function render() + { + return view('livewire-charts::livewire-line-chart'); + } +} diff --git a/src/Charts/LivewirePieChart.php b/src/Charts/LivewirePieChart.php new file mode 100644 index 0000000..493194c --- /dev/null +++ b/src/Charts/LivewirePieChart.php @@ -0,0 +1,36 @@ +pieChartModel = $pieChartModel->toArray(); + } + + public function onSliceClick($slice) + { + $onSliceClickEventName = data_get($this->pieChartModel, 'onSliceClickEventName', null); + + if ($onSliceClickEventName === null) { + return; + } + + $this->emit($onSliceClickEventName, $slice); + } + + public function render() + { + return view('livewire-charts::livewire-pie-chart'); + } +} diff --git a/src/LivewireChartsServiceProvider.php b/src/LivewireChartsServiceProvider.php new file mode 100755 index 0000000..724ee76 --- /dev/null +++ b/src/LivewireChartsServiceProvider.php @@ -0,0 +1,38 @@ +loadViewsFrom(__DIR__.'/../resources/views', 'livewire-charts'); + + if ($this->app->runningInConsole()) { + $this->publishes([ + __DIR__.'/../resources/views' => resource_path('views/vendor/livewire-charts'), + ], 'livewire-charts-views'); + } + + Livewire::component('livewire-line-chart', LivewireLineChart::class); + Livewire::component('livewire-column-chart', LivewireColumnChart::class); + Livewire::component('livewire-pie-chart', LivewirePieChart::class); + } + + /** + * Register the application services. + */ + public function register() + { + // + } +} diff --git a/src/Models/ColumnChartModel.php b/src/Models/ColumnChartModel.php new file mode 100644 index 0000000..5f9cfae --- /dev/null +++ b/src/Models/ColumnChartModel.php @@ -0,0 +1,99 @@ +title = ''; + + $this->animated = false; + + $this->onColumnClickEventName = null; + + $this->opacity = 0.5; + + $this->data = collect(); + } + + public function setTitle($title) + { + $this->title = $title; + + return $this; + } + + public function setAnimated($animated) + { + $this->animated = $animated; + + return $this; + } + + public function setOpacity($opacity) + { + $this->opacity = $opacity; + + return $this; + } + + public function withOnColumnClickEventName($onColumnClickEventName) + { + $this->onColumnClickEventName = $onColumnClickEventName; + + return $this; + } + + public function addColumn($title, $value, $color, $extras = []) + { + $this->data->push([ + 'title' => $title, + 'value' => $value, + 'color' => $color, + 'extras' => $extras, + ]); + + return $this; + } + + public function toArray() + { + return [ + 'title' => $this->title, + 'animated' => $this->animated, + 'onColumnClickEventName' => $this->onColumnClickEventName, + 'opacity' => $this->opacity, + 'data' => $this->data->toArray(), + ]; + } + + public function fromArray($array) + { + $this->title = data_get($array, 'title', ''); + + $this->animated = data_get($array, 'animated', false); + + $this->onColumnClickEventName = data_get($array, 'onColumnClickEventName', null); + + $this->opacity = data_get($array, 'opacity', 0.5); + + $this->data = collect(data_get($array, 'data', [])); + } + +} diff --git a/src/Models/LineChartModel.php b/src/Models/LineChartModel.php new file mode 100644 index 0000000..3683a4a --- /dev/null +++ b/src/Models/LineChartModel.php @@ -0,0 +1,110 @@ +title = ''; + + $this->animated = false; + + $this->onPointClickEventName = null; + + $this->data = collect(); + + $this->markers = collect(); + } + + public function setTitle($title) + { + $this->title = $title; + + return $this; + } + + public function setAnimated($animated) + { + $this->animated = $animated; + + return $this; + } + + public function addPoint($title, $value, $extras = []) + { + $this->data->push([ + 'title' => $title, + 'value' => $value, + 'extras' => $extras, + ]); + + return $this; + } + + public function addMarker($title, + $value, + $strokeColor = 'green', + $text = '', + $textColor = '#ffffff', + $textBackgroundColor = '#cccccc') + { + $this->markers->push([ + 'title' => $title, + 'value' => $value, + 'strokeColor' => $strokeColor, + 'text' => $text, + 'textColor' => $textColor, + 'textBackgroundColor' => $textBackgroundColor, + ]); + + return $this; + } + + public function withOnPointClickEvent($onPointClickEventName) + { + $this->onPointClickEventName = $onPointClickEventName; + + return $this; + } + + public function toArray() + { + return [ + 'title' => $this->title, + 'animated' => $this->animated, + 'onPointClickEventName' => $this->onPointClickEventName, + 'data' => $this->data->toArray(), + 'markers' => $this->markers->toArray(), + ]; + } + + public function fromArray($array) + { + $this->title = data_get($array, 'title', ''); + + $this->animated = data_get($array, 'animated', false); + + $this->onPointClickEventName = data_get($array, 'onPointClickEventName', null); + + $this->data = collect(data_get($array, 'data', [])); + + $this->markers = collect(data_get($array, 'markers', [])); + } + +} diff --git a/src/Models/PieChartModel.php b/src/Models/PieChartModel.php new file mode 100644 index 0000000..11202e0 --- /dev/null +++ b/src/Models/PieChartModel.php @@ -0,0 +1,99 @@ +title = ''; + + $this->animated = false; + + $this->onSliceClickEventName = null; + + $this->opacity = 0.75; + + $this->data = collect(); + } + + public function setTitle($title) + { + $this->title = $title; + + return $this; + } + + public function setAnimated($animated) + { + $this->animated = $animated; + + return $this; + } + + public function setOpacity($opacity) + { + $this->opacity = $opacity; + + return $this; + } + + public function withOnSliceClickEvent($onSliceClickEventName) + { + $this->onSliceClickEventName = $onSliceClickEventName; + + return $this; + } + + public function addSlice($title, $value, $color, $extras = []) + { + $this->data->push([ + 'title' => $title, + 'value' => $value, + 'color' => $color, + 'extras' => $extras, + ]); + + return $this; + } + + public function toArray() + { + return [ + 'title' => $this->title, + 'animated' => $this->animated, + 'onSliceClickEventName' => $this->onSliceClickEventName, + 'opacity' => $this->opacity, + 'data' => $this->data->toArray(), + ]; + } + + public function fromArray($array) + { + $this->title = data_get($array, 'title', ''); + + $this->animated = data_get($array, 'animated', false); + + $this->onSliceClickEventName = data_get($array, 'onSliceClickEventName', null); + + $this->opacity = data_get($array, 'opacity', 0.75); + + $this->data = collect(data_get($array, 'data', [])); + } + +} diff --git a/tests/ExampleTest.php b/tests/ExampleTest.php new file mode 100755 index 0000000..a2fa5ef --- /dev/null +++ b/tests/ExampleTest.php @@ -0,0 +1,21 @@ +assertTrue(true); + } +}