Merge remote-tracking branch 'refs/remotes/origin/dev'

Brain-WP · Sep 15, 2016 · 780f72c · 780f72c
2 parents af0b0d8 + 7fd9a61
commit 780f72c
Show file tree

Hide file tree

Showing 10 changed files with 200 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -152,8 +152,13 @@ that, as you might have guessed, is used to add providers to the collector.
 In short, when `provide()` method is called, it returns the context from all the providers that
 were added to it.
 
-Tha package ships with a single implementation `WpTemplateContextCollector` that uses `array_merge`
-to build a context array from the arrays "provided" by the added providers that "accept" the given query.
+Tha package ships with a two implementations:
+
+ - `ArrayMergeContextCollector`
+ - `ArrayMergeRecursiveContextCollector`
+
+they are pretty identical, but first uses `array_merge`, the second `array_merge_recursive` to build 
+the context array from the arrays "provided" by the added providers that "accepts" the given query.
 
 # Context Loader
 

diff --git a/examples/hierachy-mustache/example.php b/examples/hierachy-mustache/example.php
@@ -29,12 +29,12 @@
 namespace Brain\Context\Examples\HierarchyMustache;
 
 use Brain\Context\WpContextLoader;
-use Brain\Context\WpTemplateContextCollector;
+use Brain\Context\ArrayMergeContextCollector;
 use Brain\Hierarchy\Finder\SubfolderTemplateFinder;
 use Brain\Hierarchy\QueryTemplate;
 
 // Let's add all our providers, the collector will pull context from them when the query fits.
-add_action('brain.context.providers', function (WpTemplateContextCollector $collector) {
+add_action('brain.context.providers', function (ArrayMergeContextCollector $collector) {
 
     $collector
         ->addProvider(new Providers\HomePageContext())

diff --git a/examples/simple/example.php b/examples/simple/example.php
@@ -26,11 +26,11 @@
 namespace Brain\Context\Examples\Simple;
 
 use Brain\Context\WpContextLoader;
-use Brain\Context\WpTemplateContextCollector;
+use Brain\Context\ArrayMergeContextCollector;
 
 // Let's add all our providers, the collector will pull context from them
 // when the query fits.
-add_action('brain.context.providers', function (WpTemplateContextCollector $collector) {
+add_action('brain.context.providers', function (ArrayMergeContextCollector $collector) {
 
     $collector
         ->addProvider(new HomePageContext())

diff --git a/src/ArrayMergeContextCollector.php b/src/ArrayMergeContextCollector.php
@@ -0,0 +1,47 @@
+<?php # -*- coding: utf-8 -*-
+/*
+ * This file is part of the Context package.
+ *
+ * (c) Giuseppe Mazzapica
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Brain\Context;
+
+/**
+ * @author  Giuseppe Mazzapica <giuseppe.mazzapica@gmail.com>
+ * @package Context
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+final class ArrayMergeContextCollector implements ContextCollectorInterface
+{
+    use ArrayMergeContextCollectorTrait;
+
+    /**
+     * @return array
+     */
+    public function provide()
+    {
+        if (!$this->query instanceof \WP_Query) {
+            return [];
+        }
+
+        $context = [];
+        while (!$this->providers->isEmpty()) {
+            /** @var ContextProviderInterface|UpdatableContextProviderInterface $provider */
+            $provider = $this->providers->dequeue();
+            if (!$provider->accept($this->query)) {
+                continue;
+            }
+
+            $context = array_merge($context, $provider->provide());
+            if ($provider instanceof UpdatableContextProviderInterface) {
+                $context = $provider->update($context);
+            }
+        }
+
+        return $context;
+    }
+}
diff --git a/src/WpTemplateContextCollector.php → src/ArrayMergeContextCollectorTrait.php b/src/WpTemplateContextCollector.php → src/ArrayMergeContextCollectorTrait.php
@@ -15,7 +15,7 @@
  * @package Context
  * @license http://opensource.org/licenses/MIT MIT
  */
-final class WpTemplateContextCollector implements ContextCollectorInterface
+trait ArrayMergeContextCollectorTrait
 {
 
     /**
@@ -39,6 +39,8 @@ public function __construct()
      */
     public function addProvider(ContextProviderInterface $provider)
     {
+        /** @var $this ContextCollectorInterface */
+
         $this->providers->enqueue($provider);
 
         // By using this function it is possible to remove the just-added provider
@@ -58,30 +60,4 @@ public function accept(\WP_Query $query)
 
         return true;
     }
-
-    /**
-     * @return array
-     */
-    public function provide()
-    {
-        if (!$this->query instanceof \WP_Query) {
-            return [];
-        }
-
-        $context = [];
-        while (!$this->providers->isEmpty()) {
-            /** @var ContextProviderInterface|UpdatableContextProviderInterface $provider */
-            $provider = $this->providers->dequeue();
-            if (!$provider->accept($this->query)) {
-                continue;
-            }
-
-            $context = array_merge($context, $provider->provide());
-            if ($provider instanceof UpdatableContextProviderInterface) {
-                $context = $provider->update($context);
-            }
-        }
-
-        return $context;
-    }
 }
diff --git a/src/ArrayMergeRecursiveContextCollector.php b/src/ArrayMergeRecursiveContextCollector.php
@@ -0,0 +1,48 @@
+<?php # -*- coding: utf-8 -*-
+/*
+ * This file is part of the Context package.
+ *
+ * (c) Giuseppe Mazzapica
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Brain\Context;
+
+/**
+ * @author  Giuseppe Mazzapica <giuseppe.mazzapica@gmail.com>
+ * @package Context
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+final class ArrayMergeRecursiveContextCollector implements ContextCollectorInterface
+{
+
+    use ArrayMergeContextCollectorTrait;
+
+    /**
+     * @return array
+     */
+    public function provide()
+    {
+        if (!$this->query instanceof \WP_Query) {
+            return [];
+        }
+
+        $context = [];
+        while (!$this->providers->isEmpty()) {
+            /** @var ContextProviderInterface|UpdatableContextProviderInterface $provider */
+            $provider = $this->providers->dequeue();
+            if (!$provider->accept($this->query)) {
+                continue;
+            }
+
+            $context = array_merge_recursive($context, $provider->provide());
+            if ($provider instanceof UpdatableContextProviderInterface) {
+                $context = $provider->update($context);
+            }
+        }
+
+        return $context;
+    }
+}
diff --git a/src/WpContextLoader.php b/src/WpContextLoader.php
@@ -27,12 +27,16 @@ class WpContextLoader
      * to collector using `brain.context.providers` hook.
      *
      * @param \WP_Query $query
+     * @param ContextCollectorInterface $collector
      * @return array
      */
-    public static function load(\WP_Query $query)
+    public static function load(\WP_Query $query, ContextCollectorInterface $collector = null)
     {
-        $collector = new WpTemplateContextCollector();
-        $collector->accept($query);
+        $collector or $collector = new ArrayMergeContextCollector();
+
+        if (!$collector->accept($query)) {
+            return [];
+        }
 
         // Use this hook to add context provider calling `addProvider()` method on the
         // passed collector object

diff --git a/tests/src/WpTemplateContextCollectorTest.php → tests/src/ArrayMergeContextCollectorTest.php b/tests/src/WpTemplateContextCollectorTest.php → tests/src/ArrayMergeContextCollectorTest.php
@@ -12,20 +12,20 @@
 
 use Andrew\Proxy;
 use Brain\Context\ContextProviderInterface;
-use Brain\Context\WpTemplateContextCollector;
+use Brain\Context\ArrayMergeContextCollector;
 use Brain\Monkey\WP\Actions;
 
 /**
  * @author  Giuseppe Mazzapica <giuseppe.mazzapica@gmail.com>
  * @package Context
  * @license http://opensource.org/licenses/MIT MIT
  */
-class WpTemplateContextCollectorTest extends TestCase
+class ArrayMergeContextCollectorTest extends TestCase
 {
 
     public function testAddProvider()
     {
-        $collector = new WpTemplateContextCollector();
+        $collector = new ArrayMergeContextCollector();
 
         $context_a = \Mockery::mock(ContextProviderInterface::class);
         $context_b = clone $context_a;
@@ -60,7 +60,7 @@ public function testAddProvider()
 
     public function testAccept()
     {
-        $collector = new WpTemplateContextCollector();
+        $collector = new ArrayMergeContextCollector();
 
         $query = \Mockery::mock('WP_Query');
         $accepted = $collector->accept($query);
@@ -75,7 +75,7 @@ public function testAccept()
 
     public function testProvideDoNothingWithNoQuery()
     {
-        $collector = new WpTemplateContextCollector();
+        $collector = new ArrayMergeContextCollector();
 
         $query = \Mockery::mock('WP_Query');
 
@@ -102,7 +102,7 @@ public function testProvideDoNothingWithNoQuery()
 
     public function testProvide()
     {
-        $collector = new WpTemplateContextCollector();
+        $collector = new ArrayMergeContextCollector();
 
         $query = \Mockery::mock('WP_Query');
 

diff --git a/tests/src/ArrayMergeRecursiveContextCollectorTest.php b/tests/src/ArrayMergeRecursiveContextCollectorTest.php
@@ -0,0 +1,76 @@
+<?php # -*- coding: utf-8 -*-
+/*
+ * This file is part of the Context package.
+ *
+ * (c) Giuseppe Mazzapica
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Brain\Context\Tests;
+
+use Brain\Context\ArrayMergeRecursiveContextCollector;
+use Brain\Context\ContextProviderInterface;
+use Brain\Context\ArrayMergeContextCollector;
+use Brain\Monkey\WP\Actions;
+
+/**
+ * @author  Giuseppe Mazzapica <giuseppe.mazzapica@gmail.com>
+ * @package Context
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+class ArrayMergeRecursiveContextCollectorTest extends TestCase
+{
+
+    public function testProvide()
+    {
+        $collector = new ArrayMergeRecursiveContextCollector();
+
+        $query = \Mockery::mock('WP_Query');
+
+        $context_a = \Mockery::mock(ContextProviderInterface::class);
+        $context_b = clone $context_a;
+        $context_c = clone $context_b;
+
+        $context_a->shouldReceive('accept')->once()->with($query)->andReturn(true);
+        $context_b->shouldReceive('accept')->once()->with($query)->andReturn(false);
+        $context_c->shouldReceive('accept')->once()->with($query)->andReturn(true);
+
+        $context_a->shouldReceive('provide')->once()->andReturn([
+            'message' => 'Hello from A!',
+            'letters' => ['a']
+        ]);
+
+        $context_b->shouldReceive('provide')->once()->andReturn([
+            'message' => 'Goodbye from B!',
+            'meh'     => 'meh'
+        ]);
+
+        $context_c->shouldReceive('provide')->once()->andReturn([
+            'message' => 'Hello from C!',
+            'letters' => ['b', 'c', 'd'],
+            'color'   => 'yellow'
+        ]);
+
+        Actions::expectFired('brain.context.added')
+            ->times(3)
+            ->with(\Mockery::type(ContextProviderInterface::class), \Mockery::type('SplQueue'));
+
+        $collector
+            ->addProvider($context_a)
+            ->addProvider($context_b)
+            ->addProvider($context_c);
+
+        $collector->accept($query);
+
+        $expected = [
+            'message' => ['Hello from A!', 'Hello from C!'],
+            'letters' => ['a', 'b', 'c', 'd'],
+            'color'   => 'yellow'
+        ];
+
+        assertSame($expected, $collector->provide());
+    }
+
+}
diff --git a/tests/src/WpContextLoaderTest.php b/tests/src/WpContextLoaderTest.php
@@ -13,7 +13,7 @@
 use Brain\Context\ContextProviderInterface;
 use Brain\Context\UpdatableContextProviderInterface;
 use Brain\Context\WpContextLoader;
-use Brain\Context\WpTemplateContextCollector;
+use Brain\Context\ArrayMergeContextCollector;
 use Brain\Monkey\WP\Actions;
 use Brain\Monkey\WP\Filters;
 
@@ -121,7 +121,7 @@ public function testLoad()
         Actions::expectFired('brain.context.providers')
             ->once()
             ->whenHappen(
-                function (WpTemplateContextCollector $C) use ($archive, $page, $singular, $post) {
+                function (ArrayMergeContextCollector $C) use ($archive, $page, $singular, $post) {
                     $C
                         ->addProvider($archive)
                         ->addProvider($page)