properly use the cli helper

cli-config.php.dist

@@ -1,6 +1,11 @@
 <?php
 
-// adjust as needed
+/**
+ * This is a sample bootstrap file for the console. All jackalope variants
+ * provide their own bootstrap file. This file is only relevant for people
+ * implementing PHPCR and using the phpcr-utils.
+ */
+
 $path_to_jackalope = __DIR__.'/../jackalope';
 
 // $autoload was created in the autoload that is included before this.
@@ -12,12 +17,19 @@ $workspace = 'default';
 $user = 'admin';
 $pass = 'admin';
 
-/* bootstrapping the repository implementation. for jackalope with jackrabbit, do this: */
-$factory = new \Jackalope\RepositoryFactoryJackrabbit;
-$repository = $factory->getRepository(array("jackalope.jackrabbit_uri" => $jackrabbit_url));
-$credentials = new \PHPCR\SimpleCredentials($user, $pass);
-$session = $repository->login($credentials, $workspace);
+if (isset($argv[1])
+    && $argv[1] != 'list'
+    && $argv[1] != 'help'
+) {
+    /* bootstrapping the repository implementation. for jackalope with jackrabbit, do this: */
+    $factory = new \Jackalope\RepositoryFactoryJackrabbit;
+    $repository = $factory->getRepository(array("jackalope.jackrabbit_uri" => $jackrabbit_url));
+    $credentials = new \PHPCR\SimpleCredentials($user, $pass);
+    $session = $repository->login($credentials, $workspace);
 
-$helperSet = new \Symfony\Component\Console\Helper\HelperSet(array(
-    'session' => new \PHPCR\Util\Console\Helper\PhpcrHelper($session)
-));
+    $helperSet = new \Symfony\Component\Console\Helper\HelperSet(array(
+        'dialog' => new \Symfony\Component\Console\Helper\DialogHelper(),
+        'phpcr' => new \PHPCR\Util\Console\Helper\PhpcrHelper($session),
+        'phpcr_console_dumper' => new \PHPCR\Util\Console\Helper\PhpcrConsoleDumperHelper(),
+    ));
+}

composer.json

@@ -38,7 +38,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0-dev"
+            "dev-master": "1.1-dev"
         }
     }
 }

src/PHPCR/Util/CND/Parser/CndParser.php

@@ -31,7 +31,7 @@
  * @license http://opensource.org/licenses/MIT MIT License
  *
  * @author Daniel Barsotti <[email protected]>
- * @author David Buchmann <david@liip.ch>
+ * @author David Buchmann <mail@davidbu.ch>
  */
 class CndParser extends AbstractParser
 {

src/PHPCR/Util/CND/Writer/CndWriter.php

@@ -23,7 +23,7 @@
  * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
  * @license http://opensource.org/licenses/MIT MIT License
  *
- * @author David Buchmann <david@liip.ch>
+ * @author David Buchmann <mail@davidbu.ch>
  */
 class CndWriter
 {

src/PHPCR/Util/Console/Command/BaseCommand.php

@@ -2,10 +2,13 @@
 
 namespace PHPCR\Util\Console\Command;
 
-use PHPCR\SessionInterface;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
-use PHPCR\Util\Console\Helper\PhpcrCliHelper;
+use Symfony\Component\Console\Output\OutputInterface;
+
+use PHPCR\SessionInterface;
+use PHPCR\Util\Console\Helper\PhpcrHelper;
 use PHPCR\Util\Console\Helper\PhpcrConsoleDumperHelper;
 
 /**
@@ -24,67 +27,22 @@ abstract class BaseCommand extends Command
      */
     protected function getPhpcrSession()
     {
-        return $this->getHelper('phpcr')->getSession();
+        return $this->getPhpcrHelper()->getSession();
     }
 
     /**
-     * @return PhpcrCliHelper
+     * @return PhpcrHelper
      */
-    protected function getPhpcrCliHelper()
+    protected function getPhpcrHelper()
     {
-        if (!$this->phpcrCliHelper) {
-            $this->phpcrCliHelper = new PhpcrCliHelper($this->getPhpcrSession());
-        }
-
-        return $this->phpcrCliHelper;
+        return $this->getHelperSet()->get('phpcr');
     }
 
     /**
      * @return PhpcrConsoleDumperHelper
      */
     protected function getPhpcrConsoleDumperHelper()
     {
-        if (!$this->phpcrConsoleDumperHelper) {
-            $this->phpcrConsoleDumperHelper = new PhpcrConsoleDumperHelper();
-        }
-
-        return $this->phpcrConsoleDumperHelper;
-    }
-
-    public function setPhpcrConsoleDumperHelper($consoleDumperHelper)
-    {
-        $this->phpcrConsoleDumperHelper = $consoleDumperHelper;
-    }
-
-    /**
-     * Hack to enable overriding for unit tests.
-     */
-    public function setPhpcrCliHelper(PhpcrCliHelper $helper)
-    {
-        $this->phpcrCliHelper = $helper;
-    }
-
-    public function configureNodeManipulationInput()
-    {
-        $this->addOption('set-prop', 'p',
-            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-            'Set node property on nodes use foo=bar'
-        );
-        $this->addOption('remove-prop', 'r',
-            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-            'Remove property from nodes'
-        );
-        $this->addOption('add-mixin', null,
-            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-            'Add a mixin to the nodes'
-        );
-        $this->addOption('remove-mixin', null,
-            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-            'Remove mixin from the nodes'
-        );
-        $this->addOption('apply-closure', null,
-            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-            'Apply a closure to each node, closures are passed PHPCR\Session and PHPCR\NodeInterface'
-        );
+        return $this->getHelperSet()->get('phpcr_console_dumper');
     }
 }

src/PHPCR/Util/Console/Command/BaseNodeManipulationCommand.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace PHPCR\Util\Console\Command;
+
+use Symfony\Component\Console\Input\InputOption;
+
+/**
+ * Base command for node manipulations, providing common setup.
+ *
+ * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
+ * @license http://opensource.org/licenses/MIT MIT License
+ */
+abstract class BaseNodeManipulationCommand extends BaseCommand
+{
+    /**
+     * Set up the options to manipulate nodes.
+     */
+    protected function configureNodeManipulationInput()
+    {
+        $this->addOption('set-prop', 'p',
+            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+            'Set node property on nodes use foo=bar'
+        );
+        $this->addOption('remove-prop', 'r',
+            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+            'Remove property from nodes'
+        );
+        $this->addOption('add-mixin', null,
+            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+            'Add a mixin to the nodes'
+        );
+        $this->addOption('remove-mixin', null,
+            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+            'Remove mixin from the nodes'
+        );
+        $this->addOption('apply-closure', null,
+            InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+            'Apply a closure to each node, closures are passed PHPCR\Session and PHPCR\NodeInterface'
+        );
+    }
+}

src/PHPCR/Util/Console/Command/NodeMoveCommand.php

@@ -15,7 +15,7 @@
  *
  * @author Daniel Leech <[email protected]>
  */
-class NodeMoveCommand extends Command
+class NodeMoveCommand extends BaseCommand
 {
     /**
      * {@inheritDoc}
@@ -45,7 +45,7 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $session = $this->getHelper('phpcr')->getSession();
+        $session = $this->getPhpcrSession();
 
         $sourcePath = $input->getArgument('source');
         $destPath = $input->getArgument('destination');
@@ -57,6 +57,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $session->move($sourcePath, $destPath);
         $session->save();
+
+        return 0;
     }
 
 }

src/PHPCR/Util/Console/Command/NodeRemoveCommand.php

@@ -21,7 +21,7 @@
  * @author Daniel Barsotti <[email protected]>
  * @author Daniel Leech <[email protected]>
  */
-class NodeRemoveCommand extends Command
+class NodeRemoveCommand extends BaseCommand
 {
     /**
      * {@inheritDoc}
@@ -57,8 +57,7 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        /** @var $session SessionInterface*/
-        $session = $this->getHelper('phpcr')->getSession();
+        $session = $this->getPhpcrSession();
 
         $path = $input->getArgument('path');
         $force = $input->getOption('force');
@@ -74,7 +73,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         if (!$force) {
-            $dialog = new DialogHelper();
+            /** @var $dialog DialogHelper */
+            $dialog = $this->getHelperSet()->get('dialog');
             $workspaceName = $session->getWorkspace()->getName();
 
             if ($onlyChildren) {

src/PHPCR/Util/Console/Command/NodeTouchCommand.php

@@ -19,7 +19,7 @@
  *
  * @author Daniel Leech <[email protected]>
  */
-class NodeTouchCommand extends BaseCommand
+class NodeTouchCommand extends BaseNodeManipulationCommand
 {
     /**
      * {@inheritDoc}
@@ -71,7 +71,7 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $helper = $this->getPhpcrCliHelper();
+        $helper = $this->getPhpcrHelper();
         $session = $this->getPhpcrSession();
 
         $path = $input->getArgument('path');
@@ -98,13 +98,14 @@ protected function execute(InputInterface $input, OutputInterface $output)
             ));
 
             if ($nodeType != $type) {
-                throw new \Exception(sprintf(
-                    'You have specified node type "%s" but the existing node is of type "%s"',
+                $output->writeln(sprintf(
+                    '<error>You have specified node type "%s" but the existing node is of type "%s"</error>',
                     $type, $nodeType
                 ));
+
+                return 1;
             }
         } else {
-
             $nodeName = PathHelper::getNodeName($path);
             $parentPath = PathHelper::getParentPath($path);
 
@@ -116,7 +117,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                     $parentPath
                 ));
 
-                return;
+                return 2;
             }
 
             $output->writeln(sprintf(
@@ -135,5 +136,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         ));
 
         $session->save();
+
+        return 0;
     }
 }

src/PHPCR/Util/Console/Command/NodesUpdateCommand.php

@@ -6,7 +6,6 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Helper\DialogHelper;
-use PHPCR\Util\Console\Command\BaseCommand;
 
 /**
  * Command which can update the properties of nodes found
@@ -17,7 +16,7 @@
  *
  * @author Daniel Leech <[email protected]>
  */
-class NodesUpdateCommand extends BaseCommand
+class NodesUpdateCommand extends BaseNodeManipulationCommand
 {
     /**
      * {@inheritDoc}
@@ -82,8 +81,6 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $this->dialog = new DialogHelper();
-
         $query = $input->getOption('query');
         $queryLanguage = strtoupper($input->getOption('query-language'));
         $persistCounter = intval($input->getOption('persist-counter'));
@@ -93,7 +90,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $removeMixins = $input->getOption('remove-mixin');
         $applyClosures = $input->getOption('apply-closure');
         $noInteraction = $input->getOption('no-interaction');
-        $helper = $this->getPhpcrCliHelper();
+        $helper = $this->getPhpcrHelper();
         $session = $this->getPhpcrSession();
 
         if (!$query) {
@@ -154,7 +151,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
     protected function getAction($output, $result)
     {
-        $response = strtoupper($this->dialog->ask($output, sprintf(
+        /** @var $dialog DialogHelper */
+        $dialog = $this->getHelperSet()->get('dialog');
+        $response = strtoupper($dialog->ask($output, sprintf(
             '<question>About to update %d nodes. Enter "Y" to continue, "N" to cancel or "L" to list.</question>',
             count($result->getRows())
         ), false));

src/PHPCR/Util/Console/Command/WorkspaceCreateCommand.php

@@ -16,9 +16,9 @@
  * @license http://opensource.org/licenses/MIT MIT License
  *
  * @author Lukas Kahwe Smith <[email protected]>
- * @author David Buchmann <david@liip.ch>
+ * @author David Buchmann <mail@davidbu.ch>
  */
-class WorkspaceCreateCommand extends Command
+class WorkspaceCreateCommand extends BaseCommand
 {
     /**
      * {@inheritDoc}
@@ -43,8 +43,7 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        /** @var $session SessionInterface */
-        $session = $this->getHelper('phpcr')->getSession();
+        $session = $this->getPhpcrSession();
 
         $workspaceName = $input->getArgument('name');
 
@@ -61,9 +60,17 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return 1;
         }
 
+        if (array_search($workspaceName, $workspace->getAccessibleWorkspaceNames())) {
+            $output->writeln(
+                sprintf('<comment>This repository already has a workspace called "%s"</comment>', $workspaceName)
+            );
+
+            return 2;
+        }
+
         $workspace->createWorkspace($workspaceName);
 
-        $output->writeln("Created workspace '$workspaceName'.");
+        $output->writeln(sprintf('<info>Created workspace "%s".</info>', $workspaceName));
 
         return 0;
     }