Added DataSource abstraction.

Removed failed abstractions: ConnectorOptions and EncapsulatedOptions.
Removed redundant abstraction: CacheKeyGenerator.

Author: Bilge

src/Cache/CacheKeyGenerator.php

@@ -6,16 +6,16 @@
 use Amp\Promise;
 
 /**
- * Provides a method for fetching data from a remote source asynchronously.
+ * Provides a method for fetching data from a source asynchronously.
  */
 interface AsyncConnector
 {
     /**
      * Fetches data from the specified source.
      *
-     * @param string $source Source.
+     * @param DataSource $source Source.
      *
-     * @return Promise Fetched data.
+     * @return Promise<mixed> Data.
      */
-    public function fetchAsync(string $source): Promise;
+    public function fetchAsync(DataSource $source): Promise;
 }

src/Cache/JsonCacheKeyGenerator.php

@@ -4,9 +4,7 @@
 namespace ScriptFUSION\Porter\Connector;
 
 use Psr\Cache\CacheItemPoolInterface;
-use ScriptFUSION\Porter\Cache\CacheKeyGenerator;
 use ScriptFUSION\Porter\Cache\InvalidCacheKeyException;
-use ScriptFUSION\Porter\Cache\JsonCacheKeyGenerator;
 use ScriptFUSION\Porter\Cache\MemoryCache;
 
 /**
@@ -16,6 +14,8 @@
  */
 class CachingConnector implements Connector, ConnectorWrapper
 {
+    public const RESERVED_CHARACTERS = '{}()/\@:';
+
     /**
      * @var Connector
      */
@@ -26,19 +26,12 @@ class CachingConnector implements Connector, ConnectorWrapper
      */
     private $cache;
 
-    /**
-     * @var CacheKeyGenerator
-     */
-    private $cacheKeyGenerator;
-
     public function __construct(
         Connector $connector,
-        CacheItemPoolInterface $cache = null,
-        CacheKeyGenerator $cacheKeyGenerator = null
+        CacheItemPoolInterface $cache = null
     ) {
         $this->connector = $connector;
         $this->cache = $cache ?: new MemoryCache;
-        $this->cacheKeyGenerator = $cacheKeyGenerator ?: new JsonCacheKeyGenerator;
     }
 
     public function __clone()
@@ -50,18 +43,11 @@ public function __clone()
     }
 
     /**
-     * @param string $source
-     *
-     * @return mixed
-     *
      * @throws InvalidCacheKeyException Cache key contains invalid data.
      */
-    public function fetch(string $source)
+    public function fetch(DataSource $source)
     {
-        $options = $this->connector instanceof ConnectorOptions ? $this->connector->getOptions()->copy() : [];
-        ksort($options);
-
-        $this->validateCacheKey($key = $this->cacheKeyGenerator->generateCacheKey($source, $options));
+        $this->validateCacheKey($key = $source->computeHash());
 
         if ($this->cache->hasItem($key)) {
             return $this->cache->getItem($key)->get();
@@ -79,11 +65,11 @@ public function fetch(string $source)
      */
     private function validateCacheKey(string $key): void
     {
-        if (strpbrk($key, CacheKeyGenerator::RESERVED_CHARACTERS) !== false) {
+        if (strpbrk($key, self::RESERVED_CHARACTERS) !== false) {
             throw new InvalidCacheKeyException(sprintf(
                 'Cache key "%s" contains one or more reserved characters: "%s".',
                 $key,
-                CacheKeyGenerator::RESERVED_CHARACTERS
+                self::RESERVED_CHARACTERS
             ));
         }
     }

src/CloneNotImplementedException.php

@@ -4,16 +4,16 @@
 namespace ScriptFUSION\Porter\Connector;
 
 /**
- * Provides a method for fetching data from a remote source.
+ * Provides a method for fetching data from a source.
  */
 interface Connector
 {
     /**
-     * Fetches data from the specified source optionally augmented by the specified options.
+     * Fetches data from the specified source.
      *
-     * @param string $source Source.
+     * @param DataSource $source Source.
      *
      * @return mixed Data.
      */
-    public function fetch(string $source);
+    public function fetch(DataSource $source);
 }

src/Connector/AsyncConnector.php

@@ -0,0 +1,19 @@
+<?php
+declare(strict_types=1);
+
+namespace ScriptFUSION\Porter\Connector;
+
+/**
+ * Specifies a data source and the necessary parameters required to fetch it.
+ */
+interface DataSource
+{
+    /**
+     * Computes the hash code for this object's state. The computed hash must be the same when the object state
+     * is unchanged or is still considered equivalent for cache key purposes, otherwise the hash code must always
+     * be different for different states.
+     *
+     * @return string Hash code.
+     */
+    public function computeHash(): string;
+}

src/Connector/CachingConnector.php

@@ -66,7 +66,7 @@ public function __construct(
         $this->maxFetchAttempts = $maxFetchAttempts;
     }
 
-    public function fetch(string $source)
+    public function fetch(DataSource $source)
     {
         return retry(
             $this->maxFetchAttempts,
@@ -77,7 +77,7 @@ function () use ($source) {
         );
     }
 
-    public function fetchAsync(string $source): Promise
+    public function fetchAsync(DataSource $source): Promise
     {
         return retryAsync(
             $this->maxFetchAttempts,

src/Connector/Connector.php

@@ -5,7 +5,7 @@
 
 final class NullConnector implements Connector
 {
-    public function fetch(string $source)
+    public function fetch(DataSource $source)
     {
         // Intentionally empty.
     }

src/Connector/ConnectorOptions.php

@@ -15,7 +15,6 @@
 use ScriptFUSION\Porter\Collection\PorterRecords;
 use ScriptFUSION\Porter\Collection\ProviderRecords;
 use ScriptFUSION\Porter\Collection\RecordCollection;
-use ScriptFUSION\Porter\Connector\ConnectorOptions;
 use ScriptFUSION\Porter\Connector\ImportConnectorFactory;
 use ScriptFUSION\Porter\Provider\AsyncProvider;
 use ScriptFUSION\Porter\Provider\ObjectNotCreatedException;
@@ -119,14 +118,6 @@ private function fetch(ImportSpecification $specification): \Iterator
 
         $connector = $provider->getConnector();
 
-        /* __clone method cannot be specified in interface due to Mockery limitation.
-           See https://github.com/mockery/mockery/issues/669 */
-        if ($connector instanceof ConnectorOptions && !method_exists($connector, '__clone')) {
-            throw new CloneNotImplementedException(
-                'Connector with options must implement __clone() method to deep clone options.'
-            );
-        }
-
         return $resource->fetch(ImportConnectorFactory::create($connector, $specification));
     }
 
@@ -198,14 +189,6 @@ private function fetchAsync(AsyncImportSpecification $specification): Iterator
 
         $connector = $provider->getAsyncConnector();
 
-        /* __clone method cannot be specified in interface due to Mockery limitation.
-           See https://github.com/mockery/mockery/issues/669 */
-        if ($connector instanceof ConnectorOptions && !method_exists($connector, '__clone')) {
-            throw new CloneNotImplementedException(
-                'Connector with options must implement __clone() method to deep clone options.'
-            );
-        }
-
         return $resource->fetchAsync(ImportConnectorFactory::create($connector, $specification));
     }
 

src/Connector/DataSource.php

@@ -18,11 +18,11 @@ interface ProviderResource
     public function getProviderClassName(): string;
 
     /**
-     * Fetches data from the provider using the the specified connector and presents its data as an enumerable series.
+     * Fetches data from the provider using the the specified connector and presents it as an iterable series.
      *
      * @param ImportConnector $connector Connector.
      *
-     * @return \Iterator Enumerable data series.
+     * @return \Iterator Iterable data series.
      */
     public function fetch(ImportConnector $connector): \Iterator;
 }

src/Connector/ImportConnector.php

@@ -4,7 +4,6 @@
 namespace ScriptFUSION\Porter\Provider\Resource;
 
 use ScriptFUSION\Porter\Connector\ImportConnector;
-use ScriptFUSION\Porter\Options\EncapsulatedOptions;
 use ScriptFUSION\Porter\Provider\StaticDataProvider;
 
 class StaticResource implements ProviderResource
@@ -21,7 +20,7 @@ public function getProviderClassName(): string
         return StaticDataProvider::class;
     }
 
-    public function fetch(ImportConnector $connector, EncapsulatedOptions $options = null): \Iterator
+    public function fetch(ImportConnector $connector): \Iterator
     {
         return $this->data;
     }