Add "any" extractor and make it default for []

Vast majority cases of [] usage means that so let's make it shorter

Author: pinepain

src/Extractors/Definition/RecursiveExtractorDefinition.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the pinepain/js-sandbox PHP library.
+ *
+ * Copyright (c) 2016-2017 Bogdan Padalko <[email protected]>
+ *
+ * Licensed under the MIT license: http://opensource.org/licenses/MIT
+ *
+ * For the full copyright and license information, please view the
+ * LICENSE file that was distributed with this source or visit
+ * http://opensource.org/licenses/MIT
+ */
+
+
+namespace Pinepain\JsSandbox\Extractors\Definition;
+
+
+class RecursiveExtractorDefinition extends AbstractExtractorDefinition implements PlainExtractorDefinitionInterface
+{
+    public function __construct(string $name)
+    {
+        parent::__construct($name, $this, [$this]);
+    }
+}

src/Extractors/ExtractorDefinitionBuilder.php

@@ -19,6 +19,7 @@
 use Pinepain\JsSandbox\Extractors\Definition\ExtractorDefinitionInterface;
 use Pinepain\JsSandbox\Extractors\Definition\PlainExtractorDefinition;
 use Pinepain\JsSandbox\Extractors\Definition\PlainExtractorDefinitionInterface;
+use Pinepain\JsSandbox\Extractors\Definition\RecursiveExtractorDefinition;
 use Pinepain\JsSandbox\Extractors\Definition\VariableExtractorDefinition;
 
 
@@ -93,7 +94,7 @@ public function build(string $definition): ExtractorDefinitionInterface
      * @param int $depth
      * @param bool $groups
      *
-     * @return ExtractorDefinitionInterface
+     * @return null|ExtractorDefinitionInterface
      * @throws ExtractorDefinitionBuilderException
      */
     protected function buildExtractor(string $name, string $param, string $alt_definitions, int $depth, bool $groups): ExtractorDefinitionInterface
@@ -105,7 +106,7 @@ protected function buildExtractor(string $name, string $param, string $alt_defin
         }
 
         if ($name) {
-            $definition = new PlainExtractorDefinition($name, $next);
+            $definition = $this->buildPlainExtractor($name, $next);
         } else {
             $definition = $next;
         }
@@ -162,14 +163,19 @@ protected function buildVariableDefinition(PlainExtractorDefinitionInterface $de
      */
     protected function buildArrayDefinition(?ExtractorDefinitionInterface $definition, int $depth, bool $groups): ExtractorDefinitionInterface
     {
-        if (!$definition && $groups) {
-            throw new ExtractorDefinitionBuilderException('Empty group is not allowed');
+        // special case for blank brackets [] which should be the same as any[]
+        if (!$definition) {
+            if ($groups) {
+                throw new ExtractorDefinitionBuilderException('Empty group is not allowed');
+            }
+
+            $definition = $this->buildPlainExtractor('any');
         }
 
         while ($depth) {
             $depth--;
             // arrayed definition
-            $definition = new PlainExtractorDefinition('[]', $definition);
+            $definition = $this->buildPlainExtractor('[]', $definition);
         }
 
         return $definition;
@@ -193,4 +199,13 @@ private function hasGroups(array $matches): bool
     {
         return isset($matches['group']) && '' !== $matches['group'];
     }
+
+    private function buildPlainExtractor(string $name, ?ExtractorDefinitionInterface $next = null): PlainExtractorDefinitionInterface
+    {
+        if ('any' === $name && !$next) {
+            return new RecursiveExtractorDefinition($name);
+        }
+
+        return new PlainExtractorDefinition($name, $next);
+    }
 }

src/Extractors/PlainExtractors/AnyExtractor.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the pinepain/js-sandbox PHP library.
+ *
+ * Copyright (c) 2016-2017 Bogdan Padalko <[email protected]>
+ *
+ * Licensed under the MIT license: http://opensource.org/licenses/MIT
+ *
+ * For the full copyright and license information, please view the
+ * LICENSE file that was distributed with this source or visit
+ * http://opensource.org/licenses/MIT
+ */
+
+
+namespace Pinepain\JsSandbox\Extractors\PlainExtractors;
+
+
+use Pinepain\JsSandbox\Extractors\Definition\PlainExtractorDefinitionInterface;
+use Pinepain\JsSandbox\Extractors\ExtractorException;
+use Pinepain\JsSandbox\Extractors\ExtractorInterface;
+use V8\Context;
+use V8\Value;
+
+
+class AnyExtractor implements PlainExtractorInterface
+{
+    /**
+     * @var PlainExtractorInterface[]
+     */
+    private $extractors;
+
+    public function __construct(PlainExtractorInterface ...$extractors)
+    {
+        $this->extractors = $extractors;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function extract(Context $context, Value $value, PlainExtractorDefinitionInterface $definition, ExtractorInterface $extractor)
+    {
+        foreach ($this->extractors as $plain_extractor) {
+            try {
+                return $plain_extractor->extract($context, $value, $definition, $extractor);
+            } catch (ExtractorException $e) {
+                //
+            }
+        }
+
+        throw new ExtractorException('Unable to pick proper extractor for ' . $value->typeOf()->value() . 'type');
+    }
+}

src/Laravel/JsSandboxServiceProvider.php

@@ -34,6 +34,7 @@
 use Pinepain\JsSandbox\Extractors\ExtractorsCollectionInterface;
 use Pinepain\JsSandbox\Extractors\ObjectComponents\ExtractorsObjectStore;
 use Pinepain\JsSandbox\Extractors\ObjectComponents\ExtractorsObjectStoreInterface;
+use Pinepain\JsSandbox\Extractors\PlainExtractors\AnyExtractor;
 use Pinepain\JsSandbox\Extractors\PlainExtractors\ArrayExtractor;
 use Pinepain\JsSandbox\Extractors\PlainExtractors\AssocExtractor;
 use Pinepain\JsSandbox\Extractors\PlainExtractors\BoolExtractor;
@@ -256,7 +257,7 @@ protected function registerExtractor()
 
             // TODO: register basic extractor
 
-            $collection->put('[]', $array = new AssocExtractor());
+            $collection->put('[]', $assoc = new AssocExtractor());
             $collection->put('array', $array = new ArrayExtractor(new AssocExtractor(false)));
 
             $collection->put('raw', $raw = new RawExtractor());
@@ -279,6 +280,7 @@ protected function registerExtractor()
             $collection->put('jsonable', $json = new JsonableExtractor());
 
             $collection->put('scalar', $scalar = new ScalarExtractor($string, $number, $bool, $null, $undefined));
+            $collection->put('any', $any = new AnyExtractor($scalar, $regexp, $datetime, $assoc));
 
             return $collection;
         });

tests/Extractors/ExtractorDefinitionBuilderTest.php

@@ -57,11 +57,20 @@ public function testBuildingFromEmptyGroupShouldThrowException()
      * @expectedException \Pinepain\JsSandbox\Extractors\ExtractorDefinitionBuilderException
      * @expectedExceptionMessage Unable to parse definition: '()[]'
      */
-    public function testBuildingEmptyGroupArrayedDefinition()
+    public function testBuildingEmptyGroupArrayedDefinitionShouldFail()
     {
         $this->builder->build('()[]');
     }
 
+    /**
+     * @expectedException \Pinepain\JsSandbox\Extractors\ExtractorDefinitionBuilderException
+     * @expectedExceptionMessage Unable to parse definition: '((()))[]'
+     */
+    public function testBuildingEmptyGroupArrayedDefinitionWithNestedGroups()
+    {
+        $this->builder->build('((()))[]');
+    }
+
     public function testBuildingPlainDefinition()
     {
         $definition = $this->builder->build('test');
@@ -81,7 +90,8 @@ public function testBuildingEmptyArrayDefinition()
         $this->assertInstanceOf(PlainExtractorDefinitionInterface::class, $definition);
 
         $this->assertSame('[]', $definition->getName());
-        $this->assertNull($definition->getNext());
+        $this->assertInstanceOf(PlainExtractorDefinitionInterface::class, $definition->getNext());
+        $this->assertSame('any', $definition->getNext()->getName());
         $this->assertCount(1, $definition->getVariations());
         $this->assertSame($definition, $definition->getVariations()[0]);
     }
@@ -100,7 +110,8 @@ public function testBuildingEmptyArrayWithNestedEmptyArrayDefinition()
         $next = $definition->getNext();
 
         $this->assertSame('[]', $next->getName());
-        $this->assertNull($next->getNext());
+        $this->assertInstanceOf(PlainExtractorDefinitionInterface::class, $next->getNext());
+        $this->assertSame('any', $next->getNext()->getName());
         $this->assertCount(1, $next->getVariations());
         $this->assertSame($next, $next->getVariations()[0]);
     }