Refactor GetSql to FileGetContents

The GetSql class and interface have been renamed to FileGetContents to better describe the functionality they provide. Associated classes and tests have been updated for this change. A new exception, SqlFileNotReadableException, has been introduced to address issues when files cannot be read. Also, the contents manipulation from GetSqlWithFileName constructor and SqlFileName class have been shifted to the new FileGetContents class.

Author: koriym

src/CallableQueryModule.php

@@ -13,7 +13,6 @@
 use RegexIterator;
 use SplFileInfo;
 
-use function file_get_contents;
 use function pathinfo;
 use function trim;
 
@@ -29,7 +28,9 @@ public function __construct(string $sqlDir, ?AbstractModule $module = null, ?cal
     {
         $this->sqlDir = $sqlDir;
         $this->getSql = $getSql ?? static function (SplFileInfo $fileInfo): string {
-            return trim((string) file_get_contents($fileInfo->getPathname()));
+            $getContents = new FileGetContents();
+
+            return $getContents($fileInfo->getPathname());
         };
 
         parent::__construct($module);
@@ -40,7 +41,7 @@ public function __construct(string $sqlDir, ?AbstractModule $module = null, ?cal
      */
     protected function configure()
     {
-        $this->bind(GetSqlInterface::class)->to(GetSql::class)->in(Scope::SINGLETON);
+        $this->bind(FileGetContentsInterface::class)->to(FileGetContents::class)->in(Scope::SINGLETON);
         $this->bind(SqlDir::class)->toInstance(new SqlDir($this->sqlDir));
         /** @var SplFileInfo $fileInfo */
         foreach ($this->files($this->sqlDir) as $fileInfo) {

src/Exception/SqlFileNotReadableException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query\Exception;
+
+use RuntimeException;
+
+class SqlFileNotReadableException extends RuntimeException
+{
+}

src/FileGetContents.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+use Ray\Query\Exception\SqlFileNotReadableException;
+
+use function file_get_contents;
+
+final class FileGetContents implements FileGetContentsInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function __invoke(string $filePath): string
+    {
+        $content =  file_get_contents($filePath);
+        if ($content === false) {
+            // @codeCoverageIgnoreStart
+            throw new SqlFileNotReadableException($filePath);
+            // @codeCoverageIgnoreEnd
+        }
+
+        return $content;
+    }
+}

src/GetSqlInterface.php renamed to src/FileGetContentsInterface.php

@@ -4,7 +4,7 @@
 
 namespace Ray\Query;
 
-interface GetSqlInterface
+interface FileGetContentsInterface
 {
     public function __invoke(string $filePath): string;
 }

src/GetSqlWithFileName.php renamed to src/FileGetContentsWithFileName.php

@@ -6,19 +6,26 @@
 
 use SplFileInfo;
 
-use function file_get_contents;
 use function sprintf;
-use function trim;
 
-final class GetSqlWithFileName implements GetSqlInterface
+final class FileGetContentsWithFileName implements FileGetContentsInterface
 {
+    /** @var FileGetContents */
+    private $getContents;
+
+    public function __construct(FileGetContents $getContents)
+    {
+        $this->getContents = $getContents;
+    }
+
     /**
      * {@inheritDoc}
      */
     public function __invoke(string $filePath): string
     {
         $fileInfo = new SplFileInfo($filePath);
+        $content = ($this->getContents)($filePath);
 
-        return sprintf('/* %s */ %s', $fileInfo->getFilename(), trim((string) file_get_contents($filePath)));
+        return sprintf('/* %s */ %s', $fileInfo->getFilename(), $content);
     }
 }

src/GetSql.php

@@ -11,10 +11,9 @@
 use Ray\Aop\ReflectionMethod;
 use Ray\Query\Annotation\Query;
 use Ray\Query\Exception\SqlFileNotFoundException;
+use Ray\Query\Exception\SqlFileNotReadableException;
 
 use function assert;
-use function file_exists;
-use function file_get_contents;
 use function is_string;
 use function parse_str;
 use function parse_url;
@@ -28,12 +27,17 @@ class QueryInterceptor implements MethodInterceptor
     /** @var ExtendedPdoInterface */
     private $pdo;
 
+    /** @var FileGetContentsInterface */
+    private $fileGetContents;
+
     public function __construct(
         ExtendedPdoInterface $pdo,
-        SqlDir $sqlDir
+        SqlDir $sqlDir,
+        FileGetContentsInterface $fileGetContents
     ) {
         $this->sqlDir = $sqlDir;
         $this->pdo = $pdo;
+        $this->fileGetContents = $fileGetContents;
     }
 
     /** @return ResourceObject|mixed */
@@ -111,11 +115,12 @@ private function templated(Query $query, array $namedArguments): array
 
     private function getsql(string $queryId, ReflectionMethod $method): string
     {
-        $file = sprintf('%s/%s.sql', $this->sqlDir->value, $queryId);
-        if (! file_exists($file)) {
+        $filePath = sprintf('%s/%s.sql', $this->sqlDir->value, $queryId);
+
+        try {
+            return ($this->fileGetContents)($filePath);
+        } catch (SqlFileNotReadableException $e) {
             throw new SqlFileNotFoundException((string) $method, $queryId);
         }
-
-        return (string) file_get_contents($file);
     }
 }

src/QueryInterceptor.php

@@ -6,17 +6,16 @@
 
 use SplFileInfo;
 
-use function file_get_contents;
-use function sprintf;
-use function trim;
-
 final class SqlFileName
 {
     /**
      * Return sql file name commented SQL
      */
     public function __invoke(SplFileInfo $fileInfo): string
     {
-        return sprintf('/* %s */ %s', $fileInfo->getFilename(), trim((string) file_get_contents($fileInfo->getPathname())));
+        $getFileContents = new FileGetContentsWithFileName(new FileGetContents());
+        $filePath = $fileInfo->getPathname();
+
+        return $getFileContents($filePath);
     }
 }

src/SqlFileName.php

@@ -14,6 +14,6 @@ class SqlFileNameModule extends AbstractModule
      */
     protected function configure(): void
     {
-        $this->bind(GetSqlInterface::class)->to(GetSqlWithFileName::class)->in(Scope::SINGLETON);
+        $this->bind(FileGetContentsInterface::class)->to(FileGetContentsWithFileName::class)->in(Scope::SINGLETON);
     }
 }

src/SqlFileNameModule.php

@@ -21,14 +21,14 @@ final class SqlFinder implements SqlFinderInterface
     /** @var SqlDir */
     private $sqlDir;
 
-    /** @var GetSqlInterface */
+    /** @var FileGetContentsInterface */
     private $getSql;
 
     /** @param ParamReaderInterface<object> $reader */
     public function __construct(
         ParamReaderInterface $reader,
         SqlDir $sqlDir,
-        GetSqlInterface $getSql
+        FileGetContentsInterface $getSql
     ) {
         $this->reader = $reader;
         $this->sqlDir = $sqlDir;