Merge pull request #23 from armanist/master

Major refactoring

Author: armanist

README.md

@@ -1,8 +1,5 @@
 # Quantum PHP Framework (project)
 
-- [Website](https://quantum.softberg.org)
-- [Blog](http://blog.softberg.org/category/quantum-php-framework/)
-
 [![Build Status](https://travis-ci.org/softberg/quantum-php-core.svg?branch=master)](https://travis-ci.org/softberg/quantum-php-core)
 [![GitHub](https://img.shields.io/github/license/softberg/quantum-php-core)](https://github.com/softberg/quantum-php-core/blob/master/LICENSE)
 [![Scrutinizer code quality](https://shields.cdn.bka.li/scrutinizer/quality/g/softberg/quantum-php-core)](https://scrutinizer-ci.com/g/softberg/quantum-php-core)

base/Commands/DemoCommand.php

@@ -9,17 +9,19 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.3.0
+ * @since 2.5.0
  */
 
 namespace Base\Commands;
 
+use Symfony\Component\Console\Output\NullOutput;
+use Symfony\Component\Console\Input\ArrayInput;
 use Quantum\Libraries\Storage\FileSystem;
+use Bluemmb\Faker\PicsumPhotosProvider;
 use Quantum\Console\QtCommand;
+use WW\Faker\Provider\Picture;
 use Quantum\Di\Di;
 use Faker\Factory;
-use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Output\NullOutput;
 
 
 /**
@@ -33,92 +35,128 @@ class DemoCommand extends QtCommand
      * Command name
      * @var string
      */
-    protected $name = 'demo:post';
-    protected $faker;
+    protected $name = 'install:demo';
+
     /**
      * Command description
      * @var string
      */
-    protected $description = 'Generates posts.php and users.php files';
+    protected $description = 'Generates demo users and posts';
 
     /**
      * Command help text
      * @var string
      */
-    protected $help = 'The command will generate new posts.php and users.php files';
+    protected $help = 'The command will create 2 new files (users.php and posts.php) and will generate records';
+
+    /**
+     * @var \Faker\Generator
+     */
+    protected $faker;
+
+    /**
+     * How many posts to create
+     */
+    const POST_COUNT = 6;
+
+    /**
+     * Default password for generated users
+     */
+    const DEFAULT_PASSWORD = 'password';
+
+    /**
+     * Command name of create user
+     */
+    const COMMAND_USER_CREATE = 'user:create';
 
+    /**
+     * Command name of create post
+     */
+    const COMMAND_POST_CREATE = 'post:create';
 
+    /**
+     * Command constructor
+     */
     public function __construct()
     {
         parent::__construct();
         $this->faker = Factory::create();
+        $this->faker->addProvider(new PicsumPhotosProvider($this->faker));
     }
 
     /**
-     * @return void
+     * @throws \ReflectionException
      * @throws \Quantum\Exceptions\DiException
+     * @throws \Symfony\Component\VarExporter\Exception\ExceptionInterface
+     * @throws \Exception
      */
     public function exec()
     {
-        $userCommand =  'user:create'; 
-        $postCommand = 'post:create'; 
-       
         $this->createFile('users');
 
-        $adminArguments = $this->createUser('admin');
-        $guestArguments = $this->createUser();
-        
-        $this->runCommand($adminArguments, $userCommand);
-        $this->runCommand($guestArguments, $userCommand);
-      
+        $adminArguments = $this->newUser('admin');
+        $guestArguments = $this->newUser();
+
+        $this->runCommand(self::COMMAND_USER_CREATE, $adminArguments);
+        $this->runCommand(self::COMMAND_USER_CREATE, $guestArguments);
 
         $this->createFile('posts');
 
-        
-        for ($i = 1; $i <= 6; $i++) {
+        for ($i = 1; $i <= self::POST_COUNT; $i++) {
             $postArguments = [
-                '-t' => $this->faker->realText(30),
-                '-d' => $this->faker->realText(),
-                '-i' => $this->faker->imageUrl(480, 480, 'animals', true, 'cats'),
-                '-a' => $adminArguments['-u'],
+                'title' => $this->faker->realText(30),
+                'description' => $this->faker->realText(500),
+                'image' => $this->faker->imageUrl(640, 480, true, 0),
+                'author' => $adminArguments['email'],
             ];
-            $this->runCommand($postArguments, $postCommand);
+
+            $this->runCommand(self::COMMAND_POST_CREATE, $postArguments);
         }
-         
+
     }
 
-    protected function runCommand($arguments, $commandName){
+    /**
+     * Runs the external command
+     * @throws \Exception
+     */
+    protected function runCommand($commandName, $arguments)
+    {
         $command = $this->getApplication()->find($commandName);
-        $greetInput = new ArrayInput($arguments);
-        $output = new NullOutput;
-        $command->run($greetInput, $output);
+        $command->run(new ArrayInput($arguments), new NullOutput);
     }
 
+    /**
+     * Creates new repo file
+     * @throws \ReflectionException
+     * @throws \Symfony\Component\VarExporter\Exception\ExceptionInterface
+     * @throws \Quantum\Exceptions\DiException
+     */
     protected function createFile($file)
     {
         $fs = Di::get(FileSystem::class);
-       
+
         $repositoryDir = BASE_DIR . DS . 'base' . DS . 'repositories';
-        $content = '<?php' . PHP_EOL . PHP_EOL . 'return ' .  export([]) . ';';
+        $content = '<?php' . PHP_EOL . PHP_EOL . 'return ' . export([]) . ';';
 
         $fs->put($repositoryDir . DS . $file . '.php', $content);
 
         $this->info(ucfirst($file) . ' successfully generated');
     }
 
-
-    private function createUser($role = '')
+    /**
+     * Creates new user
+     * @param string $role
+     * @return array
+     */
+    private function newUser(string $role = ''): array
     {
-        $data =
-            [
-                '-f' => $this->faker->name(),
-                '-l' => $this->faker->lastName(),
-                '-r' => $role,
-                '-u' => $this->faker->email(),
-                '-p' => '123456',
-            ];
-
-        return $data;
+        return [
+            'firstname' => $this->faker->name(),
+            'lastname' => $this->faker->lastName(),
+            'role' => $role,
+            'email' => $this->faker->email(),
+            'password' => self::DEFAULT_PASSWORD,
+        ];
     }
 
 

base/Commands/PostCreateCommand.php

@@ -9,7 +9,7 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.3.0
+ * @since 2.5.0
  */
 
 namespace Base\Commands;
@@ -43,40 +43,39 @@ class PostCreateCommand extends QtCommand
      * Command help text
      * @var string
      */
-    protected $help = 'Add title and description to create a post';
+    protected $help = 'Use the following format to create a post record:' . PHP_EOL . 'php qt post:create `Title` `Description` `[Image]` `[Author]`';
 
     /**
-     * Command options
-     * @var array
+     * Command arguments
+     * @var \string[][]
      */
-    protected $options = [
-        ['title', 't', 'required', 'Post title'],
-        ['description', 'd', 'required', 'Post description'],
-        ['image', 'i', 'optional', 'Post image'],
-        ['author', 'a', 'optional', 'Post author'],
+    protected $args = [
+        ['title', 'required', 'Post title'],
+        ['description', 'required', 'Post description'],
+        ['image', 'optional', 'Post image'],
+        ['author', 'optional', 'Post author'],
     ];
 
     /**
-     * @return void
      * @throws \Quantum\Exceptions\DiException
+     * @throws \ReflectionException
      */
     public function exec()
     {
         $serviceFactory = Di::get(ServiceFactory::class);
-
         $postService = $serviceFactory->get(PostService::class);
 
         $post = [
-            'title' => $this->getOption('title'),
-            'content' => $this->getOption('description'),
-            'author' => $this->getOption('author') ? $this->getOption('author') : 'anonymous@qt.com',
-            'image' => $this->getOption('image') ? $this->getOption('image') : null,
+            'title' => $this->getArgument('title'),
+            'content' => $this->getArgument('description'),
+            'author' => $this->getArgument('author') ?: 'anonymous@qt.com',
+            'image' => $this->getArgument('image'),
             'updated_at' => date('m/d/Y H:i')
         ];
 
         $postService->addPost($post);
 
-        $this->info('Post create successfully');
+        $this->info('Post created successfully');
     }
 
 }

base/Commands/PostDeleteCommand.php

@@ -9,7 +9,7 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.3.0
+ * @since 2.5.0
  */
 
 namespace Base\Commands;
@@ -43,19 +43,19 @@ class PostDeleteCommand extends QtCommand
      * Command help text
      * @var string
      */
-    protected $help = 'Provide ID to delete a post';
+    protected $help = 'Use the following format to delete a post:' . PHP_EOL . 'php qt post:delete `Post Id`';
 
     /**
      * Command arguments
-     * @var array
+     * @var \string[][]
      */
     protected $args = [
         ['id', 'required', 'Post ID'],
     ];
 
     /**
-     * @return void
      * @throws \Quantum\Exceptions\DiException
+     * @throws \ReflectionException
      */
     public function exec()
     {

base/Commands/PostShowCommand.php

@@ -9,7 +9,7 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.3.0
+ * @since 2.5.0
  */
 
 namespace Base\Commands;
@@ -38,13 +38,13 @@ class PostShowCommand extends QtCommand
      * Command description
      * @var string
      */
-    protected $description = 'Displays posts';
+    protected $description = 'Displays all posts or a single post';
 
     /**
      * Command help text
      * @var string
      */
-    protected $help = 'Displays all posts or single post on terminal';
+    protected $help = 'Use the following format to display post(s):' . PHP_EOL . 'php qt post:show `[Post Id]`';
 
     /**
      * Command arguments
@@ -55,8 +55,8 @@ class PostShowCommand extends QtCommand
     ];
 
     /**
-     * @return void
      * @throws \Quantum\Exceptions\DiException
+     * @throws \ReflectionException
      */
     public function exec()
     {

base/Commands/PostUpdateCommand.php

@@ -9,7 +9,7 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.3.0
+ * @since 2.5.0
  */
 
 namespace Base\Commands;
@@ -43,7 +43,7 @@ class PostUpdateCommand extends QtCommand
      * Command help text
      * @var string
      */
-    protected $help = 'Find post by ID and update the title or description of post';
+    protected $help = 'Use the following format to update the post:' . PHP_EOL . 'php qt post:update `[Post Id]` -t `Title` -d `Description` [-i `Image`] [-a `Author`]';
 
     /**
      * Command arguments
@@ -60,11 +60,13 @@ class PostUpdateCommand extends QtCommand
     protected $options = [
         ['title', 't', 'required', 'Post title'],
         ['description', 'd', 'required', 'Post description'],
+        ['image', 'i', 'optional', 'Post image'],
+        ['author', 'a', 'optional', 'Post author'],
     ];
 
     /**
-     * @return void
      * @throws \Quantum\Exceptions\DiException
+     * @throws \ReflectionException
      */
     public function exec()
     {
@@ -74,14 +76,19 @@ public function exec()
 
         $id = $this->getArgument('id');
 
+        $post = $postService->getPost($id);
+
         $title = $this->getOption('title');
         $description = $this->getOption('description');
+        $image = $this->getOption('image');
+        $author = $this->getOption('author');
 
         if($title && $description) {
             $post = [
                 'title' => $title,
                 'content' => $description,
-                'author' => 'anonymous@qt.com',
+                'image' => $image ?: $post['image'],
+                'author' => $author ?: $post['author'],
                 'updated_at' => date('m/d/Y H:i')
             ];