Improved result set formatting

Author: dantleech

README.md

@@ -7,12 +7,12 @@ Shell for PHPCR
 
 To connect to a doctrine-dbal PHPCR repository:
 
-    $ php bin/phpcr-shell --db_name=foobar --db_username=user --db_password=foobar
+    $ php bin/phpcr --db-name=foobar --db-username=user --db-password=foobar
 
 Full definition:
 
 ````bash
-./bin/phpcrsh --help
+./bin/phpcr --help
 Usage:
  phpcr_shell [-h|--help] [-v|--verbose] [-V|--version] [--ansi] [--no-ansi] [-t|--transport="..."] [-pu|--phpcr-username="..."] [-pp|--phpcr-password[="..."]] [-pw|--phpcr-workspace[="..."]] [-du|--db-username="..."] [-dn|--db-name="..."] [-dp|--db-password[="..."]] [-dh|--db-host="..."] [-dd|--db-driver="..."] [-dP|--db-path="..."] [-url|--repo-url="..."]
 

src/PHPCR/Shell/Console/Application/SessionApplication.php

@@ -16,11 +16,17 @@
 use PHPCR\Shell\Console\Command\ShellCommand;
 use PHPCR\Shell\Console\Input\ArgvInput;
 
+/**
+ * This application wraps a single command which accepts
+ * the connection parameters and starts an interactive shell.
+ *
+ * @author Daniel Leech <daniel@dantleech.com>
+ */
 class SessionApplication extends BaseApplication
 {
     public function __construct()
     {
-        parent::__construct('PHPCRSH', '0.1');
+        parent::__construct('PHPCR', '1.0');
 
         $command = new ShellCommand();
         $command->setApplication($this);
@@ -32,11 +38,6 @@ public function getDefaultInputDefinition()
         return new InputDefinition(array());
     }
 
-    public function run()
-    {
-        parent::run();
-    }
-
     protected function getCommandName($input)
     {
         return 'phpcr_shell';

src/PHPCR/Shell/Console/Application/Shell.php

@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Shell as BaseShell;
 use PHPCR\Shell\Console\Input\StringInput;
 
+/**
+ * This is more or less a copy of the Symfony\Component\Shell
+ *
+ * @author Daniel Leech
+ */
 class Shell
 {
     private $application;
@@ -66,10 +71,6 @@ public function run()
             }
 
             $ret = $this->application->run(new StringInput($command), $this->output);
-
-            if (0 !== $ret) {
-                $this->output->writeln(sprintf('<error>The command terminated with an error status (%s)</error>', $ret));
-            }
         }
     }
 
@@ -87,7 +88,7 @@ protected function getHeader()
 At the prompt, type <comment>help</comment> for some help,
 or <comment>list</comment> to get a list of available commands.
 
-To exit the shell, type <comment>^D</comment>.
+To exit the shell, type <comment>exit</comment>.
 
 EOF;
     }

src/PHPCR/Shell/Console/Application/ShellApplication.php

@@ -41,9 +41,9 @@ class ShellApplication extends Application
     protected $transports;
     protected $credentials;
 
-    public function __construct(InputInterface $input, $transports = array())
+    public function __construct($appName, $version, InputInterface $input, $transports = array())
     {
-        parent::__construct('PHPCRSH', '0.1');
+        parent::__construct($appName, $version);
 
         // initialize transports
         foreach (array_merge(array(
@@ -162,4 +162,11 @@ public function doRun(InputInterface $input, OutputInterface $output)
 
         return parent::doRun($input, $output);
     }
+
+    public function renderException($e, $output)
+    {
+        do {
+            $output->writeln(sprintf('<fg=red>%s</fg=red>', $e->getMessage()));
+        } while ($e = $e->getPrevious());
+    }
 }

src/PHPCR/Shell/Console/Command/ShellCommand.php

@@ -40,7 +40,11 @@ public function configure()
 
     public function execute(InputInterface $input, OutputInterface $output)
     {
-        $application = new Shell(new ShellApplication($input));
+        $application = new Shell(new ShellApplication(
+            $this->getApplication()->getName(),
+            $this->getApplication()->getVersion(),
+            $input
+        ));
         $application->run($input, $output);
     }
 }

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

@@ -6,6 +6,7 @@
 use PHPCR\Query\QueryResultInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use PHPCR\PropertyType;
+use PHPCR\NodeInterface;
 
 class ResultFormatterHelper extends Helper
 {
@@ -14,19 +15,22 @@ public function getName()
         return 'result_formatter';
     }
 
-    public function format(QueryResultInterface $result, OutputInterface $output)
+    public function format(QueryResultInterface $result, OutputInterface $output, $elapsed)
     {
         $selectorNames = $result->getSelectorNames();
+
         foreach ($result->getRows() as $i => $row) {
-            $output->writeln($i);
+            $output->writeln(sprintf('%s ----', $i + 1));
             foreach ($selectorNames as $selectorName) {
                 $node = $row->getNode($selectorName);
                 $properties = $node->getProperties();
-                $output->writeln('  ' . $selectorName);
-                $output->writeln('    <comment>' . $node->getPath().'</comment>');
+                $output->writeln(sprintf(
+                    '  [%s] [path:<comment>%s</comment>] [uid:<info>%s</info>]',
+                    $selectorName, $node->getPath(), $node->getIdentifier()
+                ));
 
                 foreach ($properties as $key => $value) {
-                    $output->writeln(sprintf('    <info>%s</info> %s%s: %s',
+                    $output->writeln(sprintf('    <info>%s</info> <fg=magenta>%s%s</fg=magenta>: %s',
                         $key,
                         PropertyType::nameFromValue($value->getType()),
                         $value->isMultiple() ? '[]' : '',
@@ -35,6 +39,9 @@ public function format(QueryResultInterface $result, OutputInterface $output)
                 }
             }
         }
+
+        $output->writeln('');
+        $output->writeln(sprintf('%s rows in set (%s sec)', count($result->getRows()), number_format($elapsed, 2)));
     }
 
     protected function formatValue($value)
@@ -43,8 +50,20 @@ protected function formatValue($value)
             if (empty($value->getValue())) {
                 return '';
             }
+            $array = $value;
+            $values = array();
+
+            foreach ($array->getValue() as $value) {
+                if ($value instanceof NodeInterface) {
+                    $values[] = $value->getPath();
+                } else if (is_object($value)) {
+                    $values[] = '<UNKNOWN OBJECT>';
+                } else {
+                    $values[] = $value;
+                }
+            }
 
-            return "\n     - " . implode("\n     - ", $value->getvalue());
+            return "\n     - " . implode("\n     - ", $values);
         }
 
         switch (intval($value->getType())) {