Merge pull request #71 from dantleech/nodes-update-closure

[RFC] Added `--apply-closure` option

Author: dbu

CHANGELOG.md

@@ -0,0 +1,4 @@
+Changelog
+=========
+
+* **2013-06-15**: [Command] Added `--apply-closure` option to `phpcr:nodes:update` command.

bin/phpcr

@@ -44,6 +44,7 @@ $cli->addCommands(array(
     new \PHPCR\Util\Console\Command\NodeMoveCommand(),
     new \PHPCR\Util\Console\Command\NodeRemoveCommand(),
     new \PHPCR\Util\Console\Command\NodeTouchCommand(),
+    new \PHPCR\Util\Console\Command\NodesUpdateCommand(),
     new \PHPCR\Util\Console\Command\NodeTypeListCommand(),
     new \PHPCR\Util\Console\Command\NodeTypeRegisterCommand(),
     new \PHPCR\Util\Console\Command\WorkspaceCreateCommand(),

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

@@ -78,5 +78,9 @@ public function configureNodeManipulationInput()
             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/NodesUpdateCommand.php

@@ -61,17 +61,28 @@ protected function configure()
 The <info>phpcr:nodes:update</info> can manipulate the properties of nodes 
 found using the given query.
 
-For example, to set the property "foo" to "bar" on all unstructured nodes:
+For example, to set the property <comment>foo</comment> to <comment>bar</comment> on all unstructured nodes:
 
-    php bin/phpcr phpcr:nodes:update --query="SELECT * FROM [nt:unstructured]" --set-prop=foo=bar
+    <info>php bin/phpcr phpcr:nodes:update --query="SELECT * FROM [nt:unstructured]" --set-prop=foo=bar</info>
 
 Or to update only nodes matching a certain criteria:
 
-    php bin/phpcr nodes:update --query="SELECT * FROM [nt:unstructured] WHERE [phpcr:class]=\"Some\\Class\\Here\" --add-mixin=mix:mimetype
+    <info>php bin/phpcr phpcr:nodes:update \
+        --query="SELECT * FROM [nt:unstructured] WHERE [phpcr:class]=\"Some\\Class\\Here\"" \
+        --add-mixin=mix:mimetype</info>
 
 The options for manipulating nodes are the same as with the 
 <info>node:touch</info> command and
 can be repeated to update multiple properties.
+
+If you have an advanced use case you can use the <comment>--apply-closure</comment> option:
+
+    <info>php bin/phpcr phpcr:nodes:update \
+        --query="SELECT * FROM [nt:unstructured] WHERE [phpcr:class]=\"Some\\Class\\Here\"" \
+        --apply-closure="\\\$session->doSomething(); \\\$node->setProperty('foo', 'bar');"</info>
+
+For each node in the result set, the closure will be passed the current 
+<comment>PHPCR\SessionInterface</comment> implementation and the node (<comment>PHPCR\NodeInterface</comment>) as <comment>\$session</comment> and <comment>\$node</comment>.
 HERE
 );
     }
@@ -89,6 +100,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $removeProp = $input->getOption('remove-prop');
         $addMixins = $input->getOption('add-mixin');
         $removeMixins = $input->getOption('remove-mixin');
+        $applyClosures = $input->getOption('apply-closure');
         $noInteraction = $input->getOption('no-interaction');
         $helper = $this->getPhpcrCliHelper();
         $session = $this->getPhpcrSession();
@@ -129,6 +141,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 'removeProp' => $removeProp,
                 'addMixins' => $addMixins,
                 'removeMixins' => $removeMixins,
+                'applyClosures' => $applyClosures,
             ));
         }
 

src/PHPCR/Util/Console/Helper/PhpcrCliHelper.php

@@ -77,6 +77,7 @@ public function processNode(OutputInterface $output, $node, $options)
             'removeProp' => array(),
             'addMixins' => array(),
             'removeMixins' => array(),
+            'applyClosures' => array(),
             'dump' => false,
         ), $options);
 
@@ -115,6 +116,15 @@ public function processNode(OutputInterface $output, $node, $options)
             $node->removeMixin($removeMixin);
         }
 
+        foreach ($options['applyClosures'] as $closureString) {
+            $closure = create_function('$session, $node', $closureString);
+            $output->writeln(sprintf(
+                '<comment> > Applying closure: %s</comment>',
+                strlen($closureString) > 75 ? substr($closureString, 0, 72).'...' : $closureString
+            ));
+            $closure($this->session, $node);
+        }
+
         if ($options['dump']) {
             $output->writeln('<info>Node dump: </info>');
             /** @var $property PropertyInterface */

tests/PHPCR/Tests/Util/Console/Command/NodesUpdateCommandTest.php

@@ -40,24 +40,12 @@ public function provideNodeUpdate()
         );
     }
 
-    /**
-     * @dataProvider provideNodeUpdate
-     */
-    public function testNodeUpdate($options)
+    protected function setupQueryManager($options)
     {
         $options = array_merge(array(
-            'query' => null,
-            'setProp' => array(),
-            'removeProp' => array(),
-            'addMixin' => array(),
-            'removeMixin' => array(),
-            'exception' => null,
+            'query' => '',
         ), $options);
 
-        if ($options['exception']) {
-            $this->setExpectedException($options['exception']);
-        }
-
         $this->session->expects($this->any())
             ->method('getWorkspace')
             ->will($this->returnValue($this->workspace));
@@ -69,7 +57,6 @@ public function testNodeUpdate($options)
             ->method('createQuery')
             ->with($options['query'], 'JCR-SQL2')
             ->will($this->returnValue($this->query));
-
         $this->query->expects($this->any())
             ->method('execute')
             ->will($this->returnValue(array(
@@ -78,6 +65,27 @@ public function testNodeUpdate($options)
         $this->row1->expects($this->any())
             ->method('getNode')
             ->will($this->returnValue($this->node1));
+    }
+
+    /**
+     * @dataProvider provideNodeUpdate
+     */
+    public function testNodeUpdate($options)
+    {
+        $options = array_merge(array(
+            'query' => null,
+            'setProp' => array(),
+            'removeProp' => array(),
+            'addMixin' => array(),
+            'removeMixin' => array(),
+            'exception' => null,
+        ), $options);
+
+        if ($options['exception']) {
+            $this->setExpectedException($options['exception']);
+        }
+
+        $this->setupQueryManager($options);
 
         $args = array(
             '--query-language' => null,
@@ -128,4 +136,27 @@ public function testNodeUpdate($options)
 
         $ct = $this->executeCommand('phpcr:nodes:update', $args);
     }
+
+    public function testApplyClosure()
+    {
+        $args = array(
+            '--query' => "SELECT foo FROM bar",
+            '--no-interaction' => true,
+            '--apply-closure' => array(
+                '$session->getNodeByIdentifier("/foo"); $node->setProperty("foo", "bar");'
+            ),
+        );
+
+        $this->setupQueryManager(array('query' => 'SELECT foo FROM bar'));
+
+        $this->node1->expects($this->once())
+            ->method('setProperty')
+            ->with('foo', 'bar');
+
+        $this->session->expects($this->once())
+            ->method('getNodeByIdentifier')
+            ->with('/foo');
+
+        $ct = $this->executeCommand('phpcr:nodes:update', $args);
+    }
 }