Added AbstractResource and accompanying test.

Bilge · Bilge · commit 2f63f16cff29 · 2016-08-11T22:36:42.000+01:00
Renamed ProviderResource -&gt; Resource.
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/src/Porter/Provider/Resource/Resource.php b/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());
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,21 +1,21 @@`
`1`	`1`	`<?php`
`2`	`2`	`namespace ScriptFUSION\Porter\Collection;`
`3`	`3`
`4`		`-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;`
	`4`	`+use ScriptFUSION\Porter\Provider\Resource\Resource;`
`5`	`5`
`6`	`6`	`class ProviderRecords extends RecordCollection`
`7`	`7`	`{`
`8`	`8`	`private $resource;`
`9`	`9`
`10`		`- public function __construct(\Iterator $providerRecords, ProviderResource $resource)`
	`10`	`+ public function __construct(\Iterator $providerRecords, Resource $resource)`
`11`	`11`	`{`
`12`	`12`	`parent::__construct($providerRecords);`
`13`	`13`
`14`	`14`	`$this->resource = $resource;`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * @return ProviderResource`
	`18`	`+ * @return Resource`
`19`	`19`	`*/`
`20`	`20`	`public function getResource()`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,9 @@`
`3`	`3`
`4`	`4`	`use ScriptFUSION\Porter\Options\EncapsulatedOptions;`
`5`	`5`
	`6`	`+/**`
	`7`	`+ * TODO. Add missing SOAP context option accessors and mutators.`
	`8`	`+ */`
`6`	`9`	`final class SoapOptions extends EncapsulatedOptions`
`7`	`10`	`{`
`8`	`11`	`public function __construct()`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`use ScriptFUSION\Porter\Cache\CacheToggle;`
`5`	`5`	`use ScriptFUSION\Porter\Cache\CacheUnavailableException;`
`6`	`6`	`use ScriptFUSION\Porter\Connector\Connector;`
`7`		`-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;`
	`7`	`+use ScriptFUSION\Porter\Provider\Resource\Resource;`
`8`	`8`
`9`	`9`	`abstract class AbstractProvider implements Provider, CacheToggle`
`10`	`10`	`{`
`@@ -16,13 +16,13 @@ public function __construct(Connector $connector)`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * @param ProviderResource $resource`
	`19`	`+ * @param Resource $resource`
`20`	`20`	`*`
`21`	`21`	`* @return \Iterator`
`22`	`22`	`*`
`23`	`23`	`* @throws ForeignResourceException A foreign resource was received.`
`24`	`24`	`*/`
`25`		`- public function fetch(ProviderResource $resource)`
	`25`	`+ public function fetch(Resource $resource)`
`26`	`26`	`{`
`27`	`27`	`if ($resource->getProviderClassName() !== static::class) {`
`28`	`28`	`throw new ForeignResourceException(sprintf(`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`<?php`
`2`	`2`	`namespace ScriptFUSION\Porter\Provider;`
`3`	`3`
`4`		`-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;`
	`4`	`+use ScriptFUSION\Porter\Provider\Resource\Resource;`
`5`	`5`
`6`	`6`	`/**`
`7`	`7`	`* Provides a method for fetching data from a resource.`
`@@ -11,9 +11,9 @@ interface Provider`
`11`	`11`	`/**`
`12`	`12`	`* Fetches data from the specified resource.`
`13`	`13`	`*`
`14`		`- * @param ProviderResource $resource Resource.`
	`14`	`+ * @param Resource $resource Resource.`
`15`	`15`	`*`
`16`	`16`	`* @return \Iterator Enumerable data series.`
`17`	`17`	`*/`
`18`		`- public function fetch(ProviderResource $resource);`
	`18`	`+ public function fetch(Resource $resource);`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`/**`
`7`	`7`	`* Defines methods for fetching data from a specific provider resource.`
`8`	`8`	`*/`
`9`		`-interface ProviderResource`
	`9`	`+interface Resource`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`	`12`	`* Gets the class name of the provider this resource belongs to.`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`use ScriptFUSION\Porter\Options\EncapsulatedOptions;`
`6`	`6`	`use ScriptFUSION\Porter\Provider\StaticDataProvider;`
`7`	`7`
`8`		`-class StaticResource implements ProviderResource`
	`8`	`+class StaticResource implements Resource`
`9`	`9`	`{`
`10`	`10`	`private $data;`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,11 @@`
`3`	`3`
`4`	`4`	`use ScriptFUSION\Mapper\Mapping;`
`5`	`5`	`use ScriptFUSION\Porter\Cache\CacheAdvice;`
`6`		`-use ScriptFUSION\Porter\Provider\Resource\ProviderResource;`
	`6`	`+use ScriptFUSION\Porter\Provider\Resource\Resource;`
`7`	`7`
`8`	`8`	`class ImportSpecification`
`9`	`9`	`{`
`10`		`- /** @var ProviderResource */`
	`10`	`+ /** @var Resource */`
`11`	`11`	`private $resource;`
`12`	`12`
`13`	`13`	`/** @var Mapping */`
`@@ -22,7 +22,7 @@ class ImportSpecification`
`22`	`22`	`/** @var CacheAdvice */`
`23`	`23`	`private $cacheAdvice;`
`24`	`24`
`25`		`- public function __construct(ProviderResource $resource)`
	`25`	`+ public function __construct(Resource $resource)`
`26`	`26`	`{`
`27`	`27`	`$this->resource = $resource;`
`28`	`28`	`}`
`@@ -35,7 +35,7 @@ public function __clone()`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`/**`
`38`		`- * @return ProviderResource`
	`38`	`+ * @return Resource`
`39`	`39`	`*/`
`40`	`40`	`final public function getResource()`
`41`	`41`	`{`