Merge pull request #57 from magento-research/feature/json-parsing

Add JSON parsing to File resolver

Author: tjwiebell

src/Resolver/File.php

@@ -12,6 +12,16 @@
 
 class File extends AbstractResolver
 {
+    /**
+     * Possible values for encoding.
+     */
+    public const VALID_ENCODING_VALUES = ['utf-8', 'latin-1', 'binary'];
+
+    /**
+     * Possible values for parse.
+     */
+    public const VALID_PARSE_VALUES = ['auto', 'text', 'json', 'mustache', 'graphql'];
+
     /**
      * {@inheritdoc}
      */
@@ -40,15 +50,15 @@ public function isValid(Definition $definition): bool
         if ($definition->has('encoding')) {
             $encoding = $this->getIterator()->get('encoding', $definition);
 
-            if (!\in_array(strtolower($encoding), ['utf-8', 'latin-1', 'binary'])) {
+            if (!\in_array(strtolower($encoding), self::VALID_ENCODING_VALUES)) {
                 return false;
             }
         }
 
         if ($definition->has('parse')) {
             $parse = $this->getIterator()->get('parse', $definition);
 
-            if (!\in_array(strtolower($parse), ['auto', 'text'])) {
+            if (!\in_array(strtolower($parse), self::VALID_PARSE_VALUES)) {
                 return false;
             }
         }
@@ -81,6 +91,16 @@ public function resolve($definition)
             $path = realpath($this->getIterator()->getRootDefinition()->getBasepath() . \DIRECTORY_SEPARATOR . $path);
         }
 
-        return file_get_contents($path);
+        $content = file_get_contents($path);
+
+        if (($parse == 'auto' && pathinfo($path, PATHINFO_EXTENSION) == 'json') || $parse == 'json') {
+            $content = json_decode($content, true);
+
+            if (json_last_error() !== JSON_ERROR_NONE) {
+                throw new \RuntimeException('Failed to parse ' . basename($path) . ': ' . json_last_error_msg());
+            }
+        }
+
+        return $content;
     }
 }

test/Resolver/FileTest.php

@@ -42,6 +42,9 @@ protected function setUp(): void
             ->andReturnUsing(function (string $key, Definition $definition) {
                 return $definition->get($key);
             });
+
+        $this->mockIterator->shouldReceive('getRootDefinition->getBasePath')
+            ->andReturn(__DIR__);
     }
 
     public function testIndicator(): void
@@ -86,14 +89,32 @@ public function testIsValid(): void
         verify($this->resolver->isValid($invalidParse))->is()->false();
     }
 
+    public function testJsonException(): void
+    {
+        $this->expectException(\RuntimeException::class);
+        // Omit portion of the error message that comes from buitlin PHP value
+        $this->expectExceptionMessage('Failed to parse invalid.json: ');
+
+        $this->resolver->resolve('./_data/invalid.json');
+    }
+
     public function testResolve(): void
     {
         $definition = new Definition(['file' => './_data/sample.txt']);
 
-        $this->mockIterator->shouldReceive('getRootDefinition->getBasePath')
-            ->andReturn(__DIR__);
-
         verify($this->resolver->resolve('./_data/sample.txt'))->is()->sameAs("This is a sample file.\n");
         verify($this->resolver->resolve($definition))->is()->sameAs("This is a sample file.\n");
     }
+
+    public function testResolveJson(): void
+    {
+        verify($this->resolver->resolve('./_data/sample.json'))->is()->sameAs(['json' => true]);
+    }
+
+    public function testyResolveWithoutParse(): void
+    {
+        $definition = new Definition(['file' => './_data/sample.json', 'parse' => 'text']);
+
+        verify($this->resolver->resolve($definition))->is()->sameAs('{"json": true}' . PHP_EOL);
+    }
 }

test/Resolver/_data/invalid.json

@@ -0,0 +1 @@
+{ 'json': false

test/Resolver/_data/sample.json

@@ -0,0 +1 @@
+{"json": true}