Removed EncapsulatedOptions parameter from Connector::fetch method.

Removed ProviderOptions.
Added ConnectorOptions interface and accompanying trait.
Forced ConnectorOptions to implement __clone in Porter.

These changes stop passing EncapsulatedOptions around in method calls,
instead tieing them to their Connector implementation. This makes sense
because connectors have a 1:1 relationship with their options. That is,
different options cannot be used with different connectors.

To make connectors and their options immutable during import, connectors
are now cloned in Porter::fetch() and connectors exporting options must
implement __clone() to deep clone their options.

Author: Bilge

.travis.yml

@@ -10,6 +10,7 @@ php:
   - 5.6
   - 7.0
   - 7.1
+  - 7.2
 
 env:
   matrix:
@@ -21,7 +22,7 @@ matrix:
 
 cache:
   directories:
-    - .composer/cache
+    - vendor
 
 install:
   - alias composer=composer\ -n && composer selfupdate

src/Collection/RecordCollection.php

@@ -10,7 +10,7 @@ abstract class RecordCollection implements \Iterator
 
     private $previousCollection;
 
-    public function __construct(\Iterator $records, RecordCollection $previousCollection = null)
+    public function __construct(\Iterator $records, self $previousCollection = null)
     {
         $this->records = $records;
         $this->previousCollection = $previousCollection;

src/Connector/CachingConnector.php

@@ -6,7 +6,6 @@
 use ScriptFUSION\Porter\Cache\InvalidCacheKeyException;
 use ScriptFUSION\Porter\Cache\JsonCacheKeyGenerator;
 use ScriptFUSION\Porter\Cache\MemoryCache;
-use ScriptFUSION\Porter\Options\EncapsulatedOptions;
 
 /**
  * Wraps a connector to cache fetched data using PSR-6-compliant objects.
@@ -39,28 +38,27 @@ public function __construct(
     }
 
     /**
+     * @param ConnectionContext $context
      * @param string $source
-     * @param EncapsulatedOptions|null $options
      *
      * @return mixed
      *
      * @throws InvalidCacheKeyException
      */
-    public function fetch(ConnectionContext $context, $source, EncapsulatedOptions $options = null)
+    public function fetch(ConnectionContext $context, $source)
     {
         if ($context->mustCache()) {
-            $optionsCopy = $options ? $options->copy() : [];
+            $options = $this->connector instanceof ConnectorOptions ? $this->connector->getOptions()->copy() : [];
+            ksort($options);
 
-            ksort($optionsCopy);
-
-            $this->validateCacheKey($key = $this->cacheKeyGenerator->generateCacheKey($source, $optionsCopy));
+            $this->validateCacheKey($key = $this->cacheKeyGenerator->generateCacheKey($source, $options));
 
             if ($this->cache->hasItem($key)) {
                 return $this->cache->getItem($key)->get();
             }
         }
 
-        $data = $this->connector->fetch($context, $source, $options);
+        $data = $this->connector->fetch($context, $source);
 
         isset($key) && $this->cache->save($this->cache->getItem($key)->set($data));
 

src/Connector/Connector.php

@@ -1,8 +1,6 @@
 <?php
 namespace ScriptFUSION\Porter\Connector;
 
-use ScriptFUSION\Porter\Options\EncapsulatedOptions;
-
 /**
  * Provides a method for fetching data from a remote source.
  */
@@ -13,9 +11,8 @@ interface Connector
      *
      * @param ConnectionContext $context Runtime connection settings and methods.
      * @param string $source Source.
-     * @param EncapsulatedOptions|null $options Optional. Options.
      *
      * @return mixed Data.
      */
-    public function fetch(ConnectionContext $context, $source, EncapsulatedOptions $options = null);
+    public function fetch(ConnectionContext $context, $source);
 }

src/Connector/ConnectorOptions.php

@@ -0,0 +1,12 @@
+<?php
+namespace ScriptFUSION\Porter\Connector;
+
+use ScriptFUSION\Porter\Options\EncapsulatedOptions;
+
+interface ConnectorOptions
+{
+    /**
+     * @return EncapsulatedOptions
+     */
+    public function getOptions();
+}

src/Connector/ConnectorOptionsTrait.php

@@ -0,0 +1,25 @@
+<?php
+namespace ScriptFUSION\Porter\Connector;
+
+use ScriptFUSION\Porter\Options\EncapsulatedOptions;
+
+trait ConnectorOptionsTrait
+{
+    /**
+     * @var EncapsulatedOptions
+     */
+    private $options;
+
+    /**
+     * @return EncapsulatedOptions
+     */
+    public function getOptions()
+    {
+        return $this->options;
+    }
+
+    public function __clone()
+    {
+        $this->options = clone $this->options;
+    }
+}

src/Connector/ImportConnector.php

@@ -2,7 +2,6 @@
 namespace ScriptFUSION\Porter\Connector;
 
 use ScriptFUSION\Porter\Cache\CacheUnavailableException;
-use ScriptFUSION\Porter\Options\EncapsulatedOptions;
 
 /**
  * Connector whose lifecycle is synchronised with an import operation. Ensures correct ConnectionContext is delivered
@@ -26,8 +25,8 @@ public function __construct(Connector $connector, ConnectionContext $context)
         $this->context = $context;
     }
 
-    public function fetch($source, EncapsulatedOptions $options = null)
+    public function fetch($source)
     {
-        return $this->connector->fetch($this->context, $source, $options);
+        return $this->connector->fetch($this->context, $source);
     }
 }

src/Connector/NullConnector.php

@@ -1,11 +1,9 @@
 <?php
 namespace ScriptFUSION\Porter\Connector;
 
-use ScriptFUSION\Porter\Options\EncapsulatedOptions;
-
 class NullConnector implements Connector
 {
-    public function fetch(ConnectionContext $context, $source, EncapsulatedOptions $options = null)
+    public function fetch(ConnectionContext $context, $source)
     {
         // Intentionally empty.
     }

src/Porter.php

@@ -9,12 +9,12 @@
 use ScriptFUSION\Porter\Collection\RecordCollection;
 use ScriptFUSION\Porter\Connector\ConnectionContext;
 use ScriptFUSION\Porter\Connector\ConnectionContextFactory;
+use ScriptFUSION\Porter\Connector\ConnectorOptions;
 use ScriptFUSION\Porter\Connector\ImportConnector;
 use ScriptFUSION\Porter\Provider\ForeignResourceException;
 use ScriptFUSION\Porter\Provider\ObjectNotCreatedException;
 use ScriptFUSION\Porter\Provider\Provider;
 use ScriptFUSION\Porter\Provider\ProviderFactory;
-use ScriptFUSION\Porter\Provider\ProviderOptions;
 use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
 use ScriptFUSION\Porter\Specification\ImportSpecification;
 use ScriptFUSION\Porter\Transform\Transformer;
@@ -109,10 +109,17 @@ private function fetch(ProviderResource $resource, $providerName, ConnectionCont
             ));
         }
 
-        $records = $resource->fetch(
-            new ImportConnector($provider->getConnector(), $context),
-            $provider instanceof ProviderOptions ? clone $provider->getOptions() : null
-        );
+        $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 \LogicException(
+                'Connector with options must implement __clone() method to deep clone options.'
+            );
+        }
+
+        $records = $resource->fetch(new ImportConnector(clone $connector, $context));
 
         if (!$records instanceof \Iterator) {
             throw new ImportException(get_class($resource) . '::fetch() did not return an Iterator.');