#3 Refactoring to 2.2.x-dev

janbarasek · web-flow · commit fd15b48ec4bf · 2020-06-06T12:10:41.000+02:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -20,12 +20,11 @@ jobs:
 
       - name: Install composer dependencies
         run: |
+          # Install code check tools
           composer run cs:install
-
           # Install app dependencies
           composer install --no-interaction --prefer-dist
 
-      # Check code checker and coding standards
       - name: Check coding standards
         run: |
           composer run cs:check
@@ -37,7 +36,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['7.2', '7.3', '7.4'] # 8.0
+        php: ['7.2', '7.3', '7.4', '8.0']
 
     name: PHP ${{ matrix.php }} tests
     steps:
@@ -52,6 +51,9 @@ jobs:
 
       - name: Install composer dependencies
         run: |
+          # Remove unnecesery packages
+          composer remove phpstan/phpstan phpstan/phpstan-nette --dev --no-interaction
+          # Install app dependencies
           composer install --no-interaction --prefer-dist
 
       - name: Run tests
@@ -65,3 +67,29 @@ jobs:
           flags: unittests
           name: codecov-umbrella
           fail_ci_if_error: true
+
+  benchmark:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: ['7.4']
+
+    name: Benchmark on PHP ${{ matrix.php }}
+    steps:
+      - name: Git clone
+        uses: actions/checkout@master
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@master
+        with:
+          php-version: ${{ matrix.php }}
+
+      - name: Install composer dependencies
+        run: |
+          # Install benchmarking tool
+          composer global require phpbench/phpbench @dev
+          # Install app dependencies
+          composer install --no-interaction --prefer-dist
+
+      - name: Run benchmarks
+        run: phpbench run
diff --git a/README.md b/README.md
@@ -1,10 +1,27 @@
-Robust PHP math integral solver
-===============================
+<h1 align="center">
+    PHP Math Integral Solver
+</h1>
+
+<p align="center">
+    <a href="https://mathematicator.com" target="_blank">
+        <img src="https://avatars3.githubusercontent.com/u/44620375?s=100&v=4">
+    </a>
+</p>
 
 [![Integrity check](https://github.com/mathematicator-core/integral-solver/workflows/Integrity%20check/badge.svg)](https://github.com/mathematicator-core/integral-solver/actions?query=workflow%3A%22Integrity+check%22)
 [![codecov](https://codecov.io/gh/mathematicator-core/integral-solver/branch/master/graph/badge.svg)](https://codecov.io/gh/mathematicator-core/integral-solver)
+[![Latest Stable Version](https://poser.pugx.org/mathematicator-core/integral-solver/v/stable)](https://packagist.org/packages/mathematicator-core/integral-solver)
+[![Latest Unstable Version](https://poser.pugx.org/mathematicator-core/integral-solver/v/unstable)](https://packagist.org/packages/mathematicator-core/integral-solver)
 [![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](./LICENSE)
+[![PHPStan Enabled](https://img.shields.io/badge/PHPStan-enabled%20L8-brightgreen.svg?style=flat)](https://phpstan.org/)
+
+## Installation
+
+```
+composer require mathematicator-core/calculator
+```
 
+## Usage
 Get instance of `IntegralSolver` and compute:
 
 ```php
@@ -127,8 +144,29 @@ one to the most abstract one:
     </tr>
 </table>
 
-Contribution
-----
+**Third-party packages:**
+
+⚠️ Not guaranteed!
+
+<table>
+    <tr>
+        <td>
+            <b>
+            <a href="https://github.com/cothema/math-php-api">
+                REST API
+            </a>
+            </b>
+        </td>
+        <td>
+            Install the whole pack as a REST API service
+            on your server (Docker ready) or
+            access it via public cloud REST API.
+        </td>
+    </tr>
+</table>
+
+
+## Contribution
 
 ### Tests
 
diff --git a/benchmarks/.gitkeep b/benchmarks/.gitkeep
diff --git a/composer.json b/composer.json
@@ -18,9 +18,9 @@
 	],
 	"require": {
 		"php": ">=7.2",
-		"mathematicator-core/tokenizer": "^2.0@dev",
-		"mathematicator-core/engine": "^2.0@dev",
-		"mathematicator-core/numbers": "^2.0@dev"
+		"mathematicator-core/tokenizer": "^2.2@dev",
+		"mathematicator-core/engine": "^2.2@dev",
+		"mathematicator-core/numbers": "^2.2@dev"
 	},
 	"require-dev": {
 		"brainmaestro/composer-git-hooks": "dev-master",
@@ -47,12 +47,12 @@
 			"composer create-project nette/coding-standard temp/coding-standard ^2 --no-progress"
 		],
 		"cs:check": [
-			"php temp/code-checker/code-checker --short-arrays --strict-types --no-progress",
-			"php temp/coding-standard/ecs check src --config temp/coding-standard/coding-standard-php71.yml"
+			"php temp/code-checker/code-checker -d src -d tests -d benchmarks --short-arrays --strict-types --no-progress",
+			"php temp/coding-standard/ecs check src tests benchmarks --config temp/coding-standard/coding-standard-php71.yml"
 		],
 		"cs:fix": [
-			"php temp/code-checker/code-checker --short-arrays --strict-types --fix --no-progress",
-			"php temp/coding-standard/ecs check src --config temp/coding-standard/coding-standard-php71.yml --fix"
+			"php temp/code-checker/code-checker -d src -d tests -d benchmarks --short-arrays --strict-types --fix --no-progress",
+			"php temp/coding-standard/ecs check src tests benchmarks --config temp/coding-standard/coding-standard-php71.yml --fix"
 		],
 		"phpstan": "vendor/bin/phpstan analyse src -c phpstan.neon --level 8 --no-progress",
 		"fix": [
@@ -70,7 +70,7 @@
 	},
 	"extra": {
 		"branch-alias": {
-			"dev-master": "2.0.x-dev"
+			"dev-master": "2.2.x-dev"
 		},
 		"hooks": {
 			"post-merge": "composer install",
diff --git a/phpbench.json b/phpbench.json
@@ -0,0 +1,4 @@
+{
+	"bootstrap": "vendor/autoload.php",
+	"path": "benchmarks"
+}
diff --git a/src/Exception/CanNotSolveException.php b/src/Exception/CanNotSolveException.php
@@ -5,7 +5,7 @@
 namespace Mathematicator\Integral\Exception;
 
 
-use Mathematicator\Engine\MathematicatorException;
+use Mathematicator\Engine\Exception\MathematicatorException;
 use Mathematicator\Tokenizer\Token\IToken;
 use Mathematicator\Tokenizer\Token\SubToken;
 
diff --git a/src/IntegralResult.php b/src/IntegralResult.php
@@ -5,7 +5,7 @@
 namespace Mathematicator\Integral;
 
 
-use Mathematicator\Engine\Step;
+use Mathematicator\Engine\Step\Step;
 use Mathematicator\Tokenizer\Token\IToken;
 
 final class IntegralResult
diff --git a/src/IntegralSolver.php b/src/IntegralSolver.php
@@ -5,11 +5,11 @@
 namespace Mathematicator\Integral;
 
 
-use Mathematicator\Engine\MathematicatorException;
+use Mathematicator\Engine\Exception\MathematicatorException;
 use Mathematicator\Engine\QueryNormalizer;
-use Mathematicator\Engine\Step;
+use Mathematicator\Engine\Step\Step;
 use Mathematicator\Integral\Exception\CanNotSolveException;
-use Mathematicator\Integral\Rule\Rule;
+use Mathematicator\Integral\Rule\IRule;
 use Mathematicator\Integral\Solver\Solver;
 use Mathematicator\Tokenizer\Token\IToken;
 use Mathematicator\Tokenizer\Token\OperatorToken;
@@ -28,7 +28,7 @@
 class IntegralSolver
 {
 
-	/** @var Rule[] */
+	/** @var IRule[] */
 	public $rules = [];
 
 	/** @var Tokenizer */
@@ -135,10 +135,10 @@ public function processByTokens(array $tokens, ?string $differential = null): In
 
 
 	/**
-	 * @param Rule $rule
+	 * @param IRule $rule
 	 * @return IntegralSolver
 	 */
-	public function addRule(Rule $rule): self
+	public function addRule(IRule $rule): self
 	{
 		$this->rules[] = $rule;
 
diff --git a/src/Rule/IRule.php b/src/Rule/IRule.php
@@ -5,6 +5,6 @@
 namespace Mathematicator\Integral\Rule;
 
 
-interface Rule
+interface IRule
 {
 }
diff --git a/src/Solver/Solver.php b/src/Solver/Solver.php
@@ -5,7 +5,7 @@
 namespace Mathematicator\Integral\Solver;
 
 
-use Mathematicator\Engine\MathematicatorException;
+use Mathematicator\Engine\Exception\MathematicatorException;
 use Mathematicator\Integral\Exception\CanNotSolveException;
 use Mathematicator\Tokenizer\Token\IToken;
 use Mathematicator\Tokenizer\Token\NumberToken;
@@ -40,14 +40,14 @@ private function solvePrimitiveIntegral(IToken $token): string
 	{
 		if ($token instanceof NumberToken) {
 			if ($token->getToken() !== '0') {
-				return ($num = $token->getNumber()->getHumanString()) === '1' ? 'x' : $num . 'x';
+				return ($num = (string) $token->getNumber()) === '1' ? 'x' : $num . 'x';
 			}
 
 			return '';
 		}
 
 		if ($token instanceof VariableToken) {
-			if (($times = $token->getTimes()->getHumanString()) === '1') {
+			if (($times = (string) $token->getTimes()) === '1') {
 				return '(x^2)/2';
 			}
 
diff --git a/tests/Bootstrap.php b/tests/Bootstrap.php
@@ -5,15 +5,14 @@
 namespace Mathematicator\Integral\Tests;
 
 
-require __DIR__ . '/../vendor/autoload.php';
-
-
-use Mathematicator\Engine\Translation\TranslatorHelper;
 use Nette\Configurator;
 use Nette\DI\Container;
 use Tester\Environment;
 
-Environment::setup();
+if (\is_file($autoload = __DIR__ . '/../vendor/autoload.php')) {
+	require_once $autoload;
+	Environment::setup();
+}
 
 class Bootstrap
 {
@@ -29,8 +28,9 @@ public static function boot(): Container
 			->register();
 
 		$configurator
-			->addConfig(__DIR__ . '/../common.neon')
-			->addConfig(__DIR__ . '/test.common.neon');
+			->addConfig(__DIR__ . '/../vendor/mathematicator-core/tokenizer/common.neon')
+			->addConfig(__DIR__ . '/../vendor/mathematicator-core/engine/common.neon')
+			->addConfig(__DIR__ . '/../common.neon');
 
 		return $configurator->createContainer();
 	}
diff --git a/tests/IntegralTests/IntegralSolverTest.php b/tests/IntegralTests/IntegralSolverTest.php
@@ -10,7 +10,7 @@
 use Tester\Assert;
 use Tester\TestCase;
 
-require __DIR__ . '/../bootstrap.php';
+require __DIR__ . '/../Bootstrap.php';
 
 class IntegralSolverTest extends TestCase
 {
diff --git a/tests/test.common.neon b/tests/test.common.neon

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +	"bootstrap": "vendor/autoload.php",
 +	"path": "benchmarks"
 +}
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,6 @@`
`5`	`5`	`namespace Mathematicator\Integral\Rule;`
`6`	`6`
`7`	`7`
`8`		`-interface Rule`
	`8`	`+interface IRule`
`9`	`9`	`{`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace Mathematicator\Integral\Solver;`
`6`	`6`
`7`	`7`
`8`		`-use Mathematicator\Engine\MathematicatorException;`
	`8`	`+use Mathematicator\Engine\Exception\MathematicatorException;`
`9`	`9`	`use Mathematicator\Integral\Exception\CanNotSolveException;`
`10`	`10`	`use Mathematicator\Tokenizer\Token\IToken;`
`11`	`11`	`use Mathematicator\Tokenizer\Token\NumberToken;`
`@@ -40,14 +40,14 @@ private function solvePrimitiveIntegral(IToken $token): string`
`40`	`40`	`{`
`41`	`41`	`if ($token instanceof NumberToken) {`
`42`	`42`	`if ($token->getToken() !== '0') {`
`43`		`- return ($num = $token->getNumber()->getHumanString()) === '1' ? 'x' : $num . 'x';`
	`43`	`+ return ($num = (string) $token->getNumber()) === '1' ? 'x' : $num . 'x';`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`return '';`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`if ($token instanceof VariableToken) {`
`50`		`- if (($times = $token->getTimes()->getHumanString()) === '1') {`
	`50`	`+ if (($times = (string) $token->getTimes()) === '1') {`
`51`	`51`	`return '(x^2)/2';`
`52`	`52`	`}`
`53`	`53`