Moved provider tag from ImportSpecification to ProviderDataSource.

ScriptFUSION · Aug 11, 2016 · a1b2f0a · a1b2f0a
1 parent 54413a4
commit a1b2f0a
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 39 deletions.
diff --git a/src/Porter/Porter.php b/src/Porter/Porter.php
@@ -44,11 +44,7 @@ public function __construct()
      */
     public function import(ImportSpecification $specification)
     {
-        $records = $this->fetch(
-            $specification->getDataSource(),
-            $specification->getProviderTag(),
-            $specification->getCacheAdvice()
-        );
+        $records = $this->fetch($specification->getDataSource(), $specification->getCacheAdvice());
 
         if (!$records instanceof ProviderRecords) {
             // Wrap Iterator in ProviderRecords.
@@ -75,9 +71,9 @@ private function createPorterRecords(RecordCollection $records, ImportSpecificat
         return new PorterRecords($records, $specification);
     }
 
-    private function fetch(ProviderDataSource $dataSource, $providerTag, CacheAdvice $cacheAdvice = null)
+    private function fetch(ProviderDataSource $dataSource, CacheAdvice $cacheAdvice = null)
     {
-        $provider = $this->getProvider($dataSource->getProviderClassName(), $providerTag);
+        $provider = $this->getProvider($dataSource->getProviderClassName(), $dataSource->getProviderTag());
         $this->applyCacheAdvice($provider, $cacheAdvice ?: $this->defaultCacheAdvice);
 
         return $provider->fetch($dataSource);

diff --git a/src/Porter/Provider/DataSource/ProviderDataSource.php b/src/Porter/Provider/DataSource/ProviderDataSource.php
@@ -11,10 +11,17 @@ interface ProviderDataSource
     /**
      * Gets the class name of the provider this data source belongs to.
      *
-     * @return string
+     * @return string Provider class name.
      */
     public function getProviderClassName();
 
+    /**
+     * Gets the provider identifier tag.
+     *
+     * @return string|null Provider tag.
+     */
+    public function getProviderTag();
+
     /**
      * Fetches data from the provider using the the specified connector and
      * presents its data as an enumerable series.

diff --git a/src/Porter/Provider/DataSource/StaticDataSource.php b/src/Porter/Provider/DataSource/StaticDataSource.php
@@ -19,6 +19,11 @@ public function getProviderClassName()
         return StaticDataProvider::class;
     }
 
+    public function getProviderTag()
+    {
+        return;
+    }
+
     public function fetch(Connector $connector, EncapsulatedOptions $options = null)
     {
         return $this->data;

diff --git a/src/Porter/Specification/ImportSpecification.php b/src/Porter/Specification/ImportSpecification.php
@@ -10,9 +10,6 @@ class ImportSpecification
     /** @var ProviderDataSource */
     private $dataSource;
 
-    /** @var string */
-    private $providerTag;
-
     /** @var Mapping */
     private $mapping;
 
@@ -45,26 +42,6 @@ final public function getDataSource()
         return $this->dataSource;
     }
 
-    /**
-     * @return string
-     */
-    final public function getProviderTag()
-    {
-        return $this->providerTag;
-    }
-
-    /**
-     * @param $providerTag
-     *
-     * @return $this
-     */
-    final public function setProviderTag($providerTag)
-    {
-        $this->providerTag = "$providerTag";
-
-        return $this;
-    }
-
     /**
      * @return Mapping
      */

diff --git a/test/Integration/Porter/PorterTest.php b/test/Integration/Porter/PorterTest.php
@@ -63,6 +63,13 @@ public function testRegisterSameProvider()
         $this->porter->registerProvider($this->provider);
     }
 
+    public function testRegisterSameProviderType()
+    {
+        $this->setExpectedException(ProviderAlreadyRegisteredException::class);
+
+        $this->porter->registerProvider(clone $this->provider);
+    }
+
     public function testRegisterProviderTag()
     {
         $this->porter->registerProvider($provider = clone $this->provider, 'foo');
@@ -96,6 +103,26 @@ public function testGetStaticProviderTag()
         $this->porter->getProvider(StaticDataProvider::class, 'foo');
     }
 
+    public function testImportTaggedResource()
+    {
+        $this->porter->registerProvider(
+            $provider = \Mockery::mock(Provider::class)
+                ->shouldReceive('fetch')
+                ->andReturn(new \ArrayIterator([$output = 'bar']))
+                ->getMock(),
+            $tag = 'foo'
+        );
+
+        $records = $this->porter->import(MockFactory::mockImportSpecification(
+            MockFactory::mockDataSource($provider)
+                ->shouldReceive('getProviderTag')
+                ->andReturn($tag)
+                ->getMock()
+        ));
+
+        self::assertSame($output, $records->current());
+    }
+
     public function testHasProvider()
     {
         self::assertTrue($this->porter->hasProvider(get_class($this->provider)));

diff --git a/test/MockFactory.php b/test/MockFactory.php
@@ -11,9 +11,9 @@ final class MockFactory
 {
     use StaticClass;
 
-    public static function mockImportSpecification()
+    public static function mockImportSpecification(ProviderDataSource $dataSource = null)
     {
-        return \Mockery::mock(ImportSpecification::class, [\Mockery::mock(ProviderDataSource::class)]);
+        return \Mockery::mock(ImportSpecification::class, [$dataSource ?: \Mockery::mock(ProviderDataSource::class)]);
     }
 
     /**
@@ -23,7 +23,7 @@ public static function mockImportSpecification()
      */
     public static function mockDataSource(Provider $provider)
     {
-        return \Mockery::mock(ProviderDataSource::class)
+        return \Mockery::spy(ProviderDataSource::class)
             ->shouldReceive('getProviderClassName')
             ->andReturn(get_class($provider))
             ->getMock();

diff --git a/test/Unit/Porter/ImportSpecificationTest.php b/test/Unit/Porter/ImportSpecificationTest.php
@@ -36,11 +36,6 @@ public function testProviderData()
         self::assertSame($this->dataSource, $this->specification->getDataSource());
     }
 
-    public function testProviderTag()
-    {
-        self::assertSame('foo', $this->specification->setProviderTag('foo')->getProviderTag());
-    }
-
     public function testMapping()
     {
         self::assertSame(