Added dispatcher, cmd. exceptions handled by it

Author: dantleech

spec/PHPCR/Shell/Console/Application/ShellApplicationSpec.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace spec\PHPCR\Shell\Console\Application;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class ShellApplicationSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('PHPCR\Shell\Console\Application\ShellApplication');
+    }
+}

spec/PHPCR/Shell/Event/CommandExceptionEventSpec.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace spec\PHPCR\Shell\Event;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class CommandExceptionEventSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('PHPCR\Shell\Event\CommandExceptionEvent');
+    }
+
+    function let(
+        \Exception $exception,
+        OutputInterface $output
+    ) {
+        $this->beConstructedWith($exception, $output);
+    }
+
+    function it_should_provide_access_to_event_parameters(
+        \Exception $exception,
+        OutputInterface $output
+    ) {
+        $this->getException()->shouldReturn($exception);
+        $this->getOutput()->shouldReturn($output);
+    }
+}

spec/PHPCR/Shell/Listener/ExceptionListenerSpec.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace spec\PHPCR\Shell\Listener;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Symfony\Component\Console\Output\OutputInterface;
+use PHPCR\Shell\Event\CommandExceptionEvent;
+
+class ExceptionListenerSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('PHPCR\Shell\Listener\ExceptionListener');
+    }
+
+    function it_should_output_exception_message_to_console(
+        CommandExceptionEvent $event,
+        OutputInterface $output
+    ) {
+        $exception = new \Exception('This is an exception');
+        $event->getException()->willReturn($exception);
+        $event->getOutput()->willReturn($output);
+
+       $output->writeln('<error>[Exception] This is an exception</error>')->shouldBeCalled();
+
+        $this->handleException($event);
+    }
+}

src/PHPCR/Shell/Console/Application/ShellApplication.php

@@ -25,7 +25,12 @@
 use PHPCR\Shell\Console\Helper\RepositoryHelper;
 use PHPCR\Shell\Console\Helper\ResultFormatterHelper;
 use PHPCR\Shell\Console\Helper\TextHelper;
+
+use PHPCR\Shell\Subscriber;
+use PHPCR\Shell\Event;
 use PHPCR\Shell\PhpcrSession;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use PHPCR\Shell\Event\PhpcrShellEvents;
 
 /**
  * Main application for PHPCRSH
@@ -54,6 +59,14 @@ class ShellApplication extends Application
      */
     private $session;
 
+    public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN')
+    {
+        parent::__construct($name, $verpion);
+
+        $this->dispatcher = new EventDispatcher();
+    }
+
+
     /**
      * The SessionInput is the input used to intialize the shell.
      * It contains the connection parameters.
@@ -84,6 +97,7 @@ public function init()
         $this->initSession();
         $this->registerHelpers();
         $this->registerCommands();
+        $this->registerEventListeners();
 
         $this->initialized = true;
     }
@@ -207,6 +221,11 @@ private function registerCommands()
         $this->add(new CommandShell\ExitCommand());
     }
 
+    private function registerEventListeners()
+    {
+        $this->dispatcher->addSubscriber(new Subscriber\ExceptionSubscriber());
+    }
+
     /**
      * Initialize the PHPCR session
      */
@@ -231,6 +250,8 @@ private function initSession()
     /**
      * Change the current workspace
      *
+     * @todo: Move to session helper?
+     *
      * @param string $workspaceName
      */
     public function changeWorkspace($workspaceName)
@@ -243,6 +264,8 @@ public function changeWorkspace($workspaceName)
     /**
      * Login (again)
      *
+     * @todo: Move to session helper
+     *
      * @param string $username
      * @param string $password
      * @param string $workspaceName
@@ -264,7 +287,7 @@ public function relogin($username, $password, $workspaceName = null)
      */
     private function getTransport()
     {
-        $transportName = $sessionInput->getOption('transport');
+        $transportName = $this->sessionInput->getOption('transport');
 
         if (!isset($this->transports[$transportName])) {
             throw new \InvalidArgumentException(sprintf(
@@ -321,31 +344,24 @@ public function doRun(InputInterface $input, OutputInterface $output)
         try {
             $exitCode = parent::doRun($input, $output);
         } catch (\Exception $e) {
-            if (!$e->getMessage()) {
-                if ($e instanceof \PHPCR\UnsupportedRepositoryOperationException) {
-                    throw new \Exception('Unsupported repository operation');
-                }
-            }
-
-            // todo: Handle this with event listener
-            if ($e instanceof NotImplementedException) {
-                throw new \Exception('Not implemented: ' . $e->getMessage());
-            }
-
-            $output->writeln('<error>(' . get_class($e) .') ' . $e->getMessage() . '</error>');
+            $this->dispatcher->dispatch(PhpcrShellEvents::COMMAND_EXCEPTION, new Event\CommandExceptionEvent($e, $output));
             return 1;
         }
 
         return $exitCode;
     }
 
     /**
+     * {@inheritDoc}
+     *
      * Render an exception to the console
      *
+     * @access public
+     *
      * @param \Exception $e $exception
      * @param OutputInterface $output
      */
-    protected function renderException(\Exception $exception, OutputInterface $output)
+    public function renderException(\Exception $exception, OutputInterface $output)
     {
         $output->writeln(sprintf('<exception>%s</exception', $exception->getMessage()));
     }

src/PHPCR/Shell/Event/CommandExceptionEvent.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace PHPCR\Shell\Event;
+
+use PHPCR\UnsupportedRepositoryOperationException;
+use Jackalope\NotImplementedException;
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class CommandExceptionEvent extends Event
+{
+    protected $exception;
+    protected $output;
+
+    public function __construct(\Exception $exception, OutputInterface $output)
+    {
+        $this->exception = $exception;
+        $this->output = $output;
+    }
+
+    public function getException() 
+    {
+        return $this->exception;
+    }
+
+    public function getOutput() 
+    {
+        return $this->output;
+    }
+}

src/PHPCR/Shell/Event/PhpcrShellEvents.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace PHPCR\Shell\Event;
+
+class PhpcrShellEvents
+{
+    const COMMAND_EXCEPTION = 'command_exception';
+}

src/PHPCR/Shell/Subscriber/ExceptionSubscriber.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace PHPCR\Shell\Subscriber;
+
+use Jackalope\NotImplementedException;
+use PHPCR\Shell\Event\CommandExceptionEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use PHPCR\Shell\Event\PhpcrShellEvents;
+
+/**
+ * Try and better handle exceptions
+ *
+ * @author Daniel Leech <daniel@dantleech.com>
+ */
+class ExceptionSubscriber implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents()
+    {
+        return array(
+            PhpcrShellEvents::COMMAND_EXCEPTION => 'handleException',
+        );
+    }
+
+    public function handleException(CommandExceptionEvent $event)
+    {
+        $exception = $event->getException();
+        $output = $event->getOutput();
+
+        if ($exception instanceof NotImplementedException) {
+            $output->writeln('<error>Not implemented: ' . $exception->getMessage() . '</error>');
+        }
+
+        $output->writeln('<error>[' . get_class($exception) .'] ' . $exception->getMessage() . '</error>');
+    }
+}