Complete: Installation setup - WIP: Controllers/Views/Routes

Author: chrisjk123

README.md

@@ -87,49 +87,40 @@ This package requires Laravel 5.8 or higher, PHP 7.2 or higher and a database th
 
 ## Installation
 
+> Note: Laravel Blogger requires you to have user authentication in place prior to installation.
+For Laravel 5.* based projects run the `make:auth` Artisan command.
+For Laravel 6.* based projects please see the official guide to get started.
+
 You can install the package via composer:
 
 ```bash
 composer require chrisjk123/laravel-blogger
 ```
 
-Publish the migrations with:
+Publish the primary configuration file using the `blog:install` Artisan command:
 
 ```bash
-php artisan vendor:publish --provider="Chriscreates\Blog\BloggerServiceProvider" --tag="migrations"
-php artisan migrate
-```
-
-You can optionally publish the config file with:
-
-```bash
-php artisan vendor:publish --provider="Chriscreates\Blog\BloggerServiceProvider" --tag="config"
+php artisan blog:install
 ```
 
 This is the contents of the published config file, if your `User` class is
 within a different directory or has a different primary key it can be changed here.
 
-Furthermore, the settings for allowing commenting on posts is set here, the default
-is set to true as well as guest commenting.
-
 ```php
-return [
-    /*
-     * User: the default path to the User model in Laravel and primary key
-     */
-    'user' => [
-        'user_class' => \App\User::class,
-        'user_key_name' => 'id',
-    ],
-
-    /*
-     * Post: allow commenting on posts / allow guest commenting on posts
-     */
-    'posts' => [
-        'allow_comments' => true,
-        'allow_guest_comments' => true,
-    ],
-];
+/*
+|--------------------------------------------------------------------------
+| User relations
+|--------------------------------------------------------------------------
+|
+| This is the default path to the User model in Laravel and primary key.
+| You are free to change this path to anything you like.
+|
+*/
+
+'user' => [
+    'user_class' => \App\User::class,
+    'user_key_name' => 'id',
+],
 ```
 
 ## Local testing
@@ -166,6 +157,34 @@ $user->posts;
 $user->comments;
 ```
 
+Furthermore, in the configuration file, the default is set to true for
+allowing both user and public commenting on posts is set here.
+
+```php
+/*
+ |--------------------------------------------------------------------------
+ | Post commenting options
+ |--------------------------------------------------------------------------
+ |
+ | The default for commenting on posts is enabled, as well as guest
+ | commenting. Feel free to change these conditions to false.
+ |
+ */
+
+'posts' => [
+    'allow_comments' => true,
+    'allow_guest_comments' => true,
+],
+```
+
+You can get setup quickly by using the `blog:setup` Artisan command.
+This publishes the routes, controllers and views. Optionally you can seed the
+database with `factory()` data by specifying the data `blog:setup --data` option.
+
+```bash
+php artisan blog:setup --data
+```
+
 ### Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

database/seeds/PostsTableSeeder.php

@@ -78,7 +78,6 @@ private function handleRoutes()
      */
     private function routeConfiguration()
     {
-        // TODO
         return [
             'namespace' => 'Blog\Http\Controllers',
             'prefix' => config('blog.path'),
@@ -112,11 +111,6 @@ private function handlePublishing()
                 __DIR__.'/../database/factories/' => database_path('factories'),
             ], 'blog-factories');
 
-            // TODO: Are these really needed?
-            $this->publishes([
-                __DIR__.'/../database/seeds/' => database_path('seeds'),
-            ], 'blog-seeders');
-
             $this->publishes([
                 __DIR__.'/../config/blog.php' => config_path('blog.php'),
             ], 'blog-config');

src/BlogServiceProvider.php

@@ -30,8 +30,6 @@ class InstallCommand extends Command
      */
     public function handle()
     {
-        $this->callSilent('vendor:publish', ['--tag' => 'blog-factories']);
-        $this->callSilent('vendor:publish', ['--tag' => 'blog-seeders']);
         $this->callSilent('vendor:publish', ['--tag' => 'blog-config']);
         $this->callSilent('migrate');
 

src/Console/Commands/InstallCommand.php

@@ -17,7 +17,8 @@ class SetupCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'blog:setup {--data : Specifies that demo data should be seeded}';
+    protected $signature = 'blog:setup
+                            {--data : Setup the database with demo data}';
 
     /**
      * The console command description.
@@ -33,17 +34,30 @@ class SetupCommand extends Command
      */
     public function handle()
     {
+        if ( ! file_exists(config_path('blog.php'))) {
+            $this->error("You haven't published the config file.");
+
+            if ($this->confirm('Publish the config file?')) {
+                $this->call('blog:install');
+            } else {
+                return;
+            }
+        }
+
         // TODO:
         // Controllers
         // Routes
         // Views?
 
-        // Optionally seed the database with demo data
         if ($this->option('data')) {
             $this->seed();
+        } elseif ($this->confirm(
+            'Would you like to setup the database with demo data?'
+        )) {
+            $this->seed();
         }
 
-        $this->info('Setup complete');
+        $this->info('Setup complete.');
     }
 
     /**
@@ -53,14 +67,13 @@ public function handle()
      */
     private function seed()
     {
-        // TODO: Check that blog:install has been run before this blog:setup
+        $this->callSilent('vendor:publish', ['--tag' => 'blog-factories']);
 
-        // Publish factories
-        $files = collect(
-            array_diff(scandir(__DIR__.'/../../../database/factories/'), array('.', '..'))
-        )->each(function ($file) {
-            copy(__DIR__."/../../../database/factories/{$file}", database_path('factories')."/{$file}");
-        });
+        // $files = collect(
+        //     array_diff(scandir(__DIR__.'/../../../database/factories/'), array('.', '..'))
+        // )->each(function ($file) {
+        //     copy(__DIR__."/../../../database/factories/{$file}", database_path('factories')."/{$file}");
+        // });
 
         // Create data
         factory(Post::class, 20)

src/Console/Commands/SetupCommand.php

@@ -14,6 +14,6 @@ class StoreViewData
      */
     public function handle(PostViewed $event)
     {
-        logger('something happened.');
+        $event->post->increment('views');
     }
 }