Merge pull request #7 from farzai/add-coverage

Refactor code

Author: parsilver

.gitignore

@@ -13,3 +13,4 @@ psalm.xml
 vendor
 .php-cs-fixer.cache
 .env
+**/.DS_Store

README.md

@@ -1,14 +1,14 @@
 # Viola PHP
 
+![Example CLI](assets/example.png)
+
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/farzai/viola.svg?style=flat-square)](https://packagist.org/packages/farzai/viola)
 [![Tests](https://img.shields.io/github/actions/workflow/status/farzai/viola-php/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/farzai/viola-php/actions/workflows/run-tests.yml)
 [![Total Downloads](https://img.shields.io/packagist/dt/farzai/viola.svg?style=flat-square)](https://packagist.org/packages/farzai/viola)
 
 
 Viola is a PHP package that allows you to ask questions to ChatGPT and get the answer with your own data.
 
-![Example CLI](assets/example.png)
-
 ## Requirements
 
 - PHP >= 8.0
@@ -129,8 +129,8 @@ use Farzai\Viola\Viola;
 $viola = Viola::builder()
     ->setApiKey(string $key)
     ->setDatabaseConfig(string $driver, array $databaseConfig)
-    ->setClient(\Psr\Http\Client\ClientInterface $client)
-    ->setLogger(\Psr\Log\LoggerInterface $logger)
+    ->setClient(\Psr\Http\Client\ClientInterface $client) // Optional
+    ->setLogger(\Psr\Log\LoggerInterface $logger) // Optional
     ->build();
 
 // Ask a question to ChatGPT.

bin/viola

@@ -7,18 +7,24 @@ if (file_exists(__DIR__.'/../../../autoload.php')) {
     require __DIR__.'/../vendor/autoload.php';
 }
 
+
+$storage = new Farzai\Viola\Storage\CacheFilesystemStorage();
+$databaseConfig = new Farzai\Viola\Storage\DatabaseConnectionRepository(
+    new Farzai\Viola\Storage\CacheFilesystemStorage()
+);
+
 $commands = [
-    Farzai\Viola\Commands\Config::class,
-    Farzai\Viola\Commands\ClearConfig::class,
-    Farzai\Viola\Commands\ShowConfig::class,
-    Farzai\Viola\Commands\UseConfig::class,
-    Farzai\Viola\Commands\AskQuestion::class,
+    new Farzai\Viola\Commands\Config('config', $storage, $databaseConfig),
+    new Farzai\Viola\Commands\ClearConfig('config:clear', $storage, $databaseConfig),
+    new Farzai\Viola\Commands\ShowConfig('config:show', $storage, $databaseConfig),
+    new Farzai\Viola\Commands\UseConfig('use', $storage, $databaseConfig),
+    new Farzai\Viola\Commands\AskQuestion('ask', $storage, $databaseConfig),
 ];
 
 $application = new Symfony\Component\Console\Application();
 
 foreach ($commands as $command) {
-    $application->add(new $command());
+    $application->add($command);
 }
 
 $application->run();

src/Builder.php

@@ -91,7 +91,7 @@ public function setDatabaseConfig(string $driver, array $config)
 
         if (! in_array($driver, $availableDrivers)) {
             throw new \InvalidArgumentException(
-                "Unsupported driver [{$driver}]"
+                "Unsupported driver [{$driver}]."
             );
         }
 
@@ -145,7 +145,7 @@ public function build(): Viola
         }
 
         if (! $this->connector) {
-            $this->connector = (new ConnectorFactory())->create($this->config['database']['driver']);
+            $this->connector = $this->createConnector($this->config['database']['driver']);
         }
 
         $connection = $this->connector->connect($this->config['database']['connection']);
@@ -157,4 +157,14 @@ public function build(): Viola
             $this->logger,
         );
     }
+
+    /**
+     * Create a connector instance based on the configuration.
+     */
+    private function createConnector(string $driver)
+    {
+        $connector = (new ConnectorFactory())->create($driver);
+
+        return $connector;
+    }
 }

src/Commands/Command.php src/Commands/AbstractCommand.phpsrc/Commands/Command.php renamed to src/Commands/AbstractCommand.php

@@ -10,7 +10,7 @@
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Symfony\Component\Console\Question\Question;
 
-abstract class Command extends SymfonyCommand
+abstract class AbstractCommand extends SymfonyCommand
 {
     protected InputInterface $input;
 

src/Commands/AbstractContextCommand.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Farzai\Viola\Commands;
+
+use Farzai\Viola\Contracts\DatabaseConnectionRepositoryInterface;
+use Farzai\Viola\Contracts\StorageRepositoryInterface;
+
+abstract class AbstractContextCommand extends AbstractCommand
+{
+    public function __construct(
+        string $name,
+        protected StorageRepositoryInterface $storage,
+        protected DatabaseConnectionRepositoryInterface $databaseConfig
+    ) {
+        parent::__construct($name);
+    }
+}

src/Commands/AskQuestion.php

@@ -2,37 +2,21 @@
 
 namespace Farzai\Viola\Commands;
 
-use Farzai\Viola\Storage\CacheFilesystemStorage;
-use Farzai\Viola\Storage\DatabaseConnectionRepository;
 use Farzai\Viola\Viola;
 use Psr\Log\NullLogger;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Logger\ConsoleLogger;
 
-class AskQuestion extends Command
+class AskQuestion extends AbstractContextCommand
 {
-    protected static $defaultName = 'ask';
-
-    /**
-     * @var \Farzai\Viola\Contracts\StorageRepositoryInterface
-     */
-    private $storage;
-
-    /**
-     * @var \Farzai\Viola\Contracts\DatabaseConnectionRepositoryInterface
-     */
-    private $databaseConfig;
-
     protected function configure()
     {
         $this
             ->setDescription('Ask a question to the ChatGPT')
             ->addArgument('question', InputArgument::REQUIRED, 'The question to ask')
             ->setHelp("This command allows you to ask a question to the ChatGPT.\nYou may run `config:show` to see available connections for confirmation.")
+            ->addOption('only-result', null, null, 'Do not display the answer')
             ->addOption('debug', 'd', null, 'Display the debug information');
-
-        $this->storage = new CacheFilesystemStorage();
-        $this->databaseConfig = new DatabaseConnectionRepository(new CacheFilesystemStorage());
     }
 
     protected function handle(): int
@@ -53,13 +37,17 @@ protected function handle(): int
             )
             ->build();
 
-        $response = $viola->ask($question);
+        $response = $viola
+            ->onlyResults((bool) $this->input->getOption('only-result'))
+            ->ask($question);
 
         $this->info($response->getAnswer());
 
-        $this->displayAsTable($response->getResults());
+        if (count($response->getResults())) {
+            $this->displayAsTable($response->getResults());
+        }
 
-        return Command::SUCCESS;
+        return static::SUCCESS;
     }
 
     private function ensureDatabaseIsConfigured()

src/Commands/ClearConfig.php

@@ -2,26 +2,10 @@
 
 namespace Farzai\Viola\Commands;
 
-use Farzai\Viola\Contracts\StorageRepositoryInterface;
-use Farzai\Viola\Storage\CacheFilesystemStorage;
 use Symfony\Component\Console\Input\InputArgument;
 
-class ClearConfig extends Command
+class ClearConfig extends AbstractContextCommand
 {
-    protected static $defaultName = 'config:clear';
-
-    private StorageRepositoryInterface $storage;
-
-    /**
-     * Create a new instance.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-
-        $this->storage = new CacheFilesystemStorage();
-    }
-
     protected function configure()
     {
         $this
@@ -48,28 +32,28 @@ protected function handle(): int
 
                 $this->info('All connections cleared.');
 
-                return Command::SUCCESS;
+                return static::SUCCESS;
             }
 
             $this->info('Cancelled.');
 
-            return Command::SUCCESS;
+            return static::SUCCESS;
         }
 
         if (! $this->storage->has("database.connections.{$connection}")) {
             $this->error("Connection {$connection} does not exist.");
 
-            return Command::FAILURE;
+            return static::FAILURE;
         }
 
         if ($this->confirm("Are you sure you want to clear connection {$connection}?", false)) {
             $this->storage->remove("database.connections.{$connection}");
 
             $this->info("Connection {$connection} cleared.");
 
-            return Command::SUCCESS;
+            return static::SUCCESS;
         }
 
-        return Command::SUCCESS;
+        return static::SUCCESS;
     }
 }

src/Commands/Config.php

@@ -2,26 +2,13 @@
 
 namespace Farzai\Viola\Commands;
 
-use Farzai\Viola\Contracts\DatabaseConnectionRepositoryInterface;
-use Farzai\Viola\Contracts\StorageRepositoryInterface;
 use Farzai\Viola\Database\ConnectorFactory;
-use Farzai\Viola\Storage\CacheFilesystemStorage;
-use Farzai\Viola\Storage\DatabaseConnectionRepository;
 
-class Config extends Command
+class Config extends AbstractContextCommand
 {
-    protected static $defaultName = 'config';
-
-    private StorageRepositoryInterface $storage;
-
-    private DatabaseConnectionRepositoryInterface $databaseConfig;
-
     protected function configure()
     {
         $this->setDescription('Config API key and database connection.');
-
-        $this->storage = new CacheFilesystemStorage();
-        $this->databaseConfig = new DatabaseConnectionRepository(new CacheFilesystemStorage());
     }
 
     protected function handle(): int
@@ -40,7 +27,7 @@ protected function handle(): int
         } else {
             $this->error('API key is required.');
 
-            return Command::FAILURE;
+            return static::FAILURE;
         }
 
         $this->info('Setting up database connection...');
@@ -50,7 +37,7 @@ protected function handle(): int
         if (! $connectionName || empty($connectionName)) {
             $this->error('Database connection name is required.');
 
-            return Command::FAILURE;
+            return static::FAILURE;
         }
 
         $connections = $this->databaseConfig->all();
@@ -62,7 +49,7 @@ protected function handle(): int
                 if (! $this->confirm("Connection {$connectionName} already exists. Do you want to continue edit it?")) {
                     $this->info('Cancelled.');
 
-                    return Command::SUCCESS;
+                    return static::SUCCESS;
                 }
             }
         }
@@ -82,7 +69,7 @@ protected function handle(): int
         if (! isset($stubConfig['drivers'][$driver])) {
             $this->error('Only support '.implode(', ', array_keys($stubConfig['drivers'])).' driver.');
 
-            return Command::FAILURE;
+            return static::FAILURE;
         }
 
         $stubConfig = $stubConfig['drivers'][$driver];
@@ -124,7 +111,7 @@ protected function handle(): int
 
                 $this->info('Connection successful!, Platform: '.$platform);
 
-                return Command::SUCCESS;
+                return static::SUCCESS;
             } catch (\Exception $e) {
                 $this->error('Connection failed!, '.$e->getMessage());
             }
@@ -140,6 +127,6 @@ protected function handle(): int
             }
         }
 
-        return Command::SUCCESS;
+        return static::SUCCESS;
     }
 }

src/Commands/ShowConfig.php

@@ -2,26 +2,11 @@
 
 namespace Farzai\Viola\Commands;
 
-use Farzai\Viola\Contracts\DatabaseConnectionRepositoryInterface;
-use Farzai\Viola\Contracts\StorageRepositoryInterface;
-use Farzai\Viola\Storage\CacheFilesystemStorage;
-use Farzai\Viola\Storage\DatabaseConnectionRepository;
-
-class ShowConfig extends Command
+class ShowConfig extends AbstractContextCommand
 {
-    protected static $defaultName = 'config:show';
-
-    private StorageRepositoryInterface $storage;
-
-    private DatabaseConnectionRepositoryInterface $databaseConfig;
-
     protected function configure()
     {
-        $this
-            ->setDescription('Show current database connection and API key.');
-
-        $this->storage = new CacheFilesystemStorage();
-        $this->databaseConfig = new DatabaseConnectionRepository(new CacheFilesystemStorage());
+        $this->setDescription('Show current database connection and API key.');
     }
 
     protected function handle(): int
@@ -30,7 +15,7 @@ protected function handle(): int
         if (! $apiKey) {
             $this->error('API key is not set.');
 
-            return Command::FAILURE;
+            return static::FAILURE;
         }
 
         $this->info("API Key: <comment>{$apiKey}</comment>");
@@ -49,6 +34,6 @@ protected function handle(): int
             $this->info('Database Connection: <comment>Not set</comment>');
         }
 
-        return Command::SUCCESS;
+        return static::SUCCESS;
     }
 }