Added AbstractResource and accompanying test.

Renamed ProviderResource -> Resource.
ScriptFUSION · Aug 11, 2016 · 2f63f16 · 2f63f16
1 parent 22a667d
commit 2f63f16
Show file tree

Hide file tree

Showing 17 changed files with 93 additions and 37 deletions.
diff --git a/src/Porter/Collection/CountableProviderRecords.php b/src/Porter/Collection/CountableProviderRecords.php
@@ -1,7 +1,7 @@
 <?php
 namespace ScriptFUSION\Porter\Collection;
 
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 
 class CountableProviderRecords extends ProviderRecords implements \Countable
 {
@@ -10,9 +10,9 @@ class CountableProviderRecords extends ProviderRecords implements \Countable
     /**
      * @param \Iterator $providerRecords
      * @param int $count
-     * @param ProviderResource $resource
+     * @param Resource $resource
      */
-    public function __construct(\Iterator $providerRecords, $count, ProviderResource $resource)
+    public function __construct(\Iterator $providerRecords, $count, Resource $resource)
     {
         parent::__construct($providerRecords, $resource);
 

diff --git a/src/Porter/Collection/ProviderRecords.php b/src/Porter/Collection/ProviderRecords.php
@@ -1,21 +1,21 @@
 <?php
 namespace ScriptFUSION\Porter\Collection;
 
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 
 class ProviderRecords extends RecordCollection
 {
     private $resource;
 
-    public function __construct(\Iterator $providerRecords, ProviderResource $resource)
+    public function __construct(\Iterator $providerRecords, Resource $resource)
     {
         parent::__construct($providerRecords);
 
         $this->resource = $resource;
     }
 
     /**
-     * @return ProviderResource
+     * @return Resource
      */
     public function getResource()
     {

diff --git a/src/Porter/Net/Soap/SoapOptions.php b/src/Porter/Net/Soap/SoapOptions.php
@@ -3,6 +3,9 @@
 
 use ScriptFUSION\Porter\Options\EncapsulatedOptions;
 
+/**
+ * TODO. Add missing SOAP context option accessors and mutators.
+ */
 final class SoapOptions extends EncapsulatedOptions
 {
     public function __construct()

diff --git a/src/Porter/Porter.php b/src/Porter/Porter.php
@@ -17,7 +17,7 @@
 use ScriptFUSION\Porter\Provider\ObjectNotCreatedException;
 use ScriptFUSION\Porter\Provider\Provider;
 use ScriptFUSION\Porter\Provider\ProviderFactory;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 use ScriptFUSION\Porter\Specification\ImportSpecification;
 
 class Porter
@@ -71,7 +71,7 @@ private function createPorterRecords(RecordCollection $records, ImportSpecificat
         return new PorterRecords($records, $specification);
     }
 
-    private function fetch(ProviderResource $resource, CacheAdvice $cacheAdvice = null)
+    private function fetch(Resource $resource, CacheAdvice $cacheAdvice = null)
     {
         $provider = $this->getProvider($resource->getProviderClassName(), $resource->getProviderTag());
         $this->applyCacheAdvice($provider, $cacheAdvice ?: $this->defaultCacheAdvice);

diff --git a/src/Porter/Provider/AbstractProvider.php b/src/Porter/Provider/AbstractProvider.php
@@ -4,7 +4,7 @@
 use ScriptFUSION\Porter\Cache\CacheToggle;
 use ScriptFUSION\Porter\Cache\CacheUnavailableException;
 use ScriptFUSION\Porter\Connector\Connector;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 
 abstract class AbstractProvider implements Provider, CacheToggle
 {
@@ -16,13 +16,13 @@ public function __construct(Connector $connector)
     }
 
     /**
-     * @param ProviderResource $resource
+     * @param Resource $resource
      *
      * @return \Iterator
      *
      * @throws ForeignResourceException A foreign resource was received.
      */
-    public function fetch(ProviderResource $resource)
+    public function fetch(Resource $resource)
     {
         if ($resource->getProviderClassName() !== static::class) {
             throw new ForeignResourceException(sprintf(

diff --git a/src/Porter/Provider/Provider.php b/src/Porter/Provider/Provider.php
@@ -1,7 +1,7 @@
 <?php
 namespace ScriptFUSION\Porter\Provider;
 
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 
 /**
  * Provides a method for fetching data from a resource.
@@ -11,9 +11,9 @@ interface Provider
     /**
      * Fetches data from the specified resource.
      *
-     * @param ProviderResource $resource Resource.
+     * @param Resource $resource Resource.
      *
      * @return \Iterator Enumerable data series.
      */
-    public function fetch(ProviderResource $resource);
+    public function fetch(Resource $resource);
 }
diff --git a/src/Porter/Provider/Resource/AbstractResource.php b/src/Porter/Provider/Resource/AbstractResource.php
@@ -0,0 +1,35 @@
+<?php
+namespace ScriptFUSION\Porter\Provider\Resource;
+
+/**
+ * Partially implements Resource.
+ */
+abstract class AbstractResource implements Resource
+{
+    /** @var string */
+    private $providerTag;
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return string Provider tag.
+     */
+    public function getProviderTag()
+    {
+        return $this->providerTag;
+    }
+
+    /**
+     * Sets the provider identifier tag.
+     *
+     * @param string $tag Provider tag.
+     *
+     * @return $this
+     */
+    public function setProviderTag($tag)
+    {
+        $this->providerTag = "$tag";
+
+        return $this;
+    }
+}
diff --git a/...er/Provider/Resource/ProviderResource.php → src/Porter/Provider/Resource/Resource.php b/...er/Provider/Resource/ProviderResource.php → src/Porter/Provider/Resource/Resource.php
@@ -6,7 +6,7 @@
 /**
  * Defines methods for fetching data from a specific provider resource.
  */
-interface ProviderResource
+interface Resource
 {
     /**
      * Gets the class name of the provider this resource belongs to.

diff --git a/src/Porter/Provider/Resource/StaticResource.php b/src/Porter/Provider/Resource/StaticResource.php
@@ -5,7 +5,7 @@
 use ScriptFUSION\Porter\Options\EncapsulatedOptions;
 use ScriptFUSION\Porter\Provider\StaticDataProvider;
 
-class StaticResource implements ProviderResource
+class StaticResource implements Resource
 {
     private $data;
 

diff --git a/src/Porter/Specification/ImportSpecification.php b/src/Porter/Specification/ImportSpecification.php
@@ -3,11 +3,11 @@
 
 use ScriptFUSION\Mapper\Mapping;
 use ScriptFUSION\Porter\Cache\CacheAdvice;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 
 class ImportSpecification
 {
-    /** @var ProviderResource */
+    /** @var Resource */
     private $resource;
 
     /** @var Mapping */
@@ -22,7 +22,7 @@ class ImportSpecification
     /** @var CacheAdvice */
     private $cacheAdvice;
 
-    public function __construct(ProviderResource $resource)
+    public function __construct(Resource $resource)
     {
         $this->resource = $resource;
     }
@@ -35,7 +35,7 @@ public function __clone()
     }
 
     /**
-     * @return ProviderResource
+     * @return Resource
      */
     final public function getResource()
     {

diff --git a/test/Integration/Porter/Collection/CountableProviderRecordsTest.php b/test/Integration/Porter/Collection/CountableProviderRecordsTest.php
@@ -2,7 +2,7 @@
 namespace ScriptFUSIONTest\Integration\Porter\Collection;
 
 use ScriptFUSION\Porter\Collection\CountableProviderRecords;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 
 final class CountableProviderRecordsTest extends \PHPUnit_Framework_TestCase
 {
@@ -13,7 +13,7 @@ public function test()
         $records = new CountableProviderRecords(
             new \ArrayIterator($data),
             count($data),
-            \Mockery::mock(ProviderResource::class)
+            \Mockery::mock(Resource::class)
         );
 
         self::assertCount(count($data), $records);

diff --git a/test/Integration/Porter/PorterTest.php b/test/Integration/Porter/PorterTest.php
@@ -16,7 +16,7 @@
 use ScriptFUSION\Porter\Collection\ProviderRecords;
 use ScriptFUSION\Porter\Porter;
 use ScriptFUSION\Porter\Provider\Provider;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 use ScriptFUSION\Porter\Provider\StaticDataProvider;
 use ScriptFUSION\Porter\ProviderAlreadyRegisteredException;
 use ScriptFUSION\Porter\ProviderNotFoundException;
@@ -34,7 +34,7 @@ final class PorterTest extends \PHPUnit_Framework_TestCase
     /** @var Provider|MockInterface */
     private $provider;
 
-    /** @var ProviderResource */
+    /** @var Resource */
     private $resource;
 
     protected function setUp()

diff --git a/test/MockFactory.php b/test/MockFactory.php
@@ -3,27 +3,27 @@
 
 use Mockery\MockInterface;
 use ScriptFUSION\Porter\Provider\Provider;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 use ScriptFUSION\Porter\Specification\ImportSpecification;
 use ScriptFUSION\StaticClass;
 
 final class MockFactory
 {
     use StaticClass;
 
-    public static function mockImportSpecification(ProviderResource $resource = null)
+    public static function mockImportSpecification(Resource $resource = null)
     {
-        return \Mockery::mock(ImportSpecification::class, [$resource ?: \Mockery::mock(ProviderResource::class)]);
+        return \Mockery::mock(ImportSpecification::class, [$resource ?: \Mockery::mock(Resource::class)]);
     }
 
     /**
      * @param Provider $provider
      *
-     * @return MockInterface|ProviderResource
+     * @return MockInterface|Resource
      */
     public static function mockResource(Provider $provider)
     {
-        return \Mockery::spy(ProviderResource::class)
+        return \Mockery::spy(Resource::class)
             ->shouldReceive('getProviderClassName')
             ->andReturn(get_class($provider))
             ->getMock();

diff --git a/test/Unit/Porter/Collection/ProviderRecordsTest.php b/test/Unit/Porter/Collection/ProviderRecordsTest.php
@@ -2,15 +2,15 @@
 namespace ScriptFUSIONTest\Unit\Porter\Collection;
 
 use ScriptFUSION\Porter\Collection\ProviderRecords;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 
 final class ProviderRecordsTest extends \PHPUnit_Framework_TestCase
 {
     public function test()
     {
         $records = new ProviderRecords(
             \Mockery::mock(\Iterator::class),
-            $resource = \Mockery::mock(ProviderResource::class)
+            $resource = \Mockery::mock(Resource::class)
         );
 
         self::assertSame($resource, $records->getResource());

diff --git a/test/Unit/Porter/ImportSpecificationTest.php b/test/Unit/Porter/ImportSpecificationTest.php
@@ -3,21 +3,21 @@
 
 use ScriptFUSION\Mapper\Mapping;
 use ScriptFUSION\Porter\Cache\CacheAdvice;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 use ScriptFUSION\Porter\Specification\ImportSpecification;
 
 final class ImportSpecificationTest extends \PHPUnit_Framework_TestCase
 {
     /** @var ImportSpecification */
     private $specification;
 
-    /** @var ProviderResource */
+    /** @var Resource */
     private $resource;
 
     protected function setUp()
     {
         $this->specification = new ImportSpecification(
-            $this->resource = \Mockery::mock(ProviderResource::class)
+            $this->resource = \Mockery::mock(Resource::class)
         );
     }
 

diff --git a/test/Unit/Porter/Provider/AbstractProviderTest.php b/test/Unit/Porter/Provider/AbstractProviderTest.php
@@ -8,7 +8,7 @@
 use ScriptFUSION\Porter\Connector\Connector;
 use ScriptFUSION\Porter\Provider\AbstractProvider;
 use ScriptFUSION\Porter\Provider\ForeignResourceException;
-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;
+use ScriptFUSION\Porter\Provider\Resource\Resource;
 
 final class AbstractProviderTest extends \PHPUnit_Framework_TestCase
 {
@@ -45,7 +45,7 @@ public function testFetch()
         self::assertSame(
             'foo',
             $this->provider->fetch(
-                \Mockery::mock(ProviderResource::class)
+                \Mockery::mock(Resource::class)
                     ->shouldReceive('fetch')
                     ->with($this->connector)
                     ->andReturn('foo')
@@ -62,7 +62,7 @@ public function testFetchForeignProvider()
         $this->setExpectedException(ForeignResourceException::class);
 
         $this->provider->fetch(
-            \Mockery::mock(ProviderResource::class)
+            \Mockery::mock(Resource::class)
                 ->shouldReceive('getProviderClassName')
                 ->andReturn('foo')
                 ->getMock()

diff --git a/test/Unit/Porter/Provider/Resource/AbstractResourceTest.php b/test/Unit/Porter/Provider/Resource/AbstractResourceTest.php
@@ -0,0 +1,18 @@
+<?php
+namespace ScriptFUSIONTest\Unit\Porter\Provider\Resource;
+
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
+use ScriptFUSION\Porter\Provider\Resource\AbstractResource;
+
+final class AbstractResourceTest extends \PHPUnit_Framework_TestCase
+{
+    use MockeryPHPUnitIntegration;
+
+    public function testTag()
+    {
+        /** @var AbstractResource $abstractResource */
+        $abstractResource = \Mockery::mock(AbstractResource::class)->makePartial();
+
+        self::assertSame($tag = 'foo', $abstractResource->setProviderTag($tag)->getProviderTag());
+    }
+}