Refactored to use function mapping for UPDATE

Author: dantleech

features/phpcr_query_update.feature

@@ -25,31 +25,21 @@ Feature: Execute a a raw UPDATE query in JCR_SQL2
             | UPDATE nt:unstructured AS a SET title = 'DTL', foobar='barfoo' WHERE localname() = 'article1' | /cms/articles/article1 | foobar | barfoo |
 
     Scenario: Replace a multivalue index by value
-        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags = 'Rockets' WHERE a.tags = 'Trains'" command
+        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags = array_replace(a.tags, 'Trains', 'Rockets') WHERE a.tags = 'Trains'" command
+        Then the command should not fail
         And I save the session
         Then the command should not fail
         And the node at "/cms/articles/article1" should have the property "tags" with value "Rockets" at index "1"
 
     Scenario: Set a multivalue value
-        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags = ['Rockets', 'Dragons'] WHERE a.tags = 'Trains'" command
+        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags = ARRAY['Rockets', 'Dragons'] WHERE a.tags = 'Trains'" command
         And I save the session
         Then the command should not fail
         And the node at "/cms/articles/article1" should have the property "tags" with value "Rockets" at index "0"
         And the node at "/cms/articles/article1" should have the property "tags" with value "Dragons" at index "1"
 
-    Scenario: Update single multivalue
-        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags = 'Rockets' WHERE a.tags = 'Planes'" command
-        And I save the session
-        Then the command should not fail
-        And I should see the following:
-        """
-        1 row(s) affected
-        """
-        And the node at "/cms/articles/article1" should have the property "tags" with value "Rockets" at index "0"
-        And the node at "/cms/articles/article1" should have the property "tags" with value "Automobiles" at index "2"
-
     Scenario: Update single multivalue without selector
-        Given I execute the "UPDATE [nt:unstructured] SET tags = 'Rockets' WHERE tags = 'Planes'" command
+        Given I execute the "UPDATE [nt:unstructured] SET tags = array_replace(tags, 'Planes', 'Rockets') WHERE tags = 'Planes'" command
         And I save the session
         Then the command should not fail
         And I should see the following:
@@ -60,7 +50,7 @@ Feature: Execute a a raw UPDATE query in JCR_SQL2
         And the node at "/cms/articles/article1" should have the property "tags" with value "Automobiles" at index "2"
 
     Scenario: Remove single multivalue
-        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags = NULL WHERE a.tags = 'Planes'" command
+        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags = array_remove(a.tags, 'Planes') WHERE a.tags = 'Planes'" command
         And I save the session
         Then the command should not fail
         And I should see the following:
@@ -82,7 +72,7 @@ Feature: Execute a a raw UPDATE query in JCR_SQL2
         And the node at "/cms/articles/article1" should have the property "tags" with value "Automobiles" at index "1"
 
     Scenario: Add a multivalue property
-        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags[] = 'Kite' WHERE a.tags = 'Planes'" command
+        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags = array_append(a.tags, 'Kite') WHERE a.tags = 'Planes'" command
         And I save the session
         Then the command should not fail
         And I should see the following:
@@ -114,7 +104,7 @@ Feature: Execute a a raw UPDATE query in JCR_SQL2
         """
 
     Scenario: Replace a multivalue property by invalid index with array (invalid)
-        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags[1] = ['Kite'] WHERE a.tags = 'Planes'" command
+        Given I execute the "UPDATE [nt:unstructured] AS a SET a.tags[1] = ARRAY['Kite'] WHERE a.tags = 'Planes'" command
         Then the command should fail
         And I should see the following:
         """

spec/PHPCR/Shell/Query/SelectParserSpec.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace spec\PHPCR\Shell\Query;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use PHPCR\Query\QOM\QueryObjectModelFactoryInterface;
+use PHPCR\Query\QOM\SourceInterface;
+use PHPCR\Query\QueryInterface;
+
+class SelectParserSpec extends ObjectBehavior
+{
+    function let(
+        QueryObjectModelFactoryInterface $qomf
+    )
+    {
+        $this->beConstructedWith(
+            $qomf
+        );
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('PHPCR\Shell\Query\SelectParser');
+    }
+}

spec/PHPCR/Shell/Query/UpdateParserSpec.php

@@ -13,6 +13,8 @@
 use PHPCR\Query\QOM\LiteralInterface;
 use PHPCR\Query\QOM\ComparisonInterface;
 use PHPCR\Query\QueryInterface;
+use PHPCR\Shell\Query\FunctionOperand;
+use PHPCR\Shell\Query\ColumnOperand;
 
 class UpdateParserSpec extends ObjectBehavior
 {
@@ -97,7 +99,7 @@ function it_should_parse_array_values (
 
 
         $sql = <<<EOT
-UPDATE [dtl:article] AS a SET a.tags = ['one', 'two', 'three']
+UPDATE [dtl:article] AS a SET a.tags = ARRAY['one', 'two', 'three']
 EOT;
         $res = $this->parse($sql);
 
@@ -114,12 +116,7 @@ function it_should_parse_array_values (
 
     function it_should_parse_array_addition (
         QueryObjectModelFactoryInterface $qomf,
-        ChildNodeJoinConditionInterface $joinCondition,
-        JoinInterface $join,
         SourceInterface $source,
-        PropertyValueInterface $tagsValue,
-        LiteralInterface $literalValue,
-        ComparisonInterface $comparison,
         QueryInterface $query
     )
     {
@@ -142,4 +139,31 @@ function it_should_parse_array_addition (
             ),
         ));
     }
+
+    function it_should_parse_functions (
+        QueryObjectModelFactoryInterface $qomf,
+        SourceInterface $source,
+        QueryInterface $query
+    )
+    {
+        $qomf->selector('a', 'dtl:article')->willReturn($source);
+        $qomf->createQuery($source, null)->willReturn($query);
+
+
+        $sql = <<<EOT
+UPDATE [dtl:article] AS a SET a.tags[] = array_replace(a.tags, 'asd', 'dsa')
+EOT;
+        $res = $this->parse($sql);
+
+        $res->offsetGet(0)->shouldHaveType('PHPCR\Query\QueryInterface');
+
+        // $res->offsetGet(1)->shouldReturn(array(
+        //     array(
+        //         'array_op' => 'add',
+        //         'selector' => 'a',
+        //         'name' => 'tags',
+        //         'value' => new FunctionOperand(new ColumnOperand('a', 'tags'), array('asd', 'dsa')),
+        //     ),
+        // ));
+    }
 }

src/PHPCR/Shell/Console/Command/Phpcr/NodeListCommand.php

@@ -61,6 +61,8 @@ public function execute(InputInterface $input, OutputInterface $output)
 
         $currentNode = $session->getNodeByPathOrIdentifier($path);
 
+        echo $currentNode->getIndex()."\n";
+
         if (!$this->showChildren && !$this->showProperties) {
             $this->showChildren = true;
             $this->showProperties = true;

src/PHPCR/Shell/Console/Command/Phpcr/QueryUpdateCommand.php

@@ -10,6 +10,7 @@
 use Jackalope\Query\QOM\PropertyValue;
 use PHPCR\Query\QOM\QueryObjectModelConstantsInterface;
 use PHPCR\Query\QOM\LiteralInterface;
+use PHPCR\Shell\Query\UpdateProcessor;
 
 class QueryUpdateCommand extends Command
 {
@@ -24,23 +25,30 @@ protected function configure()
         $this->setDescription('Execute an UPDATE JCR-SQL2 query');
         $this->addArgument('query');
         $this->setHelp(<<<EOT
-Execute a JCR-SQL2 update query. Unlike other commands you can enter a query literally:
+Execute a PHPCR-Shell JCR-SQL2 update query. Tou can enter a query literally:
 
      UPDATE [nt:unstructured] AS a SET title = 'foobar' WHERE a.title = 'barfoo';
 
-You can update multivalue properties too:
+You can also manipulate multivalue fields:
     
-     # Add a property
-     UPDATE [nt:unstructured] AS a SET a.tags[] = 'foo'
-
-     # Set values
-     UPDATE [nt:unstructured] AS a SET a.tags = ['one', 'two', 'three', 'four']
-
      # Delete index
      UPDATE [nt:unstructured] SET a.tags[0] = NULL
 
-     # Update a multivalue index by value
-     UPDATE [nt:unstructured] SET a.tags = 'Foo' WHERE a.tags = 'Bar';
+     # Set index
+     UPDATE [nt:unstructured] SET a.tags[0] = 'foo'
+
+And you have access to a set of functions when assigning a value:
+
+     # Replace the multivalue value "Planes" with "Trains"
+     UPDATE [nt:unstructured] AS a SET a.tags[] = array_replace(a.tags, 'Planes', 'Trains')
+
+     # Append a multivalue 
+     UPDATE [nt:unstructured] AS a SET a.tags = array_append(a.tags, 'Rockets')
+
+     # Remove by value
+     UPDATE [nt:unstructured] AS a SET a.tags = array_remove(a.tags, 'Plains')
+
+Refer to the documentation for a full reference: http://phpcr.readthedocs.org/en/latest/phpcr-shell
 
 You must call <info>session:save</info> to persist changes.
 
@@ -67,130 +75,22 @@ public function execute(InputInterface $input, OutputInterface $output)
         $res = $updateParser->parse($sql);
         $query = $res->offsetGet(0);
         $updates = $res->offsetGet(1);
-        $constraint = $res->offsetGet(2);
 
         $start = microtime(true);
         $result = $query->execute();
         $rows = 0;
 
+        $updateProcessor = new UpdateProcessor();
+
         foreach ($result as $row) {
             $rows++;
             foreach ($updates as $property) {
-                $node = $row->getNode($property['selector']);
-
-                if ($node->hasProperty($property['name'])) {
-                    $value = $this->handleMultiValue($node, $property, $constraint);
-                } else {
-                    $value = $property['value'];
-                }
-
-                $node->setProperty($property['name'], $value);
+                $updateProcessor->updateNode($row, $property);
             }
         }
 
         $elapsed = microtime(true) - $start;
 
         $output->writeln(sprintf('%s row(s) affected in %ss', $rows, number_format($elapsed, 2)));
     }
-
-    protected function handleMultiValue($node, $propertyData, $constraint)
-    {
-        $phpcrProperty = $node->getProperty($propertyData['name']);
-        $value = $propertyData['value'];
-
-        if (false === $phpcrProperty->isMultiple()) {
-            return $value;
-        }
-
-        $currentValue = $phpcrProperty->getValue();
-
-        // there is an array operator ([] or [x])
-        if (isset($propertyData['array_op'])) {
-            $arrayOp = $propertyData['array_op'];
-            if ($arrayOp === UpdateParser::ARRAY_OPERATION_ADD) {
-                foreach ((array) $value as $v) {
-                    $currentValue[] = $v;
-                }
-
-                return $currentValue;
-            } elseif ($arrayOp === UpdateParser::ARRAY_OPERATION_SUB) {
-                $arrayIndex = $propertyData['array_index'];
-
-                if (!isset($currentValue[$arrayIndex])) {
-                    throw new \InvalidArgumentException(sprintf(
-                        'Multivalue index "%s" does not exist in multivalue field "%s"', $arrayIndex, $propertyData['name']
-                    ));
-                }
-
-                if (null === $value) {
-                    unset($currentValue[$arrayIndex]);
-                    return array_values($currentValue);
-                }
-
-                if (is_array($value)) {
-                    throw new \InvalidArgumentException(sprintf('Cannot set index to array value on "%s"', $propertyData['name']));
-                }
-
-                $currentValue[$arrayIndex] = $value;
-
-                return $currentValue;
-            }
-        }
-
-        if (is_array($value)) {
-            return $value;
-        }
-
-        if ($constraint instanceof ComparisonConstraint) {
-
-            $op1 = $constraint->getOperand1();
-            $op2 = $constraint->getOperand2();
-            $operator = $constraint->getOperator();
-            if ($op1 instanceOf PropertyValue) {
-                if (
-                    ($propertyData['selector'] === null ||
-                    $op1->getSelectorName() == $propertyData['selector']) &&
-                    $op1->getPropertyName() == $propertyData['name']
-                ) 
-                {
-                    if ($operator !== QueryObjectModelConstantsInterface::JCR_OPERATOR_EQUAL_TO) {
-                        throw new \InvalidArgumentException(sprintf(
-                            'You must use the "=" operator in the comparison when specifying a specific multiple value update'
-                        ));
-                    }
-
-                    if (!$op2 instanceof LiteralInterface) {
-                        throw new \InvalidArgumentException(sprintf(
-                            'The value of "%s" must be a literal', $propertyData['name']
-                        ));
-                    }
-
-                    $targetValue = $op2->getLiteralValue();
-
-                    foreach ($currentValue as $k => $v) {
-                        if ($v === $targetValue) {
-                            if (null === $value) {
-                                unset($currentValue[$k]);
-                                $currentValue = array_values($currentValue);
-                            } else {
-                                $currentValue[$k] = $value;
-                            }
-                        }
-                    }
-
-                    return $currentValue;
-                }
-            }
-        }
-
-        // do not allow updating multivalue with scalar
-        if (false === is_array($value) && sizeof($currentValue) > 1) {
-            throw new \InvalidArgumentException(sprintf(
-                '<error>Cannot update multivalue property "%s" with a scalar value.</error>',
-                $phpcrProperty->getName()
-            ));
-        }
-
-        return $value;
-    }
 }

src/PHPCR/Shell/Console/Helper/ResultFormatterHelper.php

@@ -60,11 +60,13 @@ public function formatQueryResult(QueryResultInterface $result, OutputInterface
         $table = new TableHelper;
         $table->setHeaders(array_merge(array(
             'Path',
+            'Index',
         ), $result->getColumnNames()));
 
         foreach ($result->getRows() as $i => $row) {
             $values = array_merge(array(
                 $row->getPath(),
+                $row->getNode()->getIndex(),
             ), $row->getValues());
 
             foreach ($values as $columnName => &$value) {

src/PHPCR/Shell/Query/ColumnOperand.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace PHPCR\Shell\Query;
+
+/**
+ * Simple class to represent column operands in query
+ * evaluations.
+ *
+ * @author Daniel Leech <daniel@dantleech.com>
+ */
+class ColumnOperand
+{
+    private $selectorName;
+    private $propertyName;
+
+    public function __construct($selectorName, $propertyName)
+    {
+        $this->selectorName = $selectorName;
+        $this->propertyName = $propertyName;
+    }
+
+    public function getSelectorName() 
+    {
+        return $this->selectorName;
+    }
+
+    public function getPropertyName() 
+    {
+        return $this->propertyName;
+    }
+}

src/PHPCR/Shell/Query/Function.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace PHPCR\Shell\Query;
+
+class Function
+{
+    ;
+}