Merge pull request #30 from larapack/improve-setup-flow

Improve setup flow

Author: marktopper

.travis.yml

@@ -19,4 +19,4 @@ before_script:
   - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
 
 script:
-  - vendor/bin/phpunit --stop-on-failure
+  - vendor/bin/phpunit

src/Commands/InstallCommand.php

@@ -7,7 +7,7 @@
 
 class InstallCommand extends Command
 {
-    protected $signature = 'hook:install {name} {version?} {--enable}';
+    protected $signature = 'hook:install {name} {version?} {--enable} {--no-migrate} {--no-seed} {--no-publish}';
 
     protected $description = 'Download and install a hook from remote https://larapack.io';
 
@@ -29,7 +29,13 @@ public function handle()
     {
         $name = $this->argument('name');
 
-        $this->hooks->install($name, $this->argument('version'));
+        $this->hooks->install(
+            $name,
+            $this->argument('version'),
+            !$this->option('no-migrate'),
+            !$this->option('no-seed'),
+            !$this->option('no-publish')
+        );
 
         if ($this->option('enable')) {
             $this->hooks->enable($name);

src/Commands/UninstallCommand.php

@@ -7,7 +7,7 @@
 
 class UninstallCommand extends Command
 {
-    protected $signature = 'hook:uninstall {name} {--delete}';
+    protected $signature = 'hook:uninstall {name} {--delete} {--no-unmigrate} {--no-unseed} {--no-unpublish}';
 
     protected $description = 'Uninstall a hook';
 
@@ -29,7 +29,13 @@ public function handle()
     {
         $name = $this->argument('name');
 
-        $this->hooks->uninstall($name, $this->option('delete'));
+        $this->hooks->uninstall(
+            $name,
+            $this->option('delete'),
+            !$this->option('no-unmigrate'),
+            !$this->option('no-unseed'),
+            !$this->option('no-unpublish')
+        );
 
         $this->info("Hook [{$name}] have been uninstalled.");
     }

src/Commands/UpdateCommand.php

@@ -7,7 +7,7 @@
 
 class UpdateCommand extends Command
 {
-    protected $signature = 'hook:update {name} {version?}';
+    protected $signature = 'hook:update {name} {version?} {--no-migrate} {--no-seed} {--no-publish} {--force}';
 
     protected $description = 'Update a hook';
 
@@ -35,10 +35,17 @@ public function handle()
 
         $hook = $hooks->where('name', $name)->first();
 
-        if ($this->hooks->update($name, $version)) {
-            return $this->info("Hook [{$name}] have been updated!");
-        }
-
-        return $this->info('Nothing to update.');
+        $updated = $this->hooks->update(
+            $name,
+            $version,
+            !$this->option('no-migrate'),
+            !$this->option('no-seed'),
+            !$this->option('no-publish'),
+            $this->option('force')
+        );
+
+        return $updated
+            ? $this->info("Hook [{$name}] have been updated!")
+            : $this->info('Nothing to update.');
     }
 }

src/Hook.php

@@ -67,15 +67,18 @@ public function loadComposerJson()
         $this->composerJson = json_decode($this->getComposerJsonFile(), true);
     }
 
-    public function getComposerJsonFile()
+    public function getPath()
     {
-        $path = 'vendor/'.$this->name;
-
         if ($this->isLocal()) {
-            $path = 'hooks/'.$this->name;
+            return base_path('hooks/'.$this->name);
         }
 
-        return $this->filesystem->get(base_path($path.'/composer.json'));
+        return base_path('vendor/'.$this->name);
+    }
+
+    public function getComposerJsonFile()
+    {
+        return $this->filesystem->get($this->getPath().'/composer.json');
     }
 
     public function setLatest($latest)
@@ -106,7 +109,7 @@ public function update(array $parameters)
     public function outdated()
     {
         if (is_null($this->latest)) {
-            $this->latest = app('hooks')->outdated($hook);
+            $this->latest = app('hooks')->outdated($this->name);
         }
 
         return $this->latest != $this->version;

src/Hooks.php

@@ -2,6 +2,7 @@
 
 namespace Larapack\Hooks;
 
+use Illuminate\Filesystem\Filesystem;
 use Illuminate\Foundation\AliasLoader;
 use Illuminate\Support\ServiceProvider;
 
@@ -31,7 +32,12 @@ public function register()
         }
 
         // Register Hooks system and aliases
-        $this->app->singleton(Hooks::class, Hooks::class);
+        $this->app->singleton(Hooks::class, function ($app) {
+            $filesystem = $app[Filesystem::class];
+            $migrator = $app['migrator'];
+
+            return new Hooks($filesystem, $migrator);
+        });
         $this->app->alias(Hooks::class, 'hooks');
     }
 

src/HooksServiceProvider.php

@@ -1,19 +1,34 @@
 {
-  "name": "kebab-case",
-  "description": "This is my first hook.",
-  "require": {
-    "larapack/hooks": "~1.0"
-  },
-  "autoload": {
-    "psr-4": {
-      "StudlyCase\\": "src/"
+    "name": "kebab-case",
+    "description": "This is my first hook.",
+    "require": {
+        "larapack/hooks": "^1.0.5"
+    },
+    "autoload": {
+        "psr-4": {
+            "StudlyCase\\": "src/"
+        }
+    },
+    "extra": {
+        "hook": {
+            "providers": [
+                "StudlyCase\\StudlyCaseServiceProvider"
+            ],
+            "aliases": {
+                "StudlyCase": "StudlyCase\\StudlyCaseFacade"
+            },
+            "migrations": [
+                "resources/database/migrations"
+            ],
+            "seeders": [
+                "resources/database/seeders"
+            ],
+            "unseeders": [
+                "resources/database/unseeders"
+            ],
+            "assets": {
+                "resources/assets": "public/vendor/kebab-case"
+            }
+        }
     }
-  },
-  "extra": {
-    "hook": {
-      "providers": [
-        "StudlyCase\\StudlyCaseServiceProvider"
-      ]
-    }
-  }
 }

stub/composer.json

@@ -0,0 +1 @@
+alert('This is a sample file!');

stub/resources/assets/scripts/alert.js

@@ -0,0 +1,34 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateStudlyCaseTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('snake_case', function (Blueprint $table) {
+            $table->increments('id');
+
+            $table->string('name');
+
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('snake_case');
+    }
+}

stub/resources/database/migrations/.gitkeep

@@ -0,0 +1,26 @@
+<?php
+
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Facades\DB;
+
+class StudlyCaseTableSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        // Don't add data if the data is already there
+        if (DB::table('snake_case')->count() > 0) {
+            return;
+        }
+
+        DB::table('snake_case')->insert([
+            ['name' => 'foo'],
+            ['name' => 'bar'],
+            ['name' => 'baz'],
+        ]);
+    }
+}

stub/resources/database/migrations/MIGRATION_DATE_TIME_create_snake_case_table.php

@@ -0,0 +1,25 @@
+<?php
+
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+
+class StudlyCaseTableUnseeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        // Skip if table does not exists.
+        if (!Schema::hasTable('snake_case')) {
+            return;
+        }
+
+        DB::table('snake_case')
+            ->whereIn('name', ['foo', 'bar', 'baz'])
+            ->delete();
+    }
+}

stub/resources/database/seeders/.gitkeep

@@ -0,0 +1,8 @@
+<?php
+
+namespace StudlyCase;
+
+class StudlyCase
+{
+    //
+}

stub/resources/database/seeders/StudlyCaseTableSeeder.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace StudlyCase;
+
+use Illuminate\Support\Facades\Facade;
+
+class StudlyCaseFacade extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return StudlyCase::class;
+    }
+}

stub/resources/database/unseeders/.gitkeep

@@ -25,6 +25,9 @@ public function setUp()
         // Cleanup old hooks before testing
         $filesystem->deleteDirectory(base_path('hooks'));
 
+        // Cleanup published files
+        $filesystem->deleteDirectory(base_path('public/vendor'));
+
         // Clear old hooks
         $hook = app(Hooks::class);
         $hook->readJsonFile();
@@ -57,6 +60,9 @@ public function setUp()
 
         // Reload JSON files
         app(Hooks::class)->readJsonFile();
+
+        // Migrate
+        $this->artisan('migrate');
     }
 
     public function tearDown()

stub/resources/database/unseeders/StudlyCaseTableUnseeder.php

@@ -0,0 +1,34 @@
+{
+    "name": "local-test-hook",
+    "description": "This is my first hook.",
+    "require": {
+        "larapack/hooks": "^1.0.5"
+    },
+    "autoload": {
+        "psr-4": {
+            "LocalTestHook\\": "src/"
+        }
+    },
+    "extra": {
+        "hook": {
+            "providers": [
+                "LocalTestHook\\LocalTestHookServiceProvider"
+            ],
+            "aliases": {
+                "LocalTestHook": "LocalTestHook\\LocalTestHookFacade"
+            },
+            "migrations": [
+                "resources/database/migrations"
+            ],
+            "seeders": [
+                "resources/database/seeders"
+            ],
+            "unseeders": [
+                "resources/database/unseeders"
+            ],
+            "assets": {
+                "resources/assets": "public/vendor/local-test-hook"
+            }
+        }
+    }
+}

stub/src/StudlyCase.php

@@ -0,0 +1 @@
+alert('This is a sample file!');

stub/src/StudlyCaseFacade.php

@@ -0,0 +1,34 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateLocalTestHookTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('local_test_hook', function (Blueprint $table) {
+            $table->increments('id');
+
+            $table->string('name');
+
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('local_test_hook');
+    }
+}

tests/HooksTest.php

@@ -0,0 +1,26 @@
+<?php
+
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Facades\DB;
+
+class LocalTestHookTableSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        // Don't add data if the data is already there
+        if (DB::table('local_test_hook')->count() > 0) {
+            return;
+        }
+
+        DB::table('local_test_hook')->insert([
+            ['name' => 'foo'],
+            ['name' => 'bar'],
+            ['name' => 'baz'],
+        ]);
+    }
+}

tests/TestCase.php

@@ -0,0 +1,25 @@
+<?php
+
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+
+class LocalTestHookTableUnseeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        // Skip if table does not exists.
+        if (!Schema::hasTable('local_test_hook')) {
+            return;
+        }
+
+        DB::table('local_test_hook')
+            ->whereIn('name', ['foo', 'bar', 'baz'])
+            ->delete();
+    }
+}

tests/fixtures/composer.json

@@ -0,0 +1,8 @@
+<?php
+
+namespace LocalTestHook;
+
+class LocalTestHook
+{
+    //
+}

tests/fixtures/resources/assets/scripts/alert.js

@@ -0,0 +1,18 @@
+<?php
+
+namespace LocalTestHook;
+
+use Illuminate\Support\Facades\Facade;
+
+class LocalTestHookFacade extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return LocalTestHook::class;
+    }
+}

tests/fixtures/resources/database/migrations/.gitkeep

@@ -0,0 +1,28 @@
+<?php
+
+namespace LocalTestHook;
+
+use Illuminate\Support\ServiceProvider;
+
+class LocalTestHookServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //
+    }
+}