refactor: create dedicated YamlParser class

Author: carlalexander

src/Exception/YamlParseException.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Ymir command-line tool.
+ *
+ * (c) Carl Alexander <support@ymirapp.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ymir\Cli\Exception;
+
+class YamlParseException extends RuntimeException
+{
+}

src/Project/ProjectConfiguration.php

@@ -21,10 +21,12 @@
 use Ymir\Cli\Exception\ConfigurationException;
 use Ymir\Cli\Exception\InvalidArgumentException;
 use Ymir\Cli\Exception\Project\UnsupportedProjectException;
+use Ymir\Cli\Exception\YamlParseException;
 use Ymir\Cli\Project\Configuration\ConfigurationChangeInterface;
 use Ymir\Cli\Project\Type\ProjectTypeInterface;
 use Ymir\Cli\Resource\Model\Project;
 use Ymir\Cli\Support\Arr;
+use Ymir\Cli\YamlParser;
 
 class ProjectConfiguration implements Arrayable
 {
@@ -49,6 +51,13 @@ class ProjectConfiguration implements Arrayable
      */
     private $filesystem;
 
+    /**
+     * The YAML parser.
+     *
+     * @var YamlParser
+     */
+    private $parser;
+
     /**
      * All supported project types.
      *
@@ -59,9 +68,10 @@ class ProjectConfiguration implements Arrayable
     /**
      * Constructor.
      */
-    public function __construct(Filesystem $filesystem, iterable $projectTypes, string $configurationFilePath = '')
+    public function __construct(Filesystem $filesystem, YamlParser $parser, iterable $projectTypes, string $configurationFilePath = '')
     {
         $this->filesystem = $filesystem;
+        $this->parser = $parser;
 
         $this->loadConfiguration($configurationFilePath);
 
@@ -228,18 +238,10 @@ public function hasEnvironment(string $environment): bool
      */
     public function loadConfiguration(string $configurationFilePath): void
     {
-        $configuration = [];
-
-        if ($this->filesystem->exists($configurationFilePath)) {
-            try {
-                $configuration = Yaml::parse((string) file_get_contents($configurationFilePath));
-            } catch (\Throwable $exception) {
-                throw new ConfigurationException(sprintf('Error parsing Ymir project configuration file: %s', $exception->getMessage()));
-            }
-        }
-
-        if (!empty($configuration) && !is_array($configuration)) {
-            throw new ConfigurationException('Error parsing Ymir project configuration file');
+        try {
+            $configuration = $this->parser->parse($configurationFilePath) ?? [];
+        } catch (YamlParseException $exception) {
+            throw new ConfigurationException(sprintf('Error parsing Ymir project configuration file: %s', $exception->getMessage()));
         }
 
         $this->configuration = $configuration;

src/YamlParser.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Ymir command-line tool.
+ *
+ * (c) Carl Alexander <support@ymirapp.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ymir\Cli;
+
+use Symfony\Component\Yaml\Yaml;
+use Ymir\Cli\Exception\YamlParseException;
+
+class YamlParser
+{
+    /**
+     * Parse the given YAML file.
+     */
+    public function parse(string $filePath): ?array
+    {
+        if (!file_exists($filePath)) {
+            return null;
+        }
+
+        $contents = file_get_contents($filePath);
+
+        if (false === $contents) {
+            throw new YamlParseException(sprintf('Unable to read the YAML file at "%s"', $filePath));
+        }
+
+        try {
+            $configuration = Yaml::parse($contents);
+        } catch (\Throwable $exception) {
+            throw new YamlParseException(sprintf('Error parsing YAML file at "%s": %s', $filePath, $exception->getMessage()));
+        }
+
+        if (null === $configuration) {
+            return [];
+        } elseif (!is_array($configuration)) {
+            throw new YamlParseException(sprintf('Error parsing YAML file at "%s"', $filePath));
+        }
+
+        return $configuration;
+    }
+}

tests/Unit/YamlParserTest.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Ymir command-line tool.
+ *
+ * (c) Carl Alexander <support@ymirapp.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ymir\Cli\Tests\Unit;
+
+use Ymir\Cli\Exception\YamlParseException;
+use Ymir\Cli\Tests\TestCase;
+use Ymir\Cli\YamlParser;
+
+class YamlParserTest extends TestCase
+{
+    /**
+     * @var string
+     */
+    private $tempFile;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->tempFile = tempnam(sys_get_temp_dir(), 'ymir-yaml-parser-test');
+    }
+
+    protected function tearDown(): void
+    {
+        if (file_exists($this->tempFile)) {
+            unlink($this->tempFile);
+        }
+
+        parent::tearDown();
+    }
+
+    public function testParseReturnsArray(): void
+    {
+        file_put_contents($this->tempFile, "foo: bar\nbaz: 123");
+
+        $this->assertSame(['foo' => 'bar', 'baz' => 123], (new YamlParser())->parse($this->tempFile));
+    }
+
+    public function testParseReturnsEmptyArrayWhenFileIsEmpty(): void
+    {
+        file_put_contents($this->tempFile, '');
+
+        $this->assertSame([], (new YamlParser())->parse($this->tempFile));
+    }
+
+    public function testParseReturnsNullWhenFileDoesNotExist(): void
+    {
+        unlink($this->tempFile);
+
+        $this->assertNull((new YamlParser())->parse($this->tempFile));
+    }
+
+    public function testParseThrowsExceptionWhenParsedYamlIsNotArray(): void
+    {
+        file_put_contents($this->tempFile, 'foo');
+
+        $this->expectException(YamlParseException::class);
+        $this->expectExceptionMessage('Error parsing YAML file at');
+
+        (new YamlParser())->parse($this->tempFile);
+    }
+
+    public function testParseThrowsExceptionWhenYamlIsInvalid(): void
+    {
+        file_put_contents($this->tempFile, 'invalid yaml: [');
+
+        $this->expectException(YamlParseException::class);
+        $this->expectExceptionMessage('Error parsing YAML file at');
+
+        (new YamlParser())->parse($this->tempFile);
+    }
+}