Merge pull request #4 from nicoSWD/php7

PHP7-master

Author: Nico Oelgart

.travis.yml

@@ -1,12 +1,8 @@
 language: php
 
 php:
-  - 5.4
-  - 5.5
-  - 5.6
-  - '7.0'
-  - hhvm
-  - nightly
+  - 7.0
+  - 7.1
 
 script: phpunit --coverage-clover=coverage.clover
 

README.md

@@ -1,4 +1,4 @@
-## Rules Parser and Evaluator for PHP 5.4+
+## Rules Parser and Evaluator for PHP 7
 
 |  | Build Status | Code Quality | Coverage | HHVM |
 |:----------------:|:----------------:|:----------:|:----------:|:----------:|
@@ -8,6 +8,8 @@
 
 [![Latest Stable Version](https://img.shields.io/packagist/v/nicoswd/php-rule-parser.svg)](https://packagist.org/packages/nicoswd/php-rule-parser)
 
+*Note:* This is a development branch. Use at own risk until tagged stable.
+
 You're looking at a PHP library to parse and evaluate text based rules with a Javascript-like syntax. This project was born out of the necessity to evaluate hundreds of rules that were originally written and evaluated in JavaScript, and now needed to be evaluated on the server-side, using PHP.
 
 This library has initially been used to change and configure the behavior of certain "Workflows" (without changing actual code) in an intranet application, but it may serve a purpose elsewhere.
@@ -69,6 +71,30 @@ $rule = new Rule($ruleStr, $variables);
 var_dump($rule->isTrue()); // bool(true)
 ```
 
+
+## Custom Functions
+
+```php
+$ruleStr = 'double(value) === result';
+
+$variables = [
+    'value'  => 2,
+    'result' => 4
+];
+
+$rule = new Rule($ruleStr, $variables);
+
+$rule->registerFunction('double', function (BaseToken $multiplier) : BaseToken {
+    if (!$multiplier instanceof TokenInteger) {
+        throw new \Exception;
+    }
+
+    return new TokenInteger($multiplier->getValue() * 2);
+});
+
+var_dump($rule->isTrue()); // bool(true)
+```
+
 ## Redefine Tokens
 Tokens can be customized, if desired. Note that it's very easy to break stuff by doing that, if you have colliding regular expressions.
 You may want to set a different `$priority` when registering a token: `::registerToken($type, $regex, $priority)`
@@ -148,8 +174,8 @@ $highlighter = new Rules\Highlighter(new Rules\Tokenizer());
 
 // Optional custom styles
 $highlighter->setStyle(
-   Rules\Constants::GROUP_VARIABLE,
-   'color: #007694; font-weight: 900;'
+    Rules\Constants::GROUP_VARIABLE,
+    'color: #007694; font-weight: 900;'
 );
 
 echo $highlighter->highlightString($ruleStr);
@@ -179,7 +205,7 @@ If you discover any security related issues, please email security@nic0.me inste
 ## Testing
 
 ```bash
-$ phpunit
+$ composer test
 ```
 
 ## Contributing

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "nicoswd/php-rule-parser",
   "type": "library",
-  "description": "PHP 5.4 Rule Parser and Evaluator",
+  "description": "PHP 7 Rule Parser and Evaluator",
   "keywords": ["rule", "parser", "tokenizer", "highlighter", "evaluator", "javascript", "workflow", "dsl"],
   "homepage": "https://github.com/nicoSWD/php-rule-parser",
   "license": "MIT",
@@ -12,12 +12,16 @@
       "homepage": "https://nicoswd.com"
     }
   ],
+  "psr-4": {
+    "nicoSWD\\Rules": "src/nicoSWD/Rules"
+  },
   "require": {
-    "php": ">=5.4"
+    "php": "^7.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^5.1"
   },
-  "autoload": {
-    "classmap": [
-      "src/"
-    ]
+  "scripts": {
+    "test": "phpunit"
   }
 }

src/nicoSWD/Rules/AST.php

@@ -3,21 +3,36 @@
 /**
  * @license     http://opensource.org/licenses/mit-license.php MIT
  * @link        https://github.com/nicoSWD
- * @since       0.3.4
  * @author      Nicolas Oelgart <nico@oelgart.com>
  */
+declare(strict_types=1);
+
 namespace nicoSWD\Rules;
 
 use Iterator;
-use nicoSWD\Rules\Tokens\BaseToken;
-use nicoSWD\Rules\Tokens\TokenFactory;
+use nicoSWD\Rules\Tokens\{
+    BaseToken,
+    TokenFactory,
+    TokenFunction,
+    TokenOpeningArray,
+    TokenRegex,
+    TokenString,
+    TokenVariable
+};
+use nicoSWD\Rules\AST\Nodes\{
+    NodeArray,
+    NodeFunction,
+    NodeString,
+    NodeVariable
+};
 
-/**
- * Class AST
- * @package nicoSWD\Rules
- */
 final class AST implements Iterator
 {
+    /**
+     * @var Parser
+     */
+    public $parser;
+
     /**
      * @var Stack
      */
@@ -29,53 +44,45 @@ final class AST implements Iterator
     protected $variables = [];
 
     /**
-     * @param Stack   $stack
-     * @param mixed[] $variables
+     * @param Stack  $stack
+     * @param Parser $parser
      */
-    public function __construct(Stack $stack, array $variables = [])
+    public function __construct(Stack $stack, Parser $parser)
     {
         $this->stack = $stack;
-        $this->variables = $variables;
+        $this->variables = $parser->variables;
+        $this->parser = $parser;
     }
 
-    /**
-     * @return void
-     */
     public function next()
     {
         $this->stack->next();
     }
 
-    /**
-     * @return bool
-     */
-    public function valid()
+    public function valid() : bool
     {
         return $this->stack->valid();
     }
 
-    /**
-     * @return Tokens\BaseToken
-     */
     public function current()
     {
         $current = $this->stack->current();
 
-        switch (\true) {
+        switch (true) {
             default:
                 return $current;
-            case $current instanceof Tokens\TokenString:
-            case $current instanceof Tokens\TokenRegex:
-                $current = new AST\Nodes\NodeString($this);
+            case $current instanceof TokenString:
+            case $current instanceof TokenRegex:
+                $current = new NodeString($this);
                 break;
-            case $current instanceof Tokens\TokenOpeningArray:
-                $current = new AST\Nodes\NodeArray($this);
+            case $current instanceof TokenOpeningArray:
+                $current = new NodeArray($this);
                 break;
-            case $current instanceof Tokens\TokenVariable:
-                $current = new AST\Nodes\NodeVariable($this);
+            case $current instanceof TokenVariable:
+                $current = new NodeVariable($this);
                 break;
-            case $current instanceof Tokens\TokenFunction:
-                $current = new AST\Nodes\NodeFunction($this);
+            case $current instanceof TokenFunction:
+                $current = new NodeFunction($this);
                 break;
         }
 
@@ -84,27 +91,21 @@ public function current()
 
     /**
      * @codeCoverageIgnore
-     * @return mixed
      */
-    public function key()
+    public function key() : int
     {
         return $this->stack->key();
     }
 
-    /**
-     * @return void
-     */
     public function rewind()
     {
         $this->stack->rewind();
     }
 
     /**
-     * @param string $name
-     * @return BaseToken
      * @throws Exceptions\ParserException
      */
-    public function getVariable($name)
+    public function getVariable(string $name) : BaseToken
     {
         if (!array_key_exists($name, $this->variables)) {
             $token = $this->stack->current();
@@ -120,10 +121,7 @@ public function getVariable($name)
         return TokenFactory::createFromPHPType($this->variables[$name]);
     }
 
-    /**
-     * @return Stack
-     */
-    public function getStack()
+    public function getStack() : Stack
     {
         return $this->stack;
     }