Merge pull request #306 from bburnichon/feature/scope-factory

Introduce Scope Factory
thephpleague · Jun 12, 2017 · a0b3508 · a0b3508
2 parents ff99dd5 + ed148f1
commit a0b3508
Show file tree

Hide file tree

Showing 4 changed files with 182 additions and 9 deletions.
diff --git a/src/Manager.php b/src/Manager.php
@@ -73,6 +73,18 @@ class Manager
      */
     protected $serializer;
 
+    /**
+     * Factory used to create new configured scopes.
+     *
+     * @var ScopeFactoryInterface
+     */
+    private $scopeFactory;
+
+    public function __construct(ScopeFactoryInterface $scopeFactory = null)
+    {
+        $this->scopeFactory = $scopeFactory ?: new ScopeFactory();
+    }
+
     /**
      * Create Data.
      *
@@ -86,18 +98,11 @@ class Manager
      */
     public function createData(ResourceInterface $resource, $scopeIdentifier = null, Scope $parentScopeInstance = null)
     {
-        $scopeInstance = new Scope($this, $resource, $scopeIdentifier);
-
-        // Update scope history
         if ($parentScopeInstance !== null) {
-            // This will be the new children list of parents (parents parents, plus the parent)
-            $scopeArray = $parentScopeInstance->getParentScopes();
-            $scopeArray[] = $parentScopeInstance->getScopeIdentifier();
-
-            $scopeInstance->setParentScopes($scopeArray);
+            return $this->scopeFactory->createChildScopeFor($this, $parentScopeInstance, $resource, $scopeIdentifier);
         }
 
-        return $scopeInstance;
+        return $this->scopeFactory->createScopeFor($this, $resource, $scopeIdentifier);
     }
 
     /**

diff --git a/src/ScopeFactory.php b/src/ScopeFactory.php
@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the League\Fractal package.
+ *
+ * (c) Phil Sturgeon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace League\Fractal;
+
+use League\Fractal\Resource\ResourceInterface;
+
+class ScopeFactory implements ScopeFactoryInterface
+{
+    /**
+     * @param Manager $manager
+     * @param ResourceInterface $resource
+     * @param string|null $scopeIdentifier
+     * @return Scope
+     */
+    public function createScopeFor(Manager $manager, ResourceInterface $resource, $scopeIdentifier = null)
+    {
+        return new Scope($manager, $resource, $scopeIdentifier);
+    }
+
+    /**
+     * @param Manager $manager
+     * @param Scope $parentScopeInstance
+     * @param ResourceInterface $resource
+     * @param string|null $scopeIdentifier
+     * @return Scope
+     */
+    public function createChildScopeFor(Manager $manager, Scope $parentScopeInstance, ResourceInterface $resource, $scopeIdentifier = null)
+    {
+        $scopeInstance = $this->createScopeFor($manager, $resource, $scopeIdentifier);
+
+        // This will be the new children list of parents (parents parents, plus the parent)
+        $scopeArray = $parentScopeInstance->getParentScopes();
+        $scopeArray[] = $parentScopeInstance->getScopeIdentifier();
+
+        $scopeInstance->setParentScopes($scopeArray);
+
+        return $scopeInstance;
+    }
+}
diff --git a/src/ScopeFactoryInterface.php b/src/ScopeFactoryInterface.php
@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the League\Fractal package.
+ *
+ * (c) Phil Sturgeon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace League\Fractal;
+
+use League\Fractal\Resource\ResourceInterface;
+
+/**
+ * ScopeFactoryInterface
+ *
+ * Creates Scope Instances for resources
+ */
+interface ScopeFactoryInterface
+{
+    /**
+     * @param Manager $manager
+     * @param ResourceInterface $resource
+     * @param string|null $scopeIdentifier
+     * @return Scope
+     */
+    public function createScopeFor(Manager $manager, ResourceInterface $resource, $scopeIdentifier = null);
+
+    /**
+     * @param Manager $manager
+     * @param Scope $parentScope
+     * @param ResourceInterface $resource
+     * @param string|null $scopeIdentifier
+     * @return Scope
+     */
+    public function createChildScopeFor(Manager $manager, Scope $parentScope, ResourceInterface $resource, $scopeIdentifier = null);
+}
diff --git a/test/ScopeFactoryTest.php b/test/ScopeFactoryTest.php
@@ -0,0 +1,81 @@
+<?php
+
+namespace League\Fractal\Test;
+
+use League\Fractal\Manager;
+use League\Fractal\Resource\ResourceInterface;
+use League\Fractal\Scope;
+use League\Fractal\ScopeFactory;
+
+class ScopeFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    public function testItImplementsScopeFactoryInterface()
+    {
+        $this->assertInstanceOf('League\\Fractal\\ScopeFactoryInterface', $this->createSut());
+    }
+
+    public function testItCreatesScopes()
+    {
+        $sut = $this->createSut();
+
+        $manager = $this->createManager();
+        $resource = $this->createResource();
+        $scopeIdentifier = 'foo_identifier';
+
+        $scope = $sut->createScopeFor($manager, $resource, $scopeIdentifier);
+
+        $this->assertInstanceOf('League\\Fractal\\Scope', $scope);
+        $this->assertSame($resource, $scope->getResource());
+        $this->assertSame($scopeIdentifier, $scope->getScopeIdentifier());
+    }
+
+    public function testItCreatesScopesWithParent()
+    {
+        $manager = $this->createManager();
+
+        $scope = new Scope($manager, $this->createResource(), 'parent_identifier');
+        $scope->setParentScopes([
+            'parent_scope',
+        ]);
+
+        $resource = $this->createResource();
+        $scopeIdentifier = 'foo_identifier';
+
+        $expectedParentScopes = [
+            'parent_scope',
+            'parent_identifier',
+        ];
+
+        $sut = $this->createSut();
+        $scope = $sut->createChildScopeFor($manager, $scope, $resource, $scopeIdentifier);
+
+        $this->assertInstanceOf('League\\Fractal\\Scope', $scope);
+        $this->assertSame($resource, $scope->getResource());
+        $this->assertSame($scopeIdentifier, $scope->getScopeIdentifier());
+        $this->assertEquals($expectedParentScopes, $scope->getParentScopes());
+    }
+
+    /**
+     * @return ScopeFactory
+     */
+    private function createSut()
+    {
+        return new ScopeFactory();
+    }
+
+    /**
+     * @return Manager
+     */
+    private function createManager()
+    {
+        return $this->getMock('League\\Fractal\\Manager');
+    }
+
+    /**
+     * @return ResourceInterface
+     */
+    private function createResource()
+    {
+        return $this->getMock('League\\Fractal\\Resource\\ResourceInterface');
+    }
+}