[WIP] common collaborators

features/bootstrap/PhpSpecContext.php

@@ -22,7 +22,7 @@ public function createWorkDir()
         // paths between scenarios.
         $this->workDir = sys_get_temp_dir().'/PhpSpecSymfony2Extension/';
 
-        mkdir($this->workDir, 0777, true);
+        @mkdir($this->workDir, 0777, true);
         chdir($this->workDir);
     }
 
@@ -39,12 +39,19 @@ public function removeWorkDir()
      */
     public function theSymfonyExtendsionIsEnabled()
     {
-        $phpspecyml = <<<YML
+        $yml = <<<YML
 extensions:
-  - PhpSpec\Symfony2Extension\Extension
+    - PhpSpec\Symfony2Extension\Extension
 YML;
+        file_put_contents($this->workDir.'phpspec.yml', $yml);
+    }
 
-        file_put_contents($this->workDir.'phpspec.yml', $phpspecyml);
+    /**
+     * @Given /^(?:|the )Symfony extension is enabled with:$/
+     */
+    public function theSymfonyExtendsionIsEnabledWith(PyStringNode $yml = null)
+    {
+        file_put_contents($this->workDir.'phpspec.yml', $yml);
     }
 
     /**
@@ -83,7 +90,7 @@ public function iDescribeThe($class)
      */
     public function iWroteSpecInThe($file, PyStringNode $string)
     {
-        mkdir(dirname($file), 0777, true);
+        @mkdir(dirname($file), 0777, true);
 
         file_put_contents($file, $string->getRaw());
 

features/describing_a_controller.feature

@@ -14,10 +14,10 @@ Feature: Describing a controller
 
     namespace Scenario1\Bundle\DemoBundle\Spec\Controller;
 
-    use PhpSpec\Symfony2Extension\Specification\ControllerBehavior;
+    use PhpSpec\ObjectBehavior;
     use Prophecy\Argument;
 
-    class UserControllerSpec extends ControllerBehavior
+    class UserControllerSpec extends ObjectBehavior
     {
         function it_is_container_aware()
         {
@@ -52,10 +52,10 @@ Feature: Describing a controller
 
     namespace Scenario5\Bundle\DemoBundle\Spec\Controller;
 
-    use PhpSpec\Symfony2Extension\Specification\ControllerBehavior;
+    use PhpSpec\ObjectBehavior;
     use Prophecy\Argument;
 
-    class UserControllerSpec extends ControllerBehavior
+    class UserControllerSpec extends ObjectBehavior
     {
         function it_should_respond_to_the_list_action_call()
         {
@@ -94,15 +94,17 @@ Feature: Describing a controller
 
     namespace Scenario6\Bundle\DemoBundle\Spec\Controller;
 
-    use PhpSpec\Symfony2Extension\Specification\ControllerBehavior;
+    use PhpSpec\ObjectBehavior;
     use Prophecy\Argument;
     use Symfony\Component\Routing\Router;
+    use Symfony\Component\DependencyInjection\ContainerInterface;
 
-    class UserControllerSpec extends ControllerBehavior
+    class UserControllerSpec extends ObjectBehavior
     {
-        function it_should_redirect_to_the_homepage(Router $router)
+        function it_should_redirect_to_the_homepage(Router $router, ContainerInterface $container)
         {
-            $this->container->set('router', $router);
+            $this->setContainer($container);
+            $container->get('router')->willReturn($router);
 
             $router->generate('homepage')->willReturn('/');
 
@@ -144,15 +146,17 @@ Feature: Describing a controller
 
     namespace Scenario7\Bundle\DemoBundle\Spec\Controller;
 
-    use PhpSpec\Symfony2Extension\Specification\ControllerBehavior;
+    use PhpSpec\ObjectBehavior;
     use Prophecy\Argument;
     use Symfony\Component\Templating\EngineInterface;
+    use Symfony\Component\DependencyInjection\ContainerInterface;
 
-    class UserControllerSpec extends ControllerBehavior
+    class UserControllerSpec extends ObjectBehavior
     {
-        function it_should_render_list_of_users(EngineInterface $templating)
+        function it_should_render_list_of_users(EngineInterface $templating, ContainerInterface $container)
         {
-            $this->container->set('templating', $templating);
+            $this->setContainer($container);
+            $container->get('templating')->willReturn($templating);
 
             $this->shouldRender('Scenario7UserBundle:User:list.html.twig', array('users' => array()))
                 ->duringAction('list');

features/initialize_default_collaborators.feature

@@ -0,0 +1,55 @@
+Feature: Initialize default collaborators
+  As a Developer
+  I want default collaborators to be preconfigured
+  In order to avoid complex let methods
+
+  Background:
+    Given the Symfony extension is enabled with:
+        """
+        extensions:
+            - PhpSpec\Symfony2Extension\Extension
+
+        symfony2_extension.common-collaborators:
+            container: { service_container: ~ }
+            router: ~
+            templating: ~
+            request: ~
+            session: ~
+            doctrine: ~
+        """
+
+  Scenario: Controller spec has access to common collaborators
+    Given I wrote a spec in the "src/Scenario8/Bundle/DemoBundle/Spec/Controller/UserControllerSpec.php":
+    """
+    <?php
+
+    namespace Scenario8\Bundle\DemoBundle\Spec\Controller;
+
+    use PhpSpec\ObjectBehavior;
+    use Prophecy\Argument;
+
+    class UserControllerSpec extends ObjectBehavior
+    {
+        function its_generateUrl_generates_urls($container)
+        {
+            $this->setContainer($container);
+            $this->generateUrl('homepage')->shouldReturn('homepage'); // preconfigured router!
+        }
+    }
+
+    """
+    And I wrote a class in the "src/Scenario8/Bundle/DemoBundle/Controller/UserController.php":
+    """
+    <?php
+
+    namespace Scenario8\Bundle\DemoBundle\Controller;
+
+    use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+    class UserController extends Controller
+    {
+    }
+
+    """
+    When I run phpspec
+    Then I should see "1 example (1 passed)"

features/provide_default_collaborators.feature

@@ -0,0 +1,51 @@
+Feature: Provide default collaborators
+  As a Developer
+  I want to avoid configuring framework mocks every time by hand
+  In order to have a working preconfigured set of mocks
+
+  Background:
+    Given the Symfony extension is enabled with:
+        """
+        extensions:
+            - PhpSpec\Symfony2Extension\Extension
+
+        symfony2_extension.common-collaborators:
+            container: { service_container: ~ }
+            router: Symfony\Component\Routing\RouterInterface
+        """
+
+  Scenario: Controller spec has access to common collaborators
+    Given I wrote a spec in the "src/Scenario7/Bundle/DemoBundle/Spec/Controller/UserControllerSpec.php":
+    """
+    <?php
+
+    namespace Scenario7\Bundle\DemoBundle\Spec\Controller;
+
+    use PhpSpec\ObjectBehavior;
+    use Prophecy\Argument;
+
+    class UserControllerSpec extends ObjectBehavior
+    {
+        function its_generateUrl_generates_urls($container)
+        {
+            $this->setContainer($container);
+            $this->generateUrl('homepage')->shouldReturn('homepage');
+        }
+    }
+
+    """
+    And I wrote a class in the "src/Scenario7/Bundle/DemoBundle/Controller/UserController.php":
+    """
+    <?php
+
+    namespace Scenario7\Bundle\DemoBundle\Controller;
+
+    use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+    class UserController extends Controller
+    {
+    }
+
+    """
+    When I run phpspec
+    Then I should see "1 example (1 passed)"

phpspec.yml

@@ -0,0 +1,14 @@
+extensions:
+    - PhpSpec\Symfony2Extension\Extension
+
+symfony2_extension.common-collaborators:
+    # append: false # should we support append ? (ie: provide defaults)
+    container: { service_container: ~ }
+    router: ~
+    templating: ~
+    request: ~
+    session: ~
+    doctrine: ~
+    em: ~
+    repository: ~
+    #formFactory: { form.factory: FormFactoryInterface }

spec/PhpSpec/Symfony2Extension/ExtensionSpec.php

@@ -7,6 +7,9 @@
 use PhpSpec\ObjectBehavior;
 use PhpSpec\ServiceContainer;
 use Prophecy\Argument;
+use PhpSpec\Wrapper\Unwrapper;
+use PhpSpec\Symfony2Extension\Runner\Collaborator\FactoryInterface;
+use PhpSpec\Symfony2Extension\Runner\Collaborator\InitializerFactory;
 
 class ExtensionSpec extends ObjectBehavior
 {
@@ -16,6 +19,9 @@ function let(ServiceContainer $container)
     {
         $container->setShared(Argument::cetera())->willReturn();
         $container->addConfigurator(Argument::any())->willReturn();
+        $container->getByPrefix(Argument::any())->willReturn(array());
+        $container->setParam(Argument::cetera())->willReturn();
+        $container->getParam(Argument::cetera())->willReturn();
     }
 
     function it_is_a_phpspec_extension()
@@ -45,18 +51,29 @@ function it_registers_a_custom_locator_with_configuration(ServiceContainer $cont
         $configurator($container->getWrappedObject());
     }
 
-    function it_registers_runner_maintainers_for_the_container(ServiceContainer $container)
+    function it_registers_runner_maintainers_for_the_container(ServiceContainer $container, Unwrapper $unwrapper, FactoryInterface $defaultFactory, InitializerFactory $factory)
     {
         $container->setShared(
-            'runner.maintainers.container_initializer',
-            $this->service('PhpSpec\Symfony2Extension\Runner\Maintainer\ContainerInitializerMaintainer', $container)
+            'runner.maintainers.common_collaborators',
+            $this->service('PhpSpec\Symfony2Extension\Runner\Maintainer\CommonCollaboratorsMaintainer', $container)
         )->shouldBeCalled();
 
         $container->setShared(
-            'runner.maintainers.container_injector',
-            $this->service('PhpSpec\Symfony2Extension\Runner\Maintainer\ContainerInjectorMaintainer', $container)
+            'collaborator_factory.default',
+            $this->service('PhpSpec\Symfony2Extension\Runner\Collaborator\DefaultFactory', $container)
         )->shouldBeCalled();
 
+        $container->setShared(
+            'collaborator_factory',
+            $this->service('PhpSpec\Symfony2Extension\Runner\Collaborator\InitializerFactory', $container)
+        )->shouldBeCalled();
+
+        $container->getByPrefix('collaborator.initializers')->willReturn(array());
+        $container->getParam('symfony2_extension.common-collaborators', array())->willReturn(array());
+        $container->get('collaborator_factory')->willReturn($factory);
+        $container->get('collaborator_factory.default')->willReturn($defaultFactory);
+        $container->get('unwrapper')->willReturn($unwrapper);
+
         $this->load($container);
     }
 

spec/PhpSpec/Symfony2Extension/Runner/Collaborator/DefaultFactorySpec.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace spec\PhpSpec\Symfony2Extension\Runner\Collaborator;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use PhpSpec\Wrapper\Unwrapper;
+use Prophecy\Prophecy\ObjectProphecy;
+use PhpSpec\Runner\CollaboratorManager;
+
+class DefaultFactorySpec extends ObjectBehavior
+{
+    function let(Unwrapper $unwrapper)
+    {
+        $this->beConstructedWith($unwrapper);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('PhpSpec\Symfony2Extension\Runner\Collaborator\DefaultFactory');
+    }
+
+    function its_create_should_create_collaborators(CollaboratorManager $collaborators, ObjectProphecy $prophecy)
+    {
+        $this->create($collaborators, $prophecy, 'router', 'Symfony\Component\Routing\RouterInterface')->shouldHaveType('PhpSpec\Wrapper\Collaborator');
+    }
+}

spec/PhpSpec/Symfony2Extension/Runner/Collaborator/InitializerFactorySpec.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace spec\PhpSpec\Symfony2Extension\Runner\Collaborator;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use PhpSpec\Symfony2Extension\Runner\Collaborator\FactoryInterface;
+use Prophecy\Prophecy\ObjectProphecy;
+use PhpSpec\Symfony2Extension\Runner\Collaborator\InitializerInterface;
+use PhpSpec\Wrapper\Collaborator;
+use PhpSpec\Runner\CollaboratorManager;
+
+class InitializerFactorySpec extends ObjectBehavior
+{
+    private $closure;
+
+    function let(FactoryInterface $factory, Collaborator $collaborator, InitializerInterface $initializer)
+    {
+        $this->beConstructedWith($factory, array(
+            $initializer,
+        ));
+        $factory->create(Argument::cetera())->willReturn($collaborator);
+    }
+
+    function its_create_should_initialize_known_collaborators(CollaboratorManager $collaborators, ObjectProphecy $prophecy, $collaborator, $initializer)
+    {
+        $initializer->supports('router')->willReturn(true);
+        $initializer->initialize(Argument::cetera())->shouldBeCalled();
+        $this->create($collaborators, $prophecy, 'router');
+    }
+
+    function its_create_should_not_initialize_unknown_collaborators(CollaboratorManager $collaborators, ObjectProphecy $prophecy, $collaborator, $initializer)
+    {
+        $initializer->supports('request')->willReturn(false);
+        $initializer->initialize(Argument::cetera())->shouldNotBeCalled();
+        $this->create($collaborators, $prophecy, 'request');
+    }
+}

spec/PhpSpec/Symfony2Extension/Runner/Maintainer/CommonCollaboratorsMaintainerSpec.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace spec\PhpSpec\Symfony2Extension\Runner\Maintainer;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use PhpSpec\Wrapper\Unwrapper;
+use PhpSpec\Symfony2Extension\Runner\Collaborator\InitializerFactory;
+
+class CommonCollaboratorsMaintainerSpec extends ObjectBehavior
+{
+    public function let(Unwrapper $unwrapper, InitializerFactory $factory)
+    {
+        $this->beConstructedWith($unwrapper, $factory, array());
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('PhpSpec\Symfony2Extension\Runner\Maintainer\CommonCollaboratorsMaintainer');
+    }
+}