docs: Cleaned up docs and added information on using cli

README.md

@@ -9,10 +9,17 @@ composer require aerex/baikal-storage-plugin
 ```
 
 ## Configuration
-Create the `config.yaml` to your webserver. Make sure the file is *writable* by your webserver (e.g Apache, Nginx). For more details on the configuration details see the wiki page.
+You can use the CLI to help you generate a config file or use the example configuration provided in the project. Make sure the file is *writable* by your webserver (e.g Apache, Nginx).
+
+### Use the CLI
+Run the command `./vendor/baikalstorage` and follow the instructions
+
+### Manual
+Copy the `example-config.yaml` file and rename it to `config.yaml`.
 
 ## Usage
-- Add the plugin to `Core/Frameworks/Baikal/Core/Server.php` 
+- Add the plugin to the end of the  `Server.php` file located under `Core/Frameworks/Baikal/Core/Server.php`. For example
+
 ```
-$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin(<absolute/path/of/config/file>))
+$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin(<absolute/path/of/config.yaml)
 ```

composer.json

@@ -16,7 +16,7 @@
         }
     ],
     "bin": [
-      "bin/console"
+      "bin/baikalstorage"
     ],
     "require": {
         "php": ">=5.5",

lib/Commands/CreateConfigFileCommand.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Aerex\BaikalStorage\Commands;
 
 use Symfony\Component\Console\Command\Command;
@@ -12,8 +11,6 @@ use Symfony\Component\Console\Question\ChoiceQuestion;
 use Monolog\Logger as Monolog;
 use Aerex\BaikalStorage\Configs\ConfigBuilder;
 
-
-
 class CreateConfigFileCommand extends Command {
   protected $io;
 
@@ -48,22 +45,46 @@ class CreateConfigFileCommand extends Command {
       ->setDescription('Create baikal storage plugin configuration file');
     }
 
+  protected function autocompleteFilePathCallback(string $input): array {
+      // Strip any characters from the last slash to the end of the string
+      // to keep only the last directory and generate suggestions for it
+      $inputPath = preg_replace('%(/|^)[^/]*$%', '$1', $input);
+      $inputPath = '' === $inputPath ? '.': $inputPath;
+
+      $foundFilesAndDirs = scandir($inputPath) ?: [];
+
+      // Excluded restricted directories
+      $restrictedDirs = ['dev', 'bin', 'boot', 'etc', 'input', 'lib',
+          'lib64', 'mnt', 'proc', 'run', 'sbin', 'sys', 'srv', 'usr', 'var'];
+      $foundSafeFileAndDirs = array_diff($foundFilesAndDirs, $restrictedDirs);
+
+      return array_map(function($dirOrFile) use ($inputPath) {
+          return $inputPath.$dirOrFile;
+      }, $foundSafeFileAndDirs);
+  }
+
   protected function execute(InputInterface $input, OutputInterface $output) {
     $this->io = new SymfonyStyle($input, $output);
 
     $this->io->title('Baikal Storage Plugin Configuration Creation');
 
-    $filePath = $this->io->askQuestion(new Question('Where to create `config.yaml` configuration file?'));
+    // TODO: move create config file code block to function
-    $this->fullFilePath = $this->verifyFileCanBeCreated($filePath, CreateConfigFileCommand::$CONFIG_FILE_NAME);
+    $question = new Question('Where to create `config.yaml` configuration file?');
+    $question->setAutocompleterCallback($this->autocompleteFilePathCallback);
+    $filePath = $this->io->askQuestion($question);
 
-    $this
+    try {
-      ->setupGeneralConfigs()
+        $this->fullFilePath = $this->verifyAndCreateFile($filePath, CreateConfigFileCommand::$CONFIG_FILE_NAME);
-      ->setupStorages()
+        $this->setupGeneralConfigs()
-      ->saveConfigs();
+            ->setupStorages()
+            ->saveConfigs();
+    } catch (\Exception $e) {
+        return Command::FAILURE;
+    }
 
-    // or return this if some error happened during the execution
+    $this->output->writeln("`config.yaml file created at $filePath");
-    // (it's equivalent to returning int(1))
+
-    // return Command::FAILURE;
+    return Command::SUCCESS;
   }
 
   protected function getStorageNames() {
@@ -78,7 +99,7 @@ class CreateConfigFileCommand extends Command {
     return $storages;
   }
 
-  protected function verifyFileCanBeCreated($filePath, $fileName) {
+  protected function verifyAndCreateFile($filePath, $fileName) {
     if (empty($filePath)) {
       throw new \RuntimeException('Configuration file path cannot be empty');
     }
@@ -105,7 +126,7 @@ class CreateConfigFileCommand extends Command {
     if ($this->io->confirm('Enable logging?')) {
       $this->configs['general']['logger'] = [];
       $logFilePath = $this->io->askQuestion(new Question('Where to create log file?'));
-      $this->configs['general']['logger']['file'] = $this->verifyFileCanBeCreated($logFilePath, CreateConfigFileCommand::$LOGGER_FILE_NAME);
+      $this->configs['general']['logger']['file'] = $this->verifyAndCreateFile($logFilePath, CreateConfigFileCommand::$LOGGER_FILE_NAME);
 
       $logLevelChoiceQuestion = new ChoiceQuestion('Log level (defaults to ERROR)', array_keys(Monolog::getLevels()), 4);
       $logLevelChoiceQuestion->setErrorMessage('Log level %s is invalid');
@@ -134,5 +155,4 @@ class CreateConfigFileCommand extends Command {
     $configBuilder = new ConfigBuilder($this->fullFilePath);
     $configBuilder->saveConfigs($this->configs);
   }
-
 }