Native typehints, strict types

.docs/README.md

@@ -0,0 +1,204 @@
+# Tlapnet Chart
+
+Graphs and charts based on [C3.js](http://c3js.org/)
+
+## Content
+
+- [Assets](#Assets)
+- [Graphs](#graphs)
+	- [Chart](#chart)
+	- [CategoryChart](#categorychart)
+	- [DateChart](#datechart)
+	- [DonutChart](#donutchart)
+	- [PieChart](#piechart)
+- [Series](#series)
+	- [Stacking series](#stacking-series)
+	- [Types](#types)
+
+## Assets
+
+Graphs are rendered through [C3.js](http://c3js.org/).
+
+```html
+<!-- Load c3.css -->
+<link href="/path/to/c3.css" rel="stylesheet" type="text/css">
+<!-- Load d3.js and c3.js -->
+<script src="/path/to/d3.v3.min.js"></script>
+<script src="/path/to/c3.min.js"></script>
+```
+
+## Graphs
+
+### Chart
+
+- x (number), y (number)
+
+```php
+use Tlapnet\Chart\Chart;
+use Tlapnet\Chart\Serie\Serie;
+use Tlapnet\Chart\Segment\Segment;
+
+$chart = new Chart();
+
+$serie = new Serie(Serie::LINE, 'Serie 1', 'red');
+$serie->addSegment(new Segment(5, 10));
+$serie->addSegment(new Segment(6, 4));
+$serie->addSegment(new Segment(2, 8));
+$chart->addSerie($serie);
+
+$serie = new Serie(Serie::LINE, 'Serie 2');
+$serie->addSegment(new Segment(2, 8));
+$serie->addSegment(new Segment(4, 6));
+$serie->addSegment(new Segment(8, 5));
+$serie->addSegment(new Segment(7, 7));
+$chart->addSerie($serie);
+
+echo $chart;
+```
+
+![Chart](./assets/Chart.png?raw=true)
+
+### CategoryChart
+
+- x (unique key, string|int), y (number)
+
+```php
+use Tlapnet\Chart\Category;
+use Tlapnet\Chart\CategoryChart;
+use Tlapnet\Chart\Serie\CategorySerie;
+use Tlapnet\Chart\Segment\CategorySegment;
+
+$chart = new CategoryChart([
+	new Category(1, 'January'),
+	new Category(2, 'February'),
+	new Category(3, 'March'),
+]);
+$chart->setValueSuffix(' $');
+
+$serie = new CategorySerie(CategorySerie::BAR, 'Company 1', 'red');
+$serie->addSegment(new CategorySegment(1, 0));
+$serie->addSegment(new CategorySegment(2, 4000));
+$serie->addSegment(new CategorySegment(3, 1000));
+$chart->addSerie($serie, 'group1');
+
+$serie = new CategorySerie(CategorySerie::BAR, 'Company 2', 'green');
+$serie->addSegment(new CategorySegment(1, 3000));
+// Segments could be omitted (default value is 0)
+$serie->addSegment(new CategorySegment(3, 500));
+$chart->addSerie($serie, 'group1');
+
+$serie = new CategorySerie(CategorySerie::LINE, 'Summary');
+$serie->addSegment(new CategorySegment(1, 3000));
+$serie->addSegment(new CategorySegment(3, 1500));
+$serie->addSegment(new CategorySegment(2, 4000));
+$chart->addSerie($serie);
+
+echo $chart;
+```
+
+![CategoryChart](./assets/CategoryChart.png?raw=true)
+
+### DateChart
+
+- x (date), y (number)
+
+```php
+use Tlapnet\Chart\DateChart;
+use Tlapnet\Chart\Serie\DateSerie;
+use Tlapnet\Chart\Segment\DateSegment;
+use DateTimeImmutable;
+
+$chart = new DateChart();
+$chart->setValueSuffix(' $');
+//$chart->enableTimePrecision(); // Enable time accurate to seconds
+
+$serie = new DateSerie(DateSerie::LINE, 'Revenues', 'green');
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-01-01'), 10));
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-02-01'), 4));
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-03-01'), 8));
+$chart->addSerie($serie);
+
+$serie = new DateSerie(DateSerie::LINE, 'Costs', 'red');
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-01-01'), 2));
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-02-01'), 9));
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-03-01'), 5));
+$chart->addSerie($serie);
+
+$serie = new DateSerie(DateSerie::AREA_LINE, 'Balance', 'blue');
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-01-01'), 8));
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-02-01'), -5));
+$serie->addSegment(new DateSegment(new DateTimeImmutable('2012-03-01'), 3));
+$chart->addSerie($serie);
+
+echo $chart;
+```
+
+![DateChart](./assets/DateChart.png?raw=true)
+
+### DonutChart
+
+```php
+use Tlapnet\Chart\DonutChart;
+use Tlapnet\Chart\Segment\DonutSegment;
+
+$chart = new DonutChart();
+$chart->setTitle(15);
+$chart->setValueSuffix(' pcs');
+$chart->enableRatioLabel(); // Show percents instead of absolute values
+$chart->addSegment(new DonutSegment('Item 1', 5));
+$chart->addSegment(new DonutSegment('Item 2', 8));
+$chart->addSegment(new DonutSegment('Item 3', 2));
+
+echo $chart;
+```
+
+![DonutChart](./assets/DonutChart.png?raw=true)
+
+### PieChart
+
+```php
+use Tlapnet\Chart\PieChart;
+use Tlapnet\Chart\Segment\PieSegment;
+
+$chart = new PieChart();
+$chart->enableRatioLabel(); // Show percents instead of absolute values
+$chart->setValueSuffix(' pcs');
+$chart->addSegment(new PieSegment('Item 1', 5));
+$chart->addSegment(new PieSegment('Item 2', 8));
+$chart->addSegment(new PieSegment('Item 3', 2));
+
+echo $chart;
+```
+
+![PieChart](./assets/PieChart.png?raw=true)
+
+## Series
+
+Graphs Chart, CategoryChart and DateChart each have their series (Serie, CategorySerie, DateSerie).
+
+### Stacking series
+
+```php
+$chart->addSerie($barSerie1, 'group1');
+$chart->addSerie($barSerie2, 'group1');
+$chart->addSerie($barSerie3, 'group1');
+$chart->addSerie($barSerie4, 'group1');
+```
+
+```php
+// Group name could be any value valid for array key
+// Null (default value) mean no group
+$chart->addSerie($splineSerie1, 1);
+$chart->addSerie($splineSerie2, 1);
+```
+
+### Types
+
+- *Serie::BAR
+- *Serie::LINE
+- *Serie::SPLINE
+- *Serie::STEP
+- *Serie::AREA_LINE
+- *Serie::AREA_SPLINE
+- *Serie::AREA_STEP
+

.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = tab
+tab_width = 4
+
+[*.md,*.yml]
+indent_style = space
+indent_size = 4
+
+[{composer.json,package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,11 @@
+# Not archived
+.docs export-ignore
+tests export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+LICENSE export-ignore
+phpstan.neon export-ignore
+README.md export-ignore
+ruleset.xml export-ignore

.gitignore

@@ -1,9 +1,10 @@
-.DS_Store
-/.idea/
+# IDE
+/.idea
 
-/vendor/
+# Composer
+/vendor
 /composer.lock
 
-phpunit.xml
-
-!.gitkeep
+# Tests
+/temp
+/coverage.xml

.travis.yml

@@ -0,0 +1,53 @@
+language: php
+php:
+  - 7.1
+  - 7.2
+
+install:
+  # Composer
+  - travis_retry composer install --no-progress --prefer-dist
+
+script:
+  # PhpUnit
+  - composer run-script phpunit
+
+jobs:
+  include:
+    - env: title="Lowest Dependencies 7.2"
+      php: 7.2
+      install:
+        - travis_retry composer update --no-progress --prefer-dist --prefer-lowest
+      script:
+        - composer run-script phpunit
+
+    - stage: Quality Assurance
+      php: 7.2
+      script:
+        - composer run-script qa
+
+    - stage: Test Coverage
+      php: 7.2
+      script:
+        - composer run-script coverage
+      after_script:
+        - wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.1.0/php-coveralls.phar
+        - php php-coveralls.phar --verbose --config tests/.coveralls.yml
+
+    - stage: Phpstan
+      php: 7.2
+      script:
+        - composer run-script phpstan-install
+        - composer run-script phpstan
+
+  allow_failures:
+    - stage: Test Coverage
+
+after_failure:
+  # Print *.actual content
+  - for i in $(find tests -name \*.actual); do echo "--- $i"; cat $i; echo; echo; done
+
+sudo: false
+
+cache:
+  directories:
+    - $HOME/.composer/cache