Refactored input configuration for node manipulation

dantleech · dantleech · commit 0fe627dfc287 · 2013-06-12T15:40:59.000+02:00
diff --git a/src/PHPCR/Util/Console/Command/BaseCommand.php b/src/PHPCR/Util/Console/Command/BaseCommand.php
@@ -6,6 +6,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use PHPCR\Util\Console\Helper\PhpcrCliHelper;
+use Symfony\Component\Console\Input\InputOption;
 
 abstract class BaseCommand extends Command
 {
@@ -25,4 +26,24 @@ protected function getPhpcrCliHelper()
         $phpcrCliHelper = new PhpcrCliHelper($this->getPhpcrSession());
         return $phpcrCliHelper;
     }
+
+    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'
+        );
+    }
 }
diff --git a/src/PHPCR/Util/Console/Command/NodeTouchCommand.php b/src/PHPCR/Util/Console/Command/NodeTouchCommand.php
@@ -45,6 +45,8 @@ protected function configure()
     {
         parent::configure();
 
+        $this->configureNodeManipulationInput();
+
         $this->setName('phpcr:node:touch')
             ->addArgument(
                 'path',
@@ -57,26 +59,10 @@ protected function configure()
                 'Node type, default nt:unstructured',
                 'nt:unstructured'
             )
-            ->addOption('set-prop', 'p',
-                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                'Set node property, use foo=bar'
-            )
-            ->addOption('remove-prop', 'r',
-                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                'Remove node property'
-            )
             ->addOption('dump', 'd',
                 InputOption::VALUE_NONE,
                 'Dump a string reperesentation of the created / modified node.'
             )
-            ->addOption('add-mixin', null,
-                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                'Add a mixin to the node'
-            )
-            ->addOption('remove-mixin', null,
-                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                'Add a mixin to the node'
-            )
             ->setDescription('Create or modify a node')
             ->setHelp(<<<HERE
 This command allows you to create or modify a node at the specified path.
@@ -107,9 +93,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $path = $input->getArgument('path');
         $type = $input->getOption('type');
+        $dump = $input->getOption('dump');
+
         $setProp = $input->getOption('set-prop');
         $removeProp = $input->getOption('remove-prop');
-        $dump = $input->getOption('dump');
         $addMixins = $input->getOption('add-mixin');
         $removeMixins = $input->getOption('remove-mixin');
 
diff --git a/src/PHPCR/Util/Console/Command/NodesUpdateCommand.php b/src/PHPCR/Util/Console/Command/NodesUpdateCommand.php
@@ -42,44 +42,20 @@ protected function configure()
     {
         parent::configure();
 
+        $this->configureNodeManipulationInput($this);
+
         $this->setName('phpcr:nodes:update')
             ->addOption(
-                'type', 't',
+                'query', null,
                 InputOption::VALUE_REQUIRED,
-                'Update nodes of given node type, e.g. nt:unstructured'
-            )
-            ->addOption(
-                'where', 'w',
-                InputOption::VALUE_OPTIONAL,
-                'Specify the update criteria in SQL, e.g. "foobar = \'foo\' AND barfoo = \'bar\'"'
+                'Query used to select the nodes'
             )
             ->addOption(
                 'query-language', 'l', 
                 InputOption::VALUE_OPTIONAL, 
-                'The query language (sql, jcr_sql2',
+                'The query language (e.g. sql, jcr_sql2)',
                 'jcr_sql2'
             )
-
-            ->addOption('set-prop', 'p',
-                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                'Set node property on nodes use foo=bar'
-            )
-            ->addOption('remove-prop', 'r',
-                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                'Remove property from nodes'
-            )
-            ->addOption('add-mixin', null,
-                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                'Add a mixin to the nodes'
-            )
-            ->addOption('remove-mixin', null,
-                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-                'Remove mixin from the nodes'
-            )
-            ->addOption('force', null, 
-                InputOption::VALUE_NONE, 
-                'Use to bypass the confirmation dialog'
-            )
             ->setDescription('Command to manipulate the nodes in the workspace.')
             ->setHelp(<<<HERE
 The <info>nodes:update</info> command updates properties of nodes of type x matching
@@ -101,8 +77,7 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $type = $input->getOption('type');
-        $where = $input->getOption('where');
+        $query = $input->getOption('query');
         $queryLanguage = strtoupper($input->getOption('query-language'));
         $setProp = $input->getOption('set-prop');
         $removeProp = $input->getOption('remove-prop');
@@ -114,22 +89,21 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $this->dialog = new DialogHelper();
 
-        if (!$type) {
-            throw new \InvalidArgumentException('You must provide the "type" option, to select all nodes specify the type "nt:base"');
+        if (!$query) {
+            throw new \InvalidArgumentException(
+                'You must provide a SELECT query, e.g. --select="SELECT * FROM [nt:unstructured]"'
+            );
         }
 
-        if ($where) {
-            $sql = sprintf('SELECT * FROM [%s] WHERE %s', $type, $where);
-        } else {
-            $sql = sprintf('SELECT * FROM [%s]', $type);
+        if (strtoupper(substr($query, 0, 6) != 'SELECT')) {
+            throw new \InvalidArgumentException(sprintf(
+                'Query doesn\'t look like a SELECT query: "%s"',
+                $query
+            ));
         }
 
-        $output->writeln($sql);
-        $query = $helper->createQuery($queryLanguage, $sql);
-
-        $start = microtime(true);
+        $query = $helper->createQuery($queryLanguage, $query);
         $result = $query->execute();
-        $elapsed = microtime(true) - $start;
 
         if (!$noInteraction) {
             if (false === $this->getAction($output, $result)) {
@@ -139,7 +113,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         foreach ($result as $i => $row) {
             $output->writeln(sprintf(
-                "<info>Updating node:</info>[%d] %s.",
+                "<info>Updating node:</info> [%d] %s.",
                 $i,
                 $row->getPath()
             ));
@@ -154,9 +128,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
             ));
         }
 
+        $output->writeln('<info>Saving session...</info>');
         $session->save();
-
-        $output->writeln(sprintf('<info>%.2f seconds</info>', $elapsed));
+        $output->writeln('<info>Done.</info>');
 
         return 0;
     }
diff --git a/src/PHPCR/Util/Console/Helper/PhpcrCliHelper.php b/src/PHPCR/Util/Console/Helper/PhpcrCliHelper.php
@@ -99,7 +99,7 @@ public function processNode(OutputInterface $output, $node, $options)
 
         foreach ($options['addMixins'] as $addMixin) {
             $output->writeln(sprintf(
-                '<comment> > Adding mixin </comment>%s<comment>',
+                '<comment> > Adding mixin </comment>%s',
                 $addMixin
             ));
 
@@ -108,7 +108,7 @@ public function processNode(OutputInterface $output, $node, $options)
 
         foreach ($options['removeMixins'] as $removeMixin) {
             $output->writeln(sprintf(
-                '<comment> > Removing mixin </comment>%s<comment>',
+                '<comment> > Removing mixin </comment>%s',
                 $removeMixin
             ));
 
@@ -159,4 +159,3 @@ public function createQuery($language, $sql)
         return $query;
     }
 }
-
diff --git a/tests/PHPCR/Tests/Util/Console/Command/NodesUpdateCommandTest.php b/tests/PHPCR/Tests/Util/Console/Command/NodesUpdateCommandTest.php
@@ -22,33 +22,23 @@ public function provideNodeUpdate()
     {
         return array(
 
-            // no type specified
+            // no query specified
             array(array(
                 'exception' => 'InvalidArgumentException',
             )),
 
-            // select with no WHERE
+            // specify query
             array(array(
-                'type' => 'nt:unstructured',
-                'expectedSql' => 'SELECT * FROM nt:unstructured',
-            )),
-
-            // select with WHERE
-            array(array(
-                'type' => 'nt:unstructured',
-                'where' => 'foo="bar"',
-                'expectedSql' => 'SELECT * FROM nt:unstructured WHERE foo="bar"',
+                'query' => 'SELECT * FROM nt:unstructured WHERE foo="bar"',
             )),
 
             // set, remote properties and mixins
             array(array(
-                'type' => 'nt:unstructured',
                 'setProp' => array(array('foo', 'bar')),
                 'removeProp' => array('bar'),
                 'addMixin' => array('mixin1'),
                 'removeMixin' => array('mixin1'),
-
-                'expectedSql' => 'SELECT * FROM nt:unstructured',
+                'query' => 'SELECT * FROM nt:unstructured',
             )),
         );
     }
@@ -59,13 +49,11 @@ public function provideNodeUpdate()
     public function testNodeUpdate($options)
     {
         $options = array_merge(array(
-            'type' => null,
-            'where' => null,
+            'query' => null,
             'setProp' => array(),
             'removeProp' => array(),
             'addMixin' => array(),
             'removeMixin' => array(),
-            'expectedSql' => null,
             'exception' => null,
         ), $options);
 
@@ -82,7 +70,7 @@ public function testNodeUpdate($options)
 
         $this->queryManager->expects($this->any())
             ->method('createQuery')
-            ->with($options['expectedSql'], 'sql')
+            ->with($options['query'], 'JCR-SQL2')
             ->will($this->returnValue($this->query));
 
         $this->query->expects($this->any())
@@ -96,18 +84,14 @@ public function testNodeUpdate($options)
 
         $args = array(
             '--query-language' => null,
-            '--where' => $options['where'],
-            '--force' => true,
+            '--query' => $options['query'],
+            '--no-interaction' => true,
             '--set-prop' => array(),
             '--remove-prop' => array(),
             '--add-mixin' => array(),
             '--remove-mixin' => array(),
         );
 
-        if ($options['type']) {
-            $args['--type'] = $options['type'];
-        }
-
         foreach ($options['setProp'] as $setProp)
         {
             list($prop, $value) = $setProp;
