Improving the file handling (#81)

* Rebuilding file handling
* Raise cyclomatic complexity level due to isXMLFileValid method and use better naming in constants

Author: hyperized

cyclomatic.xml

@@ -14,7 +14,7 @@
     <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
         <priority>1</priority>
         <properties>
-            <property name="reportLevel" value="4" />
+            <property name="reportLevel" value="7" />
         </properties>
     </rule>
 </ruleset>

src/Constants/ErrorMessages.php

@@ -10,6 +10,7 @@
 final class ErrorMessages
 {
     public const XML_EMPTY_TRIMMED = 'The provided XML content is, after trimming, in fact an empty string';
-    public const XML_NO_NAME = 'xmlParseEntityRef: no name';
-    public const NO_FILE_CONTENTS = 'Could not get file contents';
+    public const EMPTY_FILE = 'File is empty';
+    public const FILE_DOES_NOT_EXIST = 'File does not exist';
+    public const FILE_COULD_NOT_BE_OPENED = 'File could not be opened';
 }

src/Exceptions/EmptyFile.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Hyperized\Xml\Exceptions;
+
+use Exception;
+
+/**
+ * Class EmptyFile
+ *
+ * @package Hyperized\Xml\Exceptions
+ */
+class EmptyFile extends Exception
+{
+}

src/Exceptions/FileDoesNotExist.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Hyperized\Xml\Exceptions;
+
+use Exception;
+
+/**
+ * Class FileDoesNotExist
+ *
+ * @package Hyperized\Xml\Exceptions
+ */
+class FileDoesNotExist extends Exception
+{
+}

src/Types/File.php

@@ -0,0 +1,73 @@
+<?php declare(strict_types=1);
+
+namespace Hyperized\Xml\Types;
+
+use Hyperized\Xml\Constants\ErrorMessages;
+use Hyperized\Xml\Exceptions\EmptyFile;
+use Hyperized\Xml\Exceptions\FileCouldNotBeOpenedException;
+use Hyperized\Xml\Exceptions\FileDoesNotExist;
+
+/**
+ * Class File
+ *
+ * @package Hyperized\Xml\Types\Xml
+ */
+class File
+{
+    /**
+     * @var string
+     */
+    private $path;
+
+    /**
+     * File constructor.
+     *
+     * @param  string $path
+     * @throws FileDoesNotExist
+     */
+    public function __construct(string $path)
+    {
+        $this->path = $path;
+        $this->pathExists();
+    }
+
+    /**
+     * @return bool
+     * @throws FileDoesNotExist
+     */
+    private function pathExists(): bool
+    {
+        if (!file_exists($this->path)) {
+            throw new FileDoesNotExist(ErrorMessages::FILE_DOES_NOT_EXIST);
+        }
+        return true;
+    }
+
+    /**
+     * @return string
+     * @throws EmptyFile
+     * @throws FileCouldNotBeOpenedException
+     */
+    public function getContents(): string
+    {
+        $contents = file_get_contents($this->path);
+
+        if ($contents === false) {
+            throw new FileCouldNotBeOpenedException(ErrorMessages::FILE_COULD_NOT_BE_OPENED);
+        }
+
+        if ($contents === '') {
+            throw new EmptyFile(ErrorMessages::EMPTY_FILE);
+        }
+
+        return $contents;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPath(): string
+    {
+        return $this->path;
+    }
+}

src/Types/Files/Xml.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Hyperized\Xml\Types\Files;
+
+use Hyperized\Xml\Types\File;
+
+/**
+ * Class Xml
+ *
+ * @package Hyperized\Xml\Types\Files
+ */
+class Xml extends File
+{
+}

src/Types/Files/Xsd.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Hyperized\Xml\Types\Files;
+
+use Hyperized\Xml\Types\File;
+
+/**
+ * Class Xsd
+ *
+ * @package Hyperized\Xml\Types\Files
+ */
+class Xsd extends File
+{
+}

src/Validator.php

@@ -3,11 +3,14 @@
 namespace Hyperized\Xml;
 
 use DOMDocument;
-use Exception;
 use Hyperized\Xml\Constants\ErrorMessages;
 use Hyperized\Xml\Constants\Strings;
 use Hyperized\Xml\Exceptions\FileCouldNotBeOpenedException;
 use Hyperized\Xml\Exceptions\InvalidXml;
+use Hyperized\Xml\Exceptions\EmptyFile;
+use Hyperized\Xml\Exceptions\FileDoesNotExist;
+use Hyperized\Xml\Types\Files\Xml;
+use Hyperized\Xml\Types\Files\Xsd;
 use function is_string;
 use LibXMLError;
 
@@ -28,30 +31,46 @@ final class Validator implements ValidatorInterface
      */
     private $encoding = Strings::UTF_8;
 
-    /**
-     * @param  string      $xmlPath
-     * @param  string|null $xsdPath
-     * @return bool
-     * @throws FileCouldNotBeOpenedException
-     * @throws InvalidXml
-     */
     public function isXMLFileValid(string $xmlPath, string $xsdPath = null): bool
     {
-        return $this->isXMLStringValid(self::getFileContent($xmlPath), $xsdPath);
+        try {
+            $string = (new Xml($xmlPath))
+                ->getContents();
+        } catch (EmptyFile $e) {
+            return false;
+        } catch (FileCouldNotBeOpenedException $e) {
+            return false;
+        } catch (FileDoesNotExist $e) {
+            return false;
+        }
+
+        if ($xsdPath !== null) {
+            try {
+                $xsdPath = (new Xsd($xsdPath))
+                    ->getPath();
+            } catch (FileDoesNotExist $e) {
+                return false;
+            }
+        }
+
+        return $this->isXMLStringValid($string, $xsdPath);
     }
 
     /**
      * @param  string      $xml
      * @param  string|null $xsdPath
      * @return bool
-     * @throws InvalidXml
      */
     public function isXMLStringValid(string $xml, string $xsdPath = null): bool
     {
-        if (is_string($xsdPath)) {
-            return $this->isXMLValid($xml, $xsdPath);
+        try {
+            if (is_string($xsdPath)) {
+                return $this->isXMLValid($xml, $xsdPath);
+            }
+            return $this->isXMLValid($xml);
+        } catch (InvalidXml $e) {
+            return false;
         }
-        return $this->isXMLValid($xml);
     }
 
     /**
@@ -112,22 +131,6 @@ static function (
         }
     }
 
-    /**
-     * @param  string $fileName
-     * @return string
-     * @throws FileCouldNotBeOpenedException
-     */
-    private static function getFileContent(string $fileName): string
-    {
-        try {
-            $contents = file_get_contents($fileName);
-        } catch (Exception $exception) {
-            throw new FileCouldNotBeOpenedException(ErrorMessages::NO_FILE_CONTENTS);
-        }
-
-        return !$contents ? $contents : '';
-    }
-
     /**
      * @return string
      */

tests/InvalidStreamWrapper.php

@@ -0,0 +1,27 @@
+<?php declare(strict_types=1);
+
+namespace Hyperized\Xml\Tests;
+
+/**
+ * Class InvalidStreamWrapper
+ *
+ * @package Hyperized\Xml\Types
+ */
+class InvalidStreamWrapper
+{
+    /**
+     * @return bool
+     */
+    public function stream_open(): bool
+    {
+        return false;
+    }
+
+    /**
+     * @return array
+     */
+    public function url_stat(): array
+    {
+        return [];
+    }
+}