Handle binary properties

Author: dantleech

features/phpcr_node_edit.feature

@@ -135,3 +135,10 @@ Feature: Edit a node
         Then the command should not fail
         And there should exist a node at "/cms/products/product2"
         And the primary type of "/cms/products/product2" should be "nt:resource"
+
+    Scenario: Editor returns empty string
+        Given I have an editor which produces the following:
+        """"
+        """
+        And I execute the "node:edit cms/products/product2 --no-interaction --type=nt:resource" command
+        Then the command should fail

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

@@ -54,24 +54,41 @@ public function execute(InputInterface $input, OutputInterface $output)
 
         // for now we only support YAML
         $encoders = array(new YamlEncoder());
-        $normalizers = array(new NodeNormalizer());
-        $serializer = new Serializer($normalizers, $encoders);
+        $nodeNormalizer = new NodeNormalizer();
+        $serializer = new Serializer(array($nodeNormalizer), $encoders);
         $outStr = $serializer->serialize($node, 'yaml');
 
-
         $tryAgain = false;
         $message = '';
+        $error = '';
+        $notes = implode("\n", $nodeNormalizer->getNotes());
+
         do {
-            // string pass to editor
-            if ($message) {
+            $message = '';
+            if ($error) {
                 $template = <<<EOT
 Error encounred: 
+%s
+
+EOT
+                ;
+                $message .= sprintf($template, $error);
+            }
 
+            if ($notes) {
+                $template = <<<EOT
+NOTE: 
 %s
+
 EOT
                 ;
+                $message .= sprintf($template, $notes);
+            }
+
+            // string pass to editor
+            if ($message) {
 
-                $inStr = $editor->fromStringWithMessage($outStr, sprintf($template, $message), '# ', 'yml');
+                $inStr = $editor->fromStringWithMessage($outStr, $message, '# ', 'yml');
             } else {
                 $inStr = $editor->fromString($outStr, 'yml');
             }
@@ -82,15 +99,19 @@ public function execute(InputInterface $input, OutputInterface $output)
                 ));
                 $tryAgain = false;
             } catch (\Exception $e) {
-                $message = $e->getMessage();
-                $output->writeln('<error>' . $message . '</error>');
+                $error = $e->getMessage();
+                $output->writeln('<error>' . $error . '</error>');
                 if (false === $input->getOption('no-interaction')) {
                     $tryAgain = $dialog->askConfirmation($output, 'Do you want to try again? (y/n)');
                 }
                 $outStr = $inStr;
             }
         } while ($tryAgain == true);
 
+        if ($error) {
+            return 1;
+        }
+
         return 0;
     }
 }

src/PHPCR/Shell/Resources/config.dist/alias.yml

@@ -1,5 +1,5 @@
 # Shell shortcuts
-lsa: shell:alias:list
+aliases: shell:alias:list
 creload: shell:config:reload
 cinit: shell:config:init
 
@@ -20,32 +20,38 @@ ln: node:clone {arg1} {arg2} # symlink, as in ln -s
 cp: node:copy {arg1} {arg2}
 cat: node:property:show {arg1}
 touch: node:property:set {arg1} {arg2} {arg3}
+mkdir: node:create {arg1} {arg2}
 
 # Node type commands
-lsmix: node-type:list "^mix:"
-lsnt: node-type:list {arg1}
+mixins: node-type:list "^mix:"
+nodetypes: node-type:list {arg1}
 ntedit: node-type:edit {arg1}
 ntshow: node-type:show {arg1}
 
 # Workspace commands
-wslist: workspace:list
+workspaces: workspace:list
 
 # Namespsce commands
-lsns: workspace:namespace:list {arg1}
+namespaces: workspace:namespace:list {arg1}
 nsset: workspace:namespace:register
 
 # Editor commands
-vim: node:property:edit {arg1} {arg2}
-nano: node:property:edit {arg1} {arg2}
+vi: node:edit {arg1} {arg2}
+vim: node:edit {arg1} {arg2}
+nano: node:edit {arg1} {arg2}
 
 # GNU commands
 man: help {arg1}
 
 # Version commands
+checkin: version:checkin {arg1}
 ci: version:checkin {arg1}
 co: version:checkout {arg1}
+checkout: version:checkout {arg1}
 cp: version:checkpoint {arg1}
+checkpoint: version:checkpoint {arg1}
 vhist: version:history {arg1}
+versions: version:history {arg1}
 
 # Session commands
 save: session:save

src/PHPCR/Shell/Serializer/NodeNormalizer.php

@@ -7,6 +7,7 @@
 use PHPCR\PropertyType;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+use PHPCR\PropertyInterface;
 
 /**
  * Normalizer for PHPCR Nodes
@@ -15,6 +16,19 @@
  */
 class NodeNormalizer implements NormalizerInterface, DenormalizerInterface
 {
+    protected $allowBinary;
+    protected $notes = array();
+
+    public function __construct($allowBinary = false)
+    {
+        $this->allowBinary = $allowBinary;
+    }
+
+    public function getNotes()
+    {
+        return $this->notes;
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -23,6 +37,10 @@ public function normalize($node, $format = null, array $context = array())
         $res = array();
 
         foreach ($node->getProperties() as $property) {
+            if (false === $this->isPropertyEditable($property)) {
+                continue;
+            }
+
             $propertyType = $property->getType();
             $propertyValue = $property->getValue();
             $propertyName = $property->getName();
@@ -49,6 +67,12 @@ public function supportsNormalization($data, $format = null)
      */
     public function denormalize($data, $class, $format = null, array $context = array())
     {
+        if (!$data) {
+            throw new \InvalidArgumentException(
+                'Editor returned nothing .. nodes must have at least one property (i.e. the jcr:primaryType property)'
+            );
+        }
+
         if (!isset($context['node'])) {
             throw new \InvalidArgumentException(sprintf(
                 'You must provide the PHPCR node instance to update in the context using the "node" key.'
@@ -61,7 +85,12 @@ public function denormalize($data, $class, $format = null, array $context = arra
 
         // Update / remove existing properties
         foreach ($node->getProperties() as $property) {
+            if (false === $this->isPropertyEditable($property)) {
+                continue;
+            }
+
             try {
+
                 if (!isset($data[$property->getName()])) {
                     $property->remove();
                     continue;
@@ -139,4 +168,24 @@ private function normalizeDatum($value)
 
         return $value;
     }
+
+    /**
+     * Return false if property type is not editable
+     *
+     * (e.g. property type is binary)
+     *
+     * @return boolean
+     */
+    private function isPropertyEditable(PropertyInterface $property)
+    {
+        // do not serialize binary objects
+        if (false === $this->allowBinary && PropertyType::BINARY == $property->getType()) {
+            $this->notes[] = sprintf(
+                'Binary property "%s" has been omitted', $property->getName()
+            );
+            return false;
+        }
+
+        return true;
+    }
 }