refactor: merge yosymfony/resource-watcher

Include yosymfony/resource-watcher directly in PHPUnit watcher so that it is easier to manage dependencies.

yosymfony/resource-watcher#12

Author: Pierre Clavequin

composer.json

@@ -22,18 +22,17 @@
         "symfony/console": "^5 | ^6 | ^7",
         "symfony/finder": "^5.4 | ^6 | ^7",
         "symfony/process": "^5.4 | ^6 | ^7",
-        "symfony/yaml": "^5.2 | ^6 | ^7",
-        "yosymfony/resource-watcher": "^2.0 | ^3.0"
+        "symfony/yaml": "^5.2 | ^6 | ^7"
     },
     "conflict": {
-        "yosymfony/resource-watcher": "<2.0",
         "symfony/console": "<5.2"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.6 | ^9.0 | ^11.0"
     },
     "autoload": {
         "psr-4": {
+            "Yosymfony\\": "src/ResourceWatcher",
             "Spatie\\PhpUnitWatcher\\": "src"
         }
     },

src/ResourceWatcher/.DS_Store

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Yo! Symfony Resource Watcher.
+ *
+ * (c) YoSymfony <http://github.com/yosymfony>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Yosymfony\ResourceWatcher;
+
+/**
+ * CRC32 content hash implementation.
+ *
+ * @author Victor Puertas <vpgugr@gmail.com>
+ */
+class Crc32ContentHash implements HashInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function hash($filepath)
+    {
+        $fileContent = $filepath;
+
+        if (!\is_dir($filepath)) {
+            $fileContent = file_get_contents($filepath);
+        }
+
+        return hash('crc32', $fileContent);
+    }
+}

src/ResourceWatcher/Crc32ContentHash.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Yo! Symfony Resource Watcher.
+ *
+ * (c) YoSymfony <http://github.com/yosymfony>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Yosymfony\ResourceWatcher;
+
+/**
+ * CRC32 content hash implementation.
+ *
+ * @author Victor Puertas <vpgugr@gmail.com>
+ */
+class Crc32MetaDataHash implements HashInterface
+{
+    /** @var bool */
+    protected $clearStatCache;
+
+    /**
+     * Assign option to clear the file stat() cache.
+     * @param bool $clearStatCache
+     */
+    public function __construct($clearStatCache = false)
+    {
+        $this->clearStatCache = $clearStatCache;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hash($filepath)
+    {
+        if ($this->clearStatCache) {
+            clearstatcache(true, $filepath);
+        }
+
+        $data = stat($filepath);
+
+        $str = basename($filepath) . $data['size'] . $data['mtime'] . $data['mode'];
+
+        return hash('crc32', $str);
+    }
+}

src/ResourceWatcher/Crc32MetaDataHash.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Yo! Symfony Resource Watcher.
+ *
+ * (c) YoSymfony <http://github.com/yosymfony>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Yosymfony\ResourceWatcher;
+
+/**
+ * Interface for hashing a file.
+ *
+ * @author Victor Puertas <vpgugr@gmail.com>
+ */
+interface HashInterface
+{
+    /**
+     * Calculates the hash of a file.
+     *
+     * @param string $filepath
+     *
+     * @return string Returns a string containing the calculated message digest.
+     */
+    public function hash($filepath);
+}

src/ResourceWatcher/HashInterface.php

@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * This file is part of the Yo! Symfony Resource Watcher.
+ *
+ * (c) YoSymfony <http://github.com/yosymfony>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Yosymfony\ResourceWatcher;
+
+/**
+ * Interface of a resource cache.
+ *
+ * @author Victor Puertas <vpgugr@gmail.com>
+ */
+interface ResourceCacheInterface
+{
+    /**
+     * If the cache Initialized? if not then warm-up cache.
+     *
+     * @return bool
+     */
+    public function isInitialized();
+
+    /**
+     * Returns the hash of a file in cache.
+     *
+     * @param string $filename
+     *
+     * @return string The hash for the filename. Empty string if not exists.
+     */
+    public function read($filename);
+
+    /**
+     * Updates the hash of a file in cache.
+     *
+     * @param string $filename
+     * @param string $hash The calculated hash for the filename.
+     */
+    public function write($filename, $hash);
+
+    /**
+     * Deletes a file in cache.
+     *
+     * @param string $filename
+     *
+     * @return void
+     */
+    public function delete($filename);
+
+    /**
+     * Erases all the elements in cache.
+     *
+     * @return void
+     */
+    public function erase();
+
+    /**
+     * Returns all the element in cache.
+     *
+     * @return array A key-value array in which the key is the filename and the value is the hash.
+     */
+    public function getAll();
+
+    /**
+     * Persists the cache
+     *
+     * @return void
+     */
+    public function save();
+}

src/ResourceWatcher/ResourceCacheInterface.php

@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of the Yo! Symfony Resource Watcher.
+ *
+ * (c) YoSymfony <http://github.com/yosymfony>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Yosymfony\ResourceWatcher;
+
+/**
+ * Resource cache implementation using memory.
+ *
+ * @author Victor Puertas <vpgugr@gmail.com>
+ */
+class ResourceCacheMemory implements ResourceCacheInterface
+{
+    protected $isInitialized = false;
+    private $data = [];
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isInitialized()
+    {
+        return $this->isInitialized;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($filename)
+    {
+        return isset($this->data[$filename]) ? $this->data[$filename] : '';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function write($filename, $hash)
+    {
+        $this->data[$filename] = $hash;
+        $this->isInitialized = true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function delete($filename)
+    {
+        unset($this->data[$filename]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function erase()
+    {
+        $this->data = [];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAll()
+    {
+        return $this->data;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function save()
+    {
+        $this->isInitialized = true;
+    }
+}