Added ProviderFactory.

ScriptFUSION · Jan 23, 2016 · 45ca9dd · 45ca9dd
1 parent 1b17c16
commit 45ca9dd
Show file tree

Hide file tree

Showing 12 changed files with 109 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
 Porter
 ======
 
-[![Version][Version image]][Releases]
+[![Latest version][Version image]][Releases]
 [![Build status][Build image]][Build]
-[![Coverage][Coverage image]][Coverage]
+[![Test coverage][Coverage image]][Coverage]
+[![Code style][Style image]][Style]
 
 Porter is a data import abstraction library.
 
@@ -14,8 +15,10 @@ Requirements
 
 
   [Releases]: https://github.com/ScriptFUSION/Porter/releases
-  [Version image]: http://img.shields.io/github/tag/ScriptFUSION/Porter.svg "Latest version"
+  [Version image]: https://poser.pugx.org/scriptfusion/porter/v/stable "Latest version"
   [Build]: http://travis-ci.org/ScriptFUSION/Porter
-  [Build image]: http://img.shields.io/travis/ScriptFUSION/Porter.svg "Build status"
-  [Coverage]: https://coveralls.io/github/ScriptFUSION/Porter?branch=master
-  [Coverage image]: https://coveralls.io/repos/ScriptFUSION/Porter/badge.svg?branch=master&service=github "Test coverage"
+  [Build image]: https://travis-ci.org/ScriptFUSION/Porter.svg "Build status"
+  [Coverage]: https://coveralls.io/github/ScriptFUSION/Porter
+  [Coverage image]: https://coveralls.io/repos/ScriptFUSION/Porter/badge.svg "Test coverage"
+  [Style]: https://styleci.io/repos/49824895
+  [Style image]: https://styleci.io/repos/49824895/shield?style=flat "Code style"
diff --git a/src/Porter/ObjectNotCreatedException.php b/src/Porter/ObjectNotCreatedException.php
@@ -0,0 +1,10 @@
+<?php
+namespace ScriptFUSION\Porter;
+
+/**
+ * The exception that is thrown when an object could not be created.
+ */
+class ObjectNotCreatedException extends \RuntimeException
+{
+    // Intentionally empty.
+}
diff --git a/src/Porter/Porter.php b/src/Porter/Porter.php
@@ -8,11 +8,15 @@
 use ScriptFUSION\Porter\Mapping\Mapping;
 use ScriptFUSION\Porter\Provider\Provider;
 use ScriptFUSION\Porter\Provider\ProviderData;
+use ScriptFUSION\Porter\Provider\ProviderFactory;
+use ScriptFUSION\Porter\Specification\ImportSpecification;
 
 class Porter
 {
     private $providers;
 
+    private $providerFactory;
+
     private $mapper;
 
     /**
@@ -51,7 +55,13 @@ public function getProvider($name)
             return $this->providers["$name"];
         }
 
-        throw new ProviderNotFoundException("No such provider registered: \"$name\".");
+        try {
+            $this->addProvider($provider = $this->getOrCreateProviderFactory()->createProvider("$name"));
+        } catch (ObjectNotCreatedException $e) {
+            throw new ProviderNotFoundException("No such provider registered: \"$name\".", $e);
+        }
+
+        return $provider;
     }
 
     public function addProvider(Provider $provider)
@@ -70,6 +80,18 @@ public function addProviders(array $providers)
         return $this;
     }
 
+    private function getOrCreateProviderFactory()
+    {
+        return $this->providerFactory ?: $this->providerFactory = new ProviderFactory;
+    }
+
+    public function setProviderFactory(ProviderFactory $factory)
+    {
+        $this->providerFactory = $factory;
+
+        return $this;
+    }
+
     /**
      * @return Mapper
      */

diff --git a/src/Porter/Provider/ProviderFactory.php b/src/Porter/Provider/ProviderFactory.php
@@ -0,0 +1,17 @@
+<?php
+namespace ScriptFUSION\Porter\Provider;
+
+use ScriptFUSION\Porter\ObjectNotCreatedException;
+
+class ProviderFactory
+{
+    public function createProvider($name)
+    {
+        switch ($name) {
+            case StaticDataProvider::class:
+                return new StaticDataProvider;
+        }
+
+        throw new ObjectNotCreatedException("Factory does not know how to create: \"$name\".");
+    }
+}
diff --git a/src/Porter/ProviderNotFoundException.php b/src/Porter/ProviderNotFoundException.php
@@ -1,7 +1,12 @@
 <?php
 namespace ScriptFUSION\Porter;
 
+use Exception;
+
 final class ProviderNotFoundException extends \RuntimeException
 {
-    // Intentionally empty.
+    public function __construct($message, Exception $previous = null)
+    {
+        parent::__construct($message, 0, $previous);
+    }
 }
diff --git a/src/Porter/ImportSpecification.php → ...ter/Specification/ImportSpecification.php b/src/Porter/ImportSpecification.php → ...ter/Specification/ImportSpecification.php
@@ -1,7 +1,8 @@
 <?php
-namespace ScriptFUSION\Porter;
+namespace ScriptFUSION\Porter\Specification;
 
 use ScriptFUSION\Porter\Mapping\Mapping;
+use ScriptFUSION\Porter\ObjectFinalizedException;
 use ScriptFUSION\Porter\Provider\ProviderData;
 
 class ImportSpecification

diff --git a/src/Porter/Specification/StaticDataImportSpecification.php b/src/Porter/Specification/StaticDataImportSpecification.php
@@ -0,0 +1,12 @@
+<?php
+namespace ScriptFUSION\Porter\Specification;
+
+use ScriptFUSION\Porter\Provider\StaticData;
+
+class StaticDataImportSpecification extends ImportSpecification
+{
+    public function __construct(\Iterator $data)
+    {
+        parent::__construct(new StaticData($data));
+    }
+}
diff --git a/test/Functional/StaticDataTest.php b/test/Functional/StaticDataTest.php
@@ -0,0 +1,15 @@
+<?php
+namespace ScriptFUSIONTest\Functional;
+
+use ScriptFUSION\Porter\Porter;
+use ScriptFUSION\Porter\Specification\StaticDataImportSpecification;
+
+final class StaticDataTest extends \PHPUnit_Framework_TestCase
+{
+    public function test()
+    {
+        $records = (new Porter)->import(new StaticDataImportSpecification(new \ArrayIterator(['foo'])));
+
+        $this->assertSame('foo', $records->current());
+    }
+}
diff --git a/test/Unit/Porter/PorterTest.php → test/Integration/Porter/PorterTest.php b/test/Unit/Porter/PorterTest.php → test/Integration/Porter/PorterTest.php
@@ -1,13 +1,13 @@
 <?php
-namespace ScriptFUSIONTest\Unit\Porter;
+namespace ScriptFUSIONTest\Integration\Porter;
 
 use Mockery\MockInterface;
 use ScriptFUSION\Porter\Collection\ProviderRecords;
-use ScriptFUSION\Porter\ImportSpecification;
 use ScriptFUSION\Porter\Porter;
 use ScriptFUSION\Porter\Provider\Provider;
 use ScriptFUSION\Porter\Provider\ProviderData;
 use ScriptFUSION\Porter\ProviderNotFoundException;
+use ScriptFUSION\Porter\Specification\ImportSpecification;
 
 final class PorterTest extends \PHPUnit_Framework_TestCase
 {

diff --git a/test/Integration/Porter/Provider/StaticDataProviderTest.php b/test/Integration/Porter/Provider/StaticDataProviderTest.php
diff --git a/test/Unit/Porter/Connector/NullConnectorTest.php b/test/Unit/Porter/Connector/NullConnectorTest.php
@@ -0,0 +1,12 @@
+<?php
+namespace ScriptFUSIONTest\Unit\Porter\Connector;
+
+use ScriptFUSION\Porter\Connector\NullConnector;
+
+final class NullConnectorTest extends \PHPUnit_Framework_TestCase
+{
+    public function test()
+    {
+        $this->assertNull((new NullConnector)->fetch('foo'));
+    }
+}
diff --git a/test/Unit/Porter/ImportSpecificationTest.php b/test/Unit/Porter/ImportSpecificationTest.php
@@ -1,10 +1,10 @@
 <?php
 namespace ScriptFUSIONTest\Unit\Porter;
 
-use ScriptFUSION\Porter\ImportSpecification;
 use ScriptFUSION\Porter\Mapping\Mapping;
 use ScriptFUSION\Porter\ObjectFinalizedException;
 use ScriptFUSION\Porter\Provider\ProviderData;
+use ScriptFUSION\Porter\Specification\ImportSpecification;
 
 final class ImportSpecificationTest extends \PHPUnit_Framework_TestCase
 {