Merge branch 'release/1.0.6'

Author: Diego Hernandes

bin/yoke

@@ -10,29 +10,29 @@ Y_PATH=$(which yokephp)
 Y_PHP_PATH=$(which php)
 
 # If the current command is to connect.
-if [ "$Y_COMMAND" == "connect" ]; then
+if [ "${Y_COMMAND}" == "connect" ]; then
     # save the execution return into a variable for later parsing.
-    Y_RETURN=$($Y_PHP_PATH $Y_PATH $Y_COMMAND $Y_ARGUMENT)
+    Y_RETURN=$(${Y_PHP_PATH} ${Y_PATH} ${Y_COMMAND} ${Y_ARGUMENT})
 else
     # If the command is other than connect, pass through.
-    $Y_PHP_PATH $Y_PATH $Y_COMMAND $Y_ARGUMENT
+    ${Y_PHP_PATH} ${Y_PATH} ${Y_COMMAND} ${Y_ARGUMENT}
     # Define a empty Y_RETURN
     Y_RETURN=""
 fi
 
 # If the return starts with ssh.
-if [[ $Y_RETURN =~ ^ssh.* ]]; then
+if [[ ${Y_RETURN} =~ ^ssh.* ]]; then
     # Execute the returned line into the terminal (connect).
-    $Y_RETURN
+    ${Y_RETURN}
 fi
 
 # If the return starts with Password.
-if [[ $Y_RETURN =~ ^Password.* ]]; then
+if [[ ${Y_RETURN} =~ ^Password.* ]]; then
     # Break the return into the password helper and command variables.
-    Y_PASSWORD_HELPER=$(echo -e "$Y_RETURN" | awk 'NR==1')
-    Y_PASSWORD_COMMAND=$(echo -e "$Y_RETURN" | awk 'NR==2')
+    Y_PASSWORD_HELPER=$(echo -e "${Y_RETURN}" | awk 'NR==1')
+    Y_PASSWORD_COMMAND=$(echo -e "${Y_RETURN}" | awk 'NR==2')
 
     # Display the
-    echo $Y_PASSWORD_HELPER
-    $Y_PASSWORD_COMMAND
-fi
+    echo ${Y_PASSWORD_HELPER}
+    ${Y_PASSWORD_COMMAND}
+fi

src/Console/Commands/AddCommand.php

@@ -1,6 +1,8 @@
 <?php
 
 namespace Yoke\Console\Commands;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
 
 /**
  * Class AddCommand.
@@ -19,20 +21,32 @@ class AddCommand extends BaseCommand
      */
     protected $description = 'Store a new connection configuration.';
 
+    protected $arguments = [
+        ['alias', InputArgument::OPTIONAL, 'Connection Alias'],
+    ];
+
     /**
      * Execute the command.
+     *
+     * @param InputInterface $input
      */
-    protected function fire()
+    protected function fire(InputInterface $input)
     {
         // Greetings.
         $this->info('Registering a new Server Configuration!');
 
         // Read initial connection data.
-        $serverData['alias'] = $this->ask('Server connection alias (server1):', 'server1');
+        if (!$serverData['alias'] = $input->getArgument('alias')) {
+            $serverData['alias'] = $this->ask('Server connection alias (server1):', 'server1');
+        }
+
         $serverData['user'] = $this->ask('Server username (none):');
         $serverData['host'] = $this->ask('Server hostname or IP Address (192.168.0.1):', '192.168.0.1');
         $serverData['port'] = $this->ask('Server Port (22):', 22);
-        $serverData['authenticationMethod'] = $this->ask('Authentication Method:[system|key|password] (system):', 'system');
+        $serverData['authenticationMethod'] = $this->ask(
+            'Authentication Method:[system|key|password] (system):',
+            'system'
+        );
 
         if ($serverData['authenticationMethod'] == 'key') {
             // Ask for private key if key was selected as authentication method.

src/Console/Commands/BaseCommand.php

@@ -55,8 +55,10 @@ abstract class BaseCommand extends Command
     /**
      * Main Command method, calls the fire command on it's child commands.
      *
-     * @param InputInterface  $input  Application provided input handler.
+     * @param InputInterface $input Application provided input handler.
      * @param OutputInterface $output Application provided output handler.
+     *
+     * @return int|null|void
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -71,7 +73,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $this->manager = new Manager();
 
         // Call the child command fire() method.
-        $this->fire();
+        return $this->fire($input);
     }
 
     /**
@@ -93,15 +95,19 @@ protected function configure()
 
     /**
      * Abstract fire method to be implemented on child commands.
+     *
+     * @param InputInterface $input
+     *
+     * @return
      */
-    abstract protected function fire();
+    abstract protected function fire(InputInterface $input);
 
     /**
      * Abstracts the question process into a single method.
      * Some options are defined by convention, like formatting.
-     * 
-     * @param string $question The question being asked. 
-     * @param null   $default  Default value in case the user does not provide an answer.
+     *
+     * @param string $question The question being asked.
+     * @param null $default Default value in case the user does not provide an answer.
      *
      * @return string The user input or the default value.
      */
@@ -116,10 +122,10 @@ protected function ask($question, $default = null)
 
     /**
      * Asks a Confirmation (Yes/No) Question.
-     * 
+     *
      * Inputs like Y, Yes will make this method return true.
      * Any other input will return false.
-     * 
+     *
      * @param string $question The question to be confirmed.
      *
      * @return bool Confirmed or Not.
@@ -149,7 +155,7 @@ protected function format($text, $type = 'info')
     /**
      * Write a string into the console output.
      *
-     * @param string $text   The string to be displayed.
+     * @param string $text The string to be displayed.
      * @param string $format The coloring format.
      */
     protected function writeln($text, $format = 'info')
@@ -160,7 +166,7 @@ protected function writeln($text, $format = 'info')
 
     /**
      * Write a not formatted string into the console output.
-     * 
+     *
      * @param string $text The string to be displayed.
      */
     protected function writelnPlain($text)

src/Console/Commands/ConnectCommand.php

@@ -3,6 +3,7 @@
 namespace Yoke\Console\Commands;
 
 use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
 
 class ConnectCommand extends BaseCommand
 {
@@ -26,8 +27,10 @@ class ConnectCommand extends BaseCommand
 
     /**
      * Execute the command.
+     *
+     * @param InputInterface $input
      */
-    protected function fire()
+    protected function fire(InputInterface $input)
     {
         // Gets the desired connection alias.
         $alias = $this->argument('alias');

src/Console/Commands/DeleteCommand.php

@@ -3,6 +3,7 @@
 namespace Yoke\Console\Commands;
 
 use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
 
 /**
  * Class DeleteCommand.
@@ -29,7 +30,12 @@ class DeleteCommand extends BaseCommand
         ['alias', InputArgument::REQUIRED, 'The connection to be removed.'],
     ];
 
-    protected function fire()
+    /**
+     * Execute the command.
+     *
+     * @param InputInterface $input
+     */
+    protected function fire(InputInterface $input)
     {
         // Find the server.
         $alias = $this->argument('alias');

src/Console/Commands/ServersCommand.php

@@ -3,6 +3,7 @@
 namespace Yoke\Console\Commands;
 
 use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputInterface;
 use Yoke\Servers\Exceptions\NotFoundException;
 
 /**
@@ -24,16 +25,18 @@ class ServersCommand extends BaseCommand
 
     /**
      * Execute the command.
+     *
+     * @param InputInterface $input
      */
-    protected function fire()
+    protected function fire(InputInterface $input)
     {
         // Get the available servers.
         $servers = $this->manager->getServers();
 
         // If there is no servers registered.
         if (!count($servers)) {
             throw new NotFoundException('No servers available.');
-        // Otherwise.
+            // Otherwise.
         } else {
             // Render the servers table.
             $this->serversTable($servers);
@@ -55,6 +58,7 @@ protected function serversTable(array $servers)
 
         // Loop on available connections to build the rows.
         $rows = [];
+
         foreach ($servers as $server) {
             $rows[] = [$server->alias, $server->host, $server->user, $server->port, $server->authenticationMethod];
         }

src/Servers/Manager.php

@@ -7,7 +7,7 @@
 
 /**
  * Class Manager.
- * 
+ *
  * Server connections manager.
  */
 class Manager
@@ -50,22 +50,22 @@ protected function loadServers()
 
     /**
      * Register a configuration array as a server instance.
-     * 
+     *
      * @param array $data Server connection information.
      */
     public function registerServer(array $data)
     {
-        // Generate a new server connection instance. 
+        // Generate a new server connection instance.
         $server = new Server($data);
 
-        // Register the server connection into the servers list. 
+        // Register the server connection into the servers list.
         $this->servers[$server->alias] = $server;
     }
 
     /**
      * Create a server connection instance with the provided configuration
      * data and write the configuration server with the updated information.
-     * 
+     *
      * @param array $data Server connection information.
      */
     public function createServer(array $data)
@@ -79,7 +79,7 @@ public function createServer(array $data)
 
     /**
      * Deletes a server connection from instance and storage.
-     * 
+     *
      * @param string $alias Alias of the server connection to be deleted.
      */
     public function deleteServer($alias)
@@ -111,7 +111,7 @@ protected function writeServers()
 
     /**
      * Get a server instance.
-     * 
+     *
      * @param string $alias Server connection alias.
      *
      * @return Server The Server connection instance.
@@ -129,7 +129,7 @@ public function getServer($alias)
 
     /**
      * Get all the server connection instances.
-     * 
+     *
      * @return array A array containing all the server connection instances.
      */
     public function getServers()
@@ -139,8 +139,8 @@ public function getServers()
 
     /**
      * Is a given connection alias registered?
-     * 
-     * @param string $alias The given server connection instance alias. 
+     *
+     * @param string $alias The given server connection instance alias.
      *
      * @return bool Registered or not.
      */

src/Servers/Server.php

@@ -69,8 +69,8 @@ public function __construct(array $config)
     /**
      * Magic __set method.
      *
-     * @param string $key   Attribute name.
-     * @param mixed  $value Attribute value
+     * @param string $key Attribute name.
+     * @param mixed $value Attribute value
      */
     public function __set($key, $value)
     {

src/Storage/Manager.php

@@ -76,8 +76,8 @@ public function getConfiguration($type = 'servers')
 
     /**
      * Write a given array into a encrypted storage file.
-     * 
-     * @param array  $data The data to be stored.
+     *
+     * @param array $data The data to be stored.
      * @param string $type The actual filename without the .yml extension to store the information.
      */
     public function writeConfiguration(array $data, $type = 'servers')
@@ -134,7 +134,7 @@ protected function path($file = null)
 
     /**
      * Check for a file existence.
-     * 
+     *
      * @param string $file Relative file name.
      *
      * @return bool Exists or not.
@@ -146,8 +146,8 @@ protected function fileExists($file)
 
     /**
      * Create or replace a given file with the given contents.
-     * 
-     * @param string $name     File name.
+     *
+     * @param string $name File name.
      * @param string $contents File contents.
      */
     protected function storeFile($name, $contents)
@@ -157,7 +157,7 @@ protected function storeFile($name, $contents)
 
     /**
      * Reads a given file contents.
-     * 
+     *
      * @param string $name Desired file.
      *
      * @return string The file contents.