From 18b12aeeff34c8ac9a350165ae36f08f4138dc9c Mon Sep 17 00:00:00 2001 From: Bruce Wells Date: Thu, 10 Jan 2019 20:18:10 -0500 Subject: sync (#5) * Documentation fixes (#34) Fixing typos in and clarifying documentation. * MathExecutor allow override default operators, functions and vars (#36) * Added simple coc (#37) * Added simple coc * Fix * Replaceable operators (#38) * Updated from NeonXP/MathExecutor * Fixed function in () block issue * Fixing typos in and clarifying documentation. * Syncing from origin (#3) * Documentation fixes (#34) Fixing typos in and clarifying documentation. * MathExecutor allow override default operators, functions and vars (#36) * Allow for operators to be replaced based on regex expression * Fix md typo (#39) * Updated from NeonXP/MathExecutor * Fixed function in () block issue * Fixing typos in and clarifying documentation. * Syncing from origin (#3) * Documentation fixes (#34) Fixing typos in and clarifying documentation. * MathExecutor allow override default operators, functions and vars (#36) * Syncing to origin (#4) * Documentation fixes (#34) Fixing typos in and clarifying documentation. * MathExecutor allow override default operators, functions and vars (#36) * Added simple coc (#37) * Added simple coc * Fix * Replaceable operators (#38) * Updated from NeonXP/MathExecutor * Fixed function in () block issue * Fixing typos in and clarifying documentation. * Syncing from origin (#3) * Documentation fixes (#34) Fixing typos in and clarifying documentation. * MathExecutor allow override default operators, functions and vars (#36) * Allow for operators to be replaced based on regex expression * \\ instead of \ * Update README.md Some small fixes * Fix single quotes parsing (#41) * Fix single quotes parsing Fix e-mails Some small fixes * Mistake in test * More PHP versions * Update README.md Deleted `dev` branch --- tests/MathTest.php | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'tests/MathTest.php') diff --git a/tests/MathTest.php b/tests/MathTest.php index 9acdb63..55e0799 100644 --- a/tests/MathTest.php +++ b/tests/MathTest.php @@ -32,7 +32,7 @@ class MathTest extends \PHPUnit_Framework_TestCase /** @var float $phpResult */ eval('$phpResult = ' . $expression . ';'); - $this->assertEquals($calculator->execute($expression), $phpResult); + $this->assertEquals($calculator->execute($expression), $phpResult, "Expression was: ${expression}"); } /** @@ -138,9 +138,23 @@ class MathTest extends \PHPUnit_Framework_TestCase { $calculator = new MathExecutor(); - $calculator->addFunction('round', function ($arg) { return round($arg); }, 1); + $calculator->addFunction('round', function ($arg) { + return round($arg); + }, 1); /** @var float $phpResult */ eval('$phpResult = round(100/30);'); $this->assertEquals($calculator->execute('round(100/30)'), $phpResult); } + + public function testQuotes() + { + $calculator = new MathExecutor(); + $testString = "some, long. arg; with: different-separators!"; + $calculator->addFunction('test', function ($arg) use ($testString) { + $this->assertEquals($arg, $testString); + return 0; + }, 1); + $calculator->execute('test("' . $testString . '")'); // single quotes + $calculator->execute("test('" . $testString . "')"); // double quotes + } } \ No newline at end of file -- cgit v1.2.3 From 44e2bb192eb1c847741894ef24c8fbe24fe2f15a Mon Sep 17 00:00:00 2001 From: Bruce Wells Date: Fri, 11 Jan 2019 23:48:43 -0500 Subject: Fixed function parameter order Corrected $places default value for addFunction to match TokenFactory Added function order test and put expected order first in assertEquals If else blocks in calculator Updated docs --- README.md | 9 ++++----- src/NXP/Classes/Calculator.php | 12 ++++-------- src/NXP/Classes/Token/TokenFunction.php | 4 ++-- src/NXP/MathExecutor.php | 2 +- tests/MathTest.php | 23 +++++++++++++++-------- 5 files changed, 26 insertions(+), 24 deletions(-) (limited to 'tests/MathTest.php') diff --git a/README.md b/README.md index b86f9c6..81d9475 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MathExecutor [![Stories in Ready](https://badge.waffle.io/NeonXP/MathExecutor.png?label=ready&title=Ready)](https://waffle.io/NeonXP/MathExecutor) [![Build Status](https://travis-ci.org/NeonXP/MathExecutor.png?branch=master)](https://travis-ci.org/NeonXP/MathExecutor) -A simple math expressions calculator +# A simple and extensible math expressions calculator ## Features: * Built in support for +, -, *, / and power (^) operators plus () @@ -11,7 +11,7 @@ A simple math expressions calculator * Exceptions on divide by zero, or treat as zero * Unary Minus (e.g. -3) * Pi ($pi) and Euler's number ($e) support to 11 decimal places -* Easily extendable +* Easily extensible ## Install via Composer: ``` @@ -41,10 +41,9 @@ Default functions: Add custom function to executor: ```php -$executor->addFunction('abs', function($arg) { - return abs($arg); -}, 1); +$executor->addFunction('abs', function($arg) {return abs($arg);}); ``` +Function default parameters are not supported at this time. ## Operators: Default operators: `+ - * / ^` diff --git a/src/NXP/Classes/Calculator.php b/src/NXP/Classes/Calculator.php index 1ceac84..62dbc17 100644 --- a/src/NXP/Classes/Calculator.php +++ b/src/NXP/Classes/Calculator.php @@ -38,22 +38,18 @@ class Calculator foreach ($tokens as $token) { if ($token instanceof TokenNumber) { array_push($stack, $token); - } - if ($token instanceof TokenStringDoubleQuoted) { + } else if ($token instanceof TokenStringDoubleQuoted) { array_push($stack, $token); - } - if ($token instanceof TokenStringSingleQuoted) { + } else if ($token instanceof TokenStringSingleQuoted) { array_push($stack, $token); - } - if ($token instanceof TokenVariable) { + } else if ($token instanceof TokenVariable) { $variable = $token->getValue(); if (!array_key_exists($variable, $variables)) { throw new UnknownVariableException($variable); } $value = $variables[$variable]; array_push($stack, new TokenNumber($value)); - } - if ($token instanceof InterfaceOperator || $token instanceof TokenFunction) { + } else if ($token instanceof InterfaceOperator || $token instanceof TokenFunction) { array_push($stack, $token->execute($stack)); } } diff --git a/src/NXP/Classes/Token/TokenFunction.php b/src/NXP/Classes/Token/TokenFunction.php index b2866c3..04eae30 100644 --- a/src/NXP/Classes/Token/TokenFunction.php +++ b/src/NXP/Classes/Token/TokenFunction.php @@ -32,9 +32,9 @@ class TokenFunction extends AbstractContainerToken implements InterfaceFunction $args = []; list($places, $function) = $this->value; for ($i = 0; $i < $places; $i++) { - array_push($args, array_pop($stack)->getValue()); + $args[] = array_pop($stack)->getValue(); } - $result = call_user_func_array($function, $args); + $result = call_user_func_array($function, array_reverse($args)); return new TokenNumber($result); } diff --git a/src/NXP/MathExecutor.php b/src/NXP/MathExecutor.php index 29c6a64..6325d35 100644 --- a/src/NXP/MathExecutor.php +++ b/src/NXP/MathExecutor.php @@ -174,7 +174,7 @@ class MathExecutor * @return MathExecutor * @throws \ReflectionException */ - public function addFunction($name, $function = null, $places = 1) + public function addFunction($name, $function = null, $places = null) { $this->tokenFactory->addFunction($name, $function, $places); diff --git a/tests/MathTest.php b/tests/MathTest.php index 55e0799..20f4d23 100644 --- a/tests/MathTest.php +++ b/tests/MathTest.php @@ -32,7 +32,7 @@ class MathTest extends \PHPUnit_Framework_TestCase /** @var float $phpResult */ eval('$phpResult = ' . $expression . ';'); - $this->assertEquals($calculator->execute($expression), $phpResult, "Expression was: ${expression}"); + $this->assertEquals($phpResult, $calculator->execute($expression), "Expression was: ${expression}"); } /** @@ -117,7 +117,7 @@ class MathTest extends \PHPUnit_Framework_TestCase public function testZeroDivision() { $calculator = new MathExecutor(); - $this->assertEquals($calculator->execute('10 / 0'), 0); + $this->assertEquals(0, $calculator->execute('10 / 0')); } public function testZeroDivisionException() @@ -131,19 +131,26 @@ class MathTest extends \PHPUnit_Framework_TestCase public function testExponentiation() { $calculator = new MathExecutor(); - $this->assertEquals($calculator->execute('10 ^ 2'), 100); + $this->assertEquals(100, $calculator->execute('10 ^ 2')); } + public function testFunctionParameterOrder() + { + $calculator = new MathExecutor(); + + $calculator->addFunction('concat', function ($arg1, $arg2) {return $arg1.$arg2;}); + $this->assertEquals('testing', $calculator->execute('concat("test","ing")')); + $this->assertEquals('testing', $calculator->execute("concat('test','ing')")); + } + public function testFunction() { $calculator = new MathExecutor(); - $calculator->addFunction('round', function ($arg) { - return round($arg); - }, 1); + $calculator->addFunction('round', function ($arg) {return round($arg);}); /** @var float $phpResult */ eval('$phpResult = round(100/30);'); - $this->assertEquals($calculator->execute('round(100/30)'), $phpResult); + $this->assertEquals($phpResult, $calculator->execute('round(100/30)')); } public function testQuotes() @@ -151,7 +158,7 @@ class MathTest extends \PHPUnit_Framework_TestCase $calculator = new MathExecutor(); $testString = "some, long. arg; with: different-separators!"; $calculator->addFunction('test', function ($arg) use ($testString) { - $this->assertEquals($arg, $testString); + $this->assertEquals($testString, $arg); return 0; }, 1); $calculator->execute('test("' . $testString . '")'); // single quotes -- cgit v1.2.3 From 265cff175eb1c0be4b59d937286059532361820f Mon Sep 17 00:00:00 2001 From: Bruce Wells Date: Tue, 15 Jan 2019 18:36:10 -0500 Subject: Fixed function parameter order Corrected $places default value for addFunction to match TokenFactory Added function order test and put expected order first in assertEquals If else blocks in calculator Updated docs --- tests/MathTest.php | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) (limited to 'tests/MathTest.php') diff --git a/tests/MathTest.php b/tests/MathTest.php index 8eb7827..81f0230 100644 --- a/tests/MathTest.php +++ b/tests/MathTest.php @@ -138,7 +138,11 @@ class MathTest extends \PHPUnit_Framework_TestCase { $calculator = new MathExecutor(); - $calculator->addFunction('concat', function ($arg1, $arg2) {return $arg1.$arg2;}); + $calculator->addFunction('concat', function ($arg1, $arg2) + { + return $arg1.$arg2; + } + ); $this->assertEquals('testing', $calculator->execute('concat("test","ing")')); $this->assertEquals('testing', $calculator->execute("concat('test','ing')")); } @@ -147,19 +151,19 @@ class MathTest extends \PHPUnit_Framework_TestCase { $calculator = new MathExecutor(); $calculator->addFunction('round', function ($arg) {return round($arg);}); - /** @var float $phpResult */ - eval('$phpResult = round(100/30);'); - $this->assertEquals($phpResult, $calculator->execute('round(100/30)')); + $this->assertEquals(round(100/30), $calculator->execute('round(100/30)')); } public function testQuotes() { $calculator = new MathExecutor(); $testString = "some, long. arg; with: different-separators!"; - $calculator->addFunction('test', function ($arg) use ($testString) { - $this->assertEquals($testString, $arg); - return 0;} - ); + $calculator->addFunction('test', function ($arg) use ($testString) + { + $this->assertEquals($testString, $arg); + return 0; + } + ); $calculator->execute('test("' . $testString . '")'); // single quotes $calculator->execute("test('" . $testString . "')"); // double quotes } -- cgit v1.2.3 From 47df3edbb6c437a049deee356db84f58edcba681 Mon Sep 17 00:00:00 2001 From: Bruce Wells Date: Tue, 15 Jan 2019 20:04:16 -0500 Subject: Fixed comma operator Added unit tests for expressions in function arguments. Changed array_push to $var[] = native code. --- src/NXP/Classes/Calculator.php | 12 +++------ src/NXP/Classes/Lexer.php | 9 ++++--- src/NXP/Classes/Token/TokenComma.php | 30 ++++++++++++++++++++- src/NXP/Classes/Token/TokenFunction.php | 5 ++-- tests/MathTest.php | 48 ++++++++++++++++++++++----------- 5 files changed, 74 insertions(+), 30 deletions(-) (limited to 'tests/MathTest.php') diff --git a/src/NXP/Classes/Calculator.php b/src/NXP/Classes/Calculator.php index 62dbc17..980a52b 100644 --- a/src/NXP/Classes/Calculator.php +++ b/src/NXP/Classes/Calculator.php @@ -36,21 +36,17 @@ class Calculator { $stack = []; foreach ($tokens as $token) { - if ($token instanceof TokenNumber) { - array_push($stack, $token); - } else if ($token instanceof TokenStringDoubleQuoted) { - array_push($stack, $token); - } else if ($token instanceof TokenStringSingleQuoted) { - array_push($stack, $token); + if ($token instanceof TokenNumber || $token instanceof TokenStringDoubleQuoted || $token instanceof TokenStringSingleQuoted) { + $stack[] = $token; } else if ($token instanceof TokenVariable) { $variable = $token->getValue(); if (!array_key_exists($variable, $variables)) { throw new UnknownVariableException($variable); } $value = $variables[$variable]; - array_push($stack, new TokenNumber($value)); + $stack[] = new TokenNumber($value); } else if ($token instanceof InterfaceOperator || $token instanceof TokenFunction) { - array_push($stack, $token->execute($stack)); + $stack[] = $token->execute($stack); } } $result = array_pop($stack); diff --git a/src/NXP/Classes/Lexer.php b/src/NXP/Classes/Lexer.php index a511c9b..898d8c1 100644 --- a/src/NXP/Classes/Lexer.php +++ b/src/NXP/Classes/Lexer.php @@ -77,7 +77,7 @@ class Lexer } elseif ($token instanceof TokenVariable) { $output[] = $token; } elseif ($token instanceof TokenFunction) { - array_push($stack, $token); + $stack[] = $token; } elseif ($token instanceof AbstractOperator) { // While we have something on the stack while (($count = count($stack)) > 0 @@ -104,9 +104,12 @@ class Lexer $output[] = array_pop($stack); } - array_push($stack, $token); + // Comma operators do nothing really, don't put them on the stack + if (! ($token instanceof TokenComma)) { + $stack[] = $token; + } } elseif ($token instanceof TokenLeftBracket) { - array_push($stack, $token); + $stack[] = $token; } elseif ($token instanceof TokenRightBracket) { while (($current = array_pop($stack)) && (!($current instanceof TokenLeftBracket))) { $output[] = $current; diff --git a/src/NXP/Classes/Token/TokenComma.php b/src/NXP/Classes/Token/TokenComma.php index 6a45595..9d997e1 100644 --- a/src/NXP/Classes/Token/TokenComma.php +++ b/src/NXP/Classes/Token/TokenComma.php @@ -13,7 +13,7 @@ namespace NXP\Classes\Token; /** * @author Alexander Kiryukhin */ -class TokenComma implements InterfaceToken +class TokenComma extends AbstractOperator { /** * @return string @@ -22,4 +22,32 @@ class TokenComma implements InterfaceToken { return '\,'; } + + /** + * Comma operator is lowest priority + * + * @return int + */ + public function getPriority() + { + return 0; + } + + /** + * @return string + */ + public function getAssociation() + { + return self::RIGHT_RIGHT; + } + + /** + * @param array $stack + * @return TokenNumber + */ + public function execute(&$stack) + { + // Comma operators don't do anything, stack has already executed + } + } diff --git a/src/NXP/Classes/Token/TokenFunction.php b/src/NXP/Classes/Token/TokenFunction.php index 04eae30..432f107 100644 --- a/src/NXP/Classes/Token/TokenFunction.php +++ b/src/NXP/Classes/Token/TokenFunction.php @@ -32,9 +32,10 @@ class TokenFunction extends AbstractContainerToken implements InterfaceFunction $args = []; list($places, $function) = $this->value; for ($i = 0; $i < $places; $i++) { - $args[] = array_pop($stack)->getValue(); + array_unshift($args, array_pop($stack)->getValue()); } - $result = call_user_func_array($function, array_reverse($args)); + + $result = call_user_func_array($function, $args); return new TokenNumber($result); } diff --git a/tests/MathTest.php b/tests/MathTest.php index 81f0230..5bb2ec0 100644 --- a/tests/MathTest.php +++ b/tests/MathTest.php @@ -135,17 +135,17 @@ class MathTest extends \PHPUnit_Framework_TestCase } public function testFunctionParameterOrder() - { - $calculator = new MathExecutor(); - - $calculator->addFunction('concat', function ($arg1, $arg2) - { - return $arg1.$arg2; - } - ); - $this->assertEquals('testing', $calculator->execute('concat("test","ing")')); - $this->assertEquals('testing', $calculator->execute("concat('test','ing')")); - } + { + $calculator = new MathExecutor(); + + $calculator->addFunction('concat', function ($arg1, $arg2) + { + return $arg1.$arg2; + } + ); + $this->assertEquals('testing', $calculator->execute('concat("test","ing")')); + $this->assertEquals('testing', $calculator->execute("concat('test','ing')")); + } public function testFunction() { @@ -154,17 +154,33 @@ class MathTest extends \PHPUnit_Framework_TestCase $this->assertEquals(round(100/30), $calculator->execute('round(100/30)')); } + public function testEvaluateFunctionParameters() + { + $calculator = new MathExecutor(); + $calculator->addFunction('round', function ($value, $decimals) + { + return round($value, $decimals); + } + ); + $expression = 'round(100 * 1.111111, 2)'; + eval('$phpResult = ' . $expression . ';'); + $this->assertEquals($phpResult, $calculator->execute($expression)); + $expression = 'round((100*0.04)+(((100*1.02)+0.5)*1.28),2)'; + eval('$phpResult = ' . $expression . ';'); + $this->assertEquals($phpResult, $calculator->execute($expression)); + } + public function testQuotes() { $calculator = new MathExecutor(); $testString = "some, long. arg; with: different-separators!"; $calculator->addFunction('test', function ($arg) use ($testString) - { - $this->assertEquals($testString, $arg); + { + $this->assertEquals($testString, $arg); return 0; - } - ); + } + ); $calculator->execute('test("' . $testString . '")'); // single quotes $calculator->execute("test('" . $testString . "')"); // double quotes } -} \ No newline at end of file +} -- cgit v1.2.3 From 2e847d6b8144ceabe95a5b369d5c2bc720770fc8 Mon Sep 17 00:00:00 2001 From: Bruce Wells Date: Tue, 15 Jan 2019 20:12:24 -0500 Subject: Fixed merge error --- tests/MathTest.php | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) (limited to 'tests/MathTest.php') diff --git a/tests/MathTest.php b/tests/MathTest.php index 09168c2..3cf4dbd 100644 --- a/tests/MathTest.php +++ b/tests/MathTest.php @@ -138,24 +138,11 @@ class MathTest extends \PHPUnit_Framework_TestCase { $calculator = new MathExecutor(); - $calculator->addFunction('concat', function ($arg1, $arg2) - { - return $arg1.$arg2; - } - ); + $calculator->addFunction('concat', function ($arg1, $arg2) {return $arg1.$arg2;}); $this->assertEquals('testing', $calculator->execute('concat("test","ing")')); $this->assertEquals('testing', $calculator->execute("concat('test','ing')")); } - public function testFunctionParameterOrder() - { - $calculator = new MathExecutor(); - - $calculator->addFunction('concat', function ($arg1, $arg2) {return $arg1.$arg2;}); - $this->assertEquals('testing', $calculator->execute('concat("test","ing")')); - $this->assertEquals('testing', $calculator->execute("concat('test','ing')")); - } - public function testFunction() { $calculator = new MathExecutor(); -- cgit v1.2.3