feature: added 'not in' basic rule (#19)

* feature: added 'not in' basic rule

* cleanup comments

* style: small code styling

Author: altesack

src/Expression/ExpressionFactory.php

@@ -21,7 +21,8 @@ class ExpressionFactory implements ExpressionFactoryInterface
         Token\TokenSmaller::class        => LessThanExpression::class,
         Token\TokenSmallerEqual::class   => LessThanEqualExpression::class,
         Token\TokenGreaterEqual::class   => GreaterThanEqualExpression::class,
-        Token\TokenIn::class             => InExpression::class
+        Token\TokenIn::class             => InExpression::class,
+        Token\TokenNotIn::class          => NotInExpression::class,
     ];
 
     public function createFromOperator(Token\BaseToken $operator): BaseExpression

src/Expression/NotInExpression.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types=1);
+
+/**
+ * @license     http://opensource.org/licenses/mit-license.php MIT
+ * @link        https://github.com/nicoSWD
+ * @author      Nicolas Oelgart <[email protected]>
+ */
+namespace nicoSWD\Rule\Expression;
+
+use nicoSWD\Rule\TokenStream\TokenCollection;
+use nicoSWD\Rule\Parser\Exception\ParserException;
+
+final class NotInExpression extends BaseExpression
+{
+    public function evaluate($leftValue, $rightValue): bool
+    {
+        if ($rightValue instanceof TokenCollection) {
+            $rightValue = $rightValue->toArray();
+        }
+
+        if (!is_array($rightValue)) {
+            throw new ParserException(sprintf(
+                'Expected array, got "%s"',
+                gettype($rightValue)
+            ));
+        }
+
+        return !in_array($leftValue, $rightValue, true);
+    }
+}

src/Grammar/JavaScript/JavaScript.php

@@ -22,6 +22,7 @@ public function getDefinition(): array
             [Token::EQUAL_STRICT, '===', 125],
             [Token::EQUAL, '==', 120],
             [Token::IN, '\bin\b', 115],
+            [Token::NOT_IN, '\bnot in\b', 116],
             [Token::BOOL, '\b(?:true|false)\b', 110],
             [Token::NULL, '\bnull\b', 105],
             [Token::METHOD, '\.\s*[a-zA-Z_]\w*\s*\(', 100],

src/TokenStream/Token/Token.php

@@ -15,6 +15,7 @@ class Token
     const NOT_EQUAL = 'NotEqual';
     const EQUAL_STRICT = 'EqualStrict';
     const EQUAL = 'Equal';
+    const NOT_IN = 'NotIn';
     const IN = 'In';
     const BOOL = 'Bool';
     const NULL = 'Null';

src/TokenStream/Token/TokenFactory.php

@@ -20,6 +20,7 @@ class TokenFactory
         Token::NOT_EQUAL           => TokenNotEqual::class,
         Token::EQUAL_STRICT        => TokenEqualStrict::class,
         Token::EQUAL               => TokenEqual::class,
+        Token::NOT_IN              => TokenNotIn::class,
         Token::IN                  => TokenIn::class,
         Token::BOOL                => TokenBool::class,
         Token::NULL                => TokenNull::class,

src/TokenStream/Token/TokenNotIn.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+/**
+ * @license     http://opensource.org/licenses/mit-license.php MIT
+ * @link        https://github.com/nicoSWD
+ * @author      Nicolas Oelgart <[email protected]>
+ */
+namespace nicoSWD\Rule\TokenStream\Token;
+
+final class TokenNotIn extends BaseToken
+{
+    public function getType(): int
+    {
+        return TokenType::OPERATOR;
+    }
+}

tests/integration/RuleTest.php

@@ -61,4 +61,43 @@ public function isValidReturnsTrueOnValidSyntax(): void
         $this->assertEmpty($rule->getError());
         $this->assertTrue($rule->isTrue());
     }
+    /** @test */
+    public function basicInRule(): void
+    {
+        $ruleStr = '4 in [4, 6, 7]';
+
+        $rule = new Rule\Rule($ruleStr);
+
+        $this->assertTrue($rule->isValid());
+        $this->assertEmpty($rule->getError());
+        $this->assertTrue($rule->isTrue());
+
+        $ruleStr = '5 in [4, 6, 7]';
+
+        $rule = new Rule\Rule($ruleStr);
+
+        $this->assertTrue($rule->isValid());
+        $this->assertEmpty($rule->getError());
+        $this->assertFalse($rule->isTrue());
+    }
+
+    /** @test */
+    public function basicNotInRule(): void
+    {
+        $ruleStr = '5 not in [4, 6, 7]';
+
+        $rule = new Rule\Rule($ruleStr);
+
+        $this->assertTrue($rule->isValid());
+        $this->assertEmpty($rule->getError());
+        $this->assertTrue($rule->isTrue());
+
+        $ruleStr = '4 not in [4, 6, 7]';
+
+        $rule = new Rule\Rule($ruleStr);
+
+        $this->assertTrue($rule->isValid());
+        $this->assertEmpty($rule->getError());
+        $this->assertFalse($rule->isTrue());
+    }
 }

tests/unit/Expression/ExpressionFactoryTest.php

@@ -48,6 +48,7 @@ public function expressionProvider(): array
             [Expression\LessThanEqualExpression::class, new Token\TokenSmallerEqual('<=')],
             [Expression\GreaterThanEqualExpression::class, new Token\TokenGreaterEqual('>=')],
             [Expression\InExpression::class, new Token\TokenIn('in')],
+            [Expression\NotInExpression::class, new Token\TokenNotIn('not in')],
         ];
     }
 }