first commit

Author: dmitryrechkin

.gitignore

@@ -0,0 +1,8 @@
+vendor/
+composer.lock
+phpunit.xml
+.DS_Store
+*/.DS_Store
+*/*/.DS_Store
+*/*/*/.DS_Store
+.phplint-cache

LICENSE

@@ -0,0 +1,39 @@
+{
+    "name": "dmitryrechkin/php-graphql-schema-fileparser",
+    "type": "php-graphql-schema-fileparser",
+    "description": "PHP GraphQL Schema file parser with caching",
+    "keywords": [
+    ],
+    "license": "AGPL-3.0-only",
+    "authors": [
+        {
+            "name": "Dmitry Rechkin",
+            "email": "[email protected]",
+            "homepage": "https://github.com/dmitryrechkin/"
+        }
+    ],
+    "minimum-stability": "dev",
+    "require": {
+        "php": "^7.3 || ^8.0",
+        "webonyx/graphql-php": "^14.11"
+    },
+    "require-dev": {
+        "dmitryrechkin/php-standard": "^1.0",
+        "dmitryrechkin/php-phpunit-bootstrap": "^1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "DmitryRechkin\\" : "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "DmitryRechkin\\Tests\\" : "tests/"
+        }
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
+}

composer.json

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DmitryRechkin\GraphQL\Schema\FileParser;
+
+class CacheFilePathBuilder
+{
+	/**
+	 * @var string
+	 */
+	private $targetDirectoryPath;
+
+	/**
+	 * @var string
+	 */
+	private $sourceFilePath;
+
+	/**
+	 * constructor
+	 */
+	public function __construct()
+	{
+		$this->targetDirectoryPath = sys_get_temp_dir();
+		$this->sourceFilePath = '';
+	}
+
+	/**
+	 * sets target directory where cache file should be located
+	 *
+	 * @param string $targetDirectoryPath
+	 * @return self
+	 */
+	public function withTargetDirectoryPath(string $targetDirectoryPath): self
+	{
+		$this->targetDirectoryPath = rtrim($targetDirectoryPath, PATH_SEPARATOR);
+		return $this;
+	}
+
+	/**
+	 * sets source file path
+	 *
+	 * @param string $sourceFilePath
+	 * @return self
+	 */
+	public function withSourceFilePath(string $sourceFilePath): self
+	{
+		$this->sourceFilePath = rtrim($sourceFilePath, PATH_SEPARATOR);
+		return $this;
+	}
+
+	/**
+	 * returns path to a cache file
+	 *
+	 * @return string
+	 */
+	public function build(): string
+	{
+		return $this->targetDirectoryPath . '/' . md5($this->sourceFilePath);
+	}
+}

src/GraphQL/Schema/FileParser/CacheFilePathBuilder.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DmitryRechkin\GraphQL\Schema\FileParser;
+
+use GraphQL\Language\AST\DocumentNode;
+use GraphQL\Utils\AST;
+
+class DocumentNodeStorage
+{
+	/**
+	 * loads a document node from a give file
+	 *
+	 * @param string $filePath
+	 * @return DocumentNode
+	 */
+	public function load(string $filePath): ?DocumentNode
+	{
+		if (false === file_exists($filePath)) {
+			return null;
+		}
+
+		return AST::fromArray(require $filePath);
+	}
+
+	/**
+	 * saves to a given file a given document node
+	 *
+	 * @param string $filePath
+	 * @param DocumentNode $documentNode
+	 * @return boolean
+	 */
+	public function save(string $filePath, DocumentNode $documentNode): bool
+	{
+		$contents = "<?php\nreturn " . var_export(AST::toArray($documentNode), true) . ";\n";
+
+		return false !== file_put_contents($filePath, $contents);
+	}
+}

src/GraphQL/Schema/FileParser/DocumentNodeStorage.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DmitryRechkin\GraphQL\Schema\FileParser;
+
+class FileModificationTimeComparator
+{
+	/**
+	 * @var string
+	 */
+	private $filePath;
+
+	/**
+	 * constructor
+	 */
+	public function __construct()
+	{
+		$this->filePath = '';
+	}
+
+	/**
+	 * sets file we will be comparing against
+	 *
+	 * @param string $filePath
+	 * @return self
+	 */
+	public function forFile(string $filePath): self
+	{
+		$this->filePath = $filePath;
+		return $this;
+	}
+
+	/**
+	 * returns true when our file is newer than a given file
+	 *
+	 * @param string $compareToFilePath
+	 * @return boolean
+	 */
+	public function isNewerThanFile(string $compareToFilePath): bool
+	{
+		if (false === file_exists($this->filePath)) {
+			return false;
+		}
+
+		if (false === file_exists($compareToFilePath)) {
+			return true;
+		}
+
+		return filemtime($this->filePath) > filemtime($compareToFilePath);
+	}
+}

src/GraphQL/Schema/FileParser/FileModificationTimeComparator.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DmitryRechkin\GraphQL\Schema\FileParser;
+
+use GraphQL\Language\AST\DocumentNode;
+use GraphQL\Language\Parser as LanguageParser;
+
+class FileParser
+{
+	/**
+	 * @var CacheFilePathBuilder
+	 */
+	private $cacheFilePathBuilder;
+
+	/**
+	 * @var FileModificationTimeComparator
+	 */
+	private $fileModificationTimeComparator;
+
+	/**
+	 * @var DocumentNodeStorage
+	 */
+	private $documentNodeStorage;
+
+	/**
+	 * constructor
+	 *
+	 * @param CacheFilePathBuilder $cacheFilePathBuilder
+	 * @param FileModificationTimeComparator $fileModificationTimeComparator
+	 * @param DocumentNodeStorage $documentNodeStorage
+	 */
+	public function __construct(
+		CacheFilePathBuilder $cacheFilePathBuilder = null,
+		FileModificationTimeComparator $fileModificationTimeComparator = null,
+		DocumentNodeStorage $documentNodeStorage = null
+	) {
+		$this->cacheFilePathBuilder = $cacheFilePathBuilder ?? new CacheFilePathBuilder();
+		$this->fileModificationTimeComparator = $fileModificationTimeComparator ?? new FileModificationTimeComparator();
+		$this->documentNodeStorage = $documentNodeStorage ?? new DocumentNodeStorage();
+	}
+
+	/**
+	 * parses a given GraphQL schema file returns and DocumentNode,
+	 * or loads and returns previously parsed and then cached DocumentNode
+	 *
+	 * @param string $filePath
+	 * @return DocumentNode
+	 */
+	public function parse(string $filePath): ?DocumentNode
+	{
+		if (false === file_exists($filePath)) {
+			return null;
+		}
+
+		$documentNode = null;
+		$cacheFilePath = $this->cacheFilePathBuilder->withSourceFilePath($filePath)->build();
+
+		if ($this->fileModificationTimeComparator->forFile($cacheFilePath)->isNewerThanFile($filePath)) {
+			$documentNode = $this->documentNodeStorage->load($cacheFilePath);
+		} else {
+			$documentNode = LanguageParser::parse(file_get_contents($filePath));
+
+			$this->documentNodeStorage->save($cacheFilePath, $documentNode);
+		}
+
+		return $documentNode;
+	}
+}

src/GraphQL/Schema/FileParser/FileParser.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DmitryRechkin\Tests\Unit\GraphQL\Schema\FileParser;
+
+use DmitryRechkin\GraphQL\Schema\FileParser\CacheFilePathBuilder;
+use PHPUnit\Framework\TestCase;
+
+class CacheFilePathBuilderTest extends TestCase
+{
+	/**
+	 * @return void
+	 */
+	public function testWithTargetDirectoryReturnsSelf(): void
+	{
+		$cacheFilePathBuilder = new CacheFilePathBuilder();
+		$this->assertSame($cacheFilePathBuilder, $cacheFilePathBuilder->withTargetDirectoryPath(__DIR__));
+	}
+
+	/**
+	 * @return void
+	 */
+	public function testWithSourceFilePathReturnsSelf(): void
+	{
+		$cacheFilePathBuilder = new CacheFilePathBuilder();
+		$this->assertSame($cacheFilePathBuilder, $cacheFilePathBuilder->withSourceFilePath('somefile.php'));
+	}
+
+	/**
+	 * @return void
+	 */
+	public function testBuildReturnsExpectedPath(): void
+	{
+		$targetDirectoryPath = __DIR__;
+		$sourceFilePath = __DIR__ . '/test.php';
+		$expectedPath = $targetDirectoryPath . '/' . md5($sourceFilePath);
+
+		$cacheFilePathBuilder = new CacheFilePathBuilder();
+		$cacheFilePathBuilder->withTargetDirectoryPath($targetDirectoryPath);
+		$cacheFilePathBuilder->withSourceFilePath($sourceFilePath);
+
+		$this->assertSame($expectedPath, $cacheFilePathBuilder->build());
+	}
+}

tests/Unit/GraphQL/Schema/FileParser/CacheFilePathBuilderTest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DmitryRechkin\Tests\Unit\GraphQL\Schema\FileParser;
+
+use DmitryRechkin\GraphQL\Schema\FileParser\DocumentNodeStorage;
+use GraphQL\Language\AST\DocumentNode;
+use PHPUnit\Framework\TestCase;
+
+class DocumentNodeStorageTest extends TestCase
+{
+	/**
+	 * @return void
+	 */
+	public function testSaveFollowedByLoadReturnsDocumentNode(): void
+	{
+		$filePath = sys_get_temp_dir() . '/document-node-storage-test.php';
+
+		$documentNodeStorage = new DocumentNodeStorage();
+		$this->assertTrue($documentNodeStorage->save($filePath, new DocumentNode([])));
+		$this->assertInstanceOf(DocumentNode::class, $documentNodeStorage->load($filePath));
+
+		unlink($filePath);
+	}
+}