Added ConfigInitCommand

todo: Load the alias configuration file somehow

Author: dantleech

spec/PHPCR/Shell/Console/Helper/ConfigHelperSpec.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace spec\PHPCR\Shell\Console\Helper;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class ConfigHelperSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('PHPCR\Shell\Console\Helper\ConfigHelper');
+    }
+
+    function it_should_have_a_method_to_get_the_users_config_directory()
+    {
+        putenv('PHPCRSH_HOME=/home/foobar');
+        $this->getConfigDir()->shouldReturn('/home/foobar');
+    }
+}

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

@@ -102,6 +102,8 @@
 use Symfony\Component\Console\Formatter\OutputFormatter;
 use Symfony\Component\Console\Formatter\OutputFormatterStyle;
 use Symfony\Component\Console\Input\ArrayInput;
+use PHPCR\Shell\Console\Command\Shell\ConfigInitCommand;
+use PHPCR\Shell\Console\Helper\ConfigHelper;
 
 class ShellApplication extends Application
 {
@@ -153,6 +155,7 @@ public function init()
         $this->getHelperSet()->set(new NodeHelper($this->session));
         $this->getHelperSet()->set(new PathHelper($this->session));
         $this->getHelperSet()->set(new RepositoryHelper($this->session->getRepository()));
+        $this->getHelperSet()->set(new ConfigHelper());
 
         // add new commands
         $this->add(new AccessControlPrivilegeListCommand());
@@ -225,6 +228,7 @@ public function init()
         $this->add(new LockUnlockCommand());
 
         // add shell-specific commands
+        $this->add(new ConfigInitCommand());
         $this->add(new PathChangeCommand());
         $this->add(new PathShowCommand());
         $this->add(new ExitCommand());

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

@@ -0,0 +1,64 @@
+<?php
+
+namespace PHPCR\Shell\Console\Command\Shell;
+
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ConfigInitCommand extends Command
+{
+    protected $output;
+
+    public function configure()
+    {
+        $this->setName('shell:config:init');
+        $this->setDescription('Initialize a local configuration with default values');
+        $this->setHelp(<<<EOT
+Initialize a new configuration folder, <info>.phpcrsh</info> in the users HOME directory.
+EOT
+        );
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        $this->output = $output;
+        $this->configHelper = $this->getHelper('config');
+
+        $fs = new Filesystem();
+        if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
+            $output->writeln('<error>This feature is currently only supported on Linux and OSX (maybe). Please submit a PR to support it on windows.</error>');
+            return 1;
+        }
+
+        $configDir = $this->configHelper->getConfigDir();
+        $distDir = __DIR__ . '/../../../Resources/config.dist';
+
+        if (!file_exists($configDir)) {
+            $this->logCreation($configDir);
+            $fs->mkdir($configDir);
+        }
+
+        $configFilenames = array(
+            'alias.yml',
+        );
+
+        foreach ($configFilenames as $configFilename) {
+            $srcFile = $distDir . '/' . $configFilename;
+            $destFile = $configDir . '/' . $configFilename;
+
+            if (!file_exists($srcFile)) {
+                throw new \Exception('Dist (source) file "' . $srcFile . '" does not exist.');
+            }
+
+            $fs->copy($srcFile, $destFile);
+            $this->logCreation($destFile);
+        }
+    }
+
+    private function logCreation($path)
+    {
+        $this->output->writeln('<info>[+]</info> ' . $path);
+    }
+}

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

@@ -0,0 +1,49 @@
+<?php
+
+namespace PHPCR\Shell\Console\Helper;
+
+use Symfony\Component\Console\Helper\Helper;
+
+class ConfigHelper extends Helper
+{
+    public function getName()
+    {
+        return 'config';
+    }
+
+    /**
+     * Return the configuration directory
+     *
+     * @return string
+     */
+    public function getConfigDir()
+    {
+        $home = getenv('PHPCRSH_HOME');
+
+        if ($home) {
+            return $home;
+        }
+
+        // handle windows ..
+        if (defined('PHP_WINDOWS_VERSION_MAJOR')) {
+            if (!getenv('APPDATA')) {
+                throw new \RuntimeException(
+                    'The APPDATA or phpcrsh_HOME environment variable must be set for phpcrsh to run correctly'
+                );
+            }
+            $home = strtr(getenv('APPDATA'), '\\', '/').'/phpcrsh';
+
+            return $home;
+        }
+
+        if (!getenv('HOME')) {
+            throw new \RuntimeException(
+                'The HOME or phpcrsh_HOME environment variable must be set for phpcrsh to run correctly'
+            );
+        }
+
+        $home = rtrim(getenv('HOME'), '/').'/.phpcrsh';
+
+        return $home;
+    }
+}

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

@@ -0,0 +1,27 @@
+# MySQL commands
+use: workspace:use
+"show databases": workspace:list
+select: query:select {args}
+
+# Filesystem commands
+cd: shell:change-path {args}
+rm: node:delete {args}
+mv: node:move {args}
+
+ls: node:list .
+sl: node:clone %arg1% %arg2% # symlink, like ln -s
+cat: node:property:show %arg1%
+
+# Editor commands
+vim: node:property:edit %arg1%
+nano: node:property:edit %arg1%
+
+# GNU commands
+man: help %arg1%
+
+# Version commands
+checkin: node:version:checkin
+checkout: node:version:checkout %arg1%
+checkpoint: node:version:checkpoint %arg1%
+checkpoint: node:version:checkpoint %arg1%
+lsversion: node:version:list %arg1%