Merge pull request #9 from cleaniquecoders/develop

Major updates

Author: nasrulhazim

.gitignore

@@ -10,3 +10,5 @@ Homestead.yaml
 npm-debug.log
 yarn-error.log
 .env
+*.md
+!README.md

.php_cs

@@ -3,6 +3,7 @@ $finder = PhpCsFixer\Finder::create()
     ->notPath('bootstrap/cache')
     ->notPath('storage')
     ->notPath('vendor')
+    ->notPath('node_modules')
     ->in(__DIR__)
     ->name('*.php')
     ->notName('*.blade.php')
@@ -13,12 +14,22 @@ $finder = PhpCsFixer\Finder::create()
 return PhpCsFixer\Config::create()
     ->setRules(array(
         '@Symfony'                          => true,
-        'binary_operator_spaces'            => ['default' => 'align'],
+        'class_definition'                  => [
+            'multiLineExtendsEachSingleLine' => true,
+        ],
+        'ordered_class_elements'            => [
+            'use_trait', 'constant_public', 'constant_protected', 'constant_private', 
+            'property_public', 'property_protected', 'property_private', 'construct', 
+            'destruct', 'magic', 'phpunit', 'method_public', 'method_protected', 
+            'method_private'
+        ],
+        'binary_operator_spaces'            => ['default' => 'align_single_space_minimal'],
         'array_syntax'                      => ['syntax' => 'short'],
         'concat_space'                      => ['spacing' => 'one'],
+        'blank_line_after_namespace'        => true,
         'linebreak_after_opening_tag'       => true,
         'not_operator_with_successor_space' => true,
         'ordered_imports'                   => true,
         'phpdoc_order'                      => true,
     ))
-    ->setFinder($finder);
+    ->setFinder($finder);

README.md

@@ -53,12 +53,35 @@ Create [Google Service Account Credentials](https://console.developers.google.co
 
 ## Usage
 
+### User Accounts
+
+By default, there's no users created. But you can run `php artisan db:seed DevelopmentSeeder` to run create 3 main users - Developer, Administrator and User.
+
+Login details for default users:
+
+1. E-mail : **[email protected]** Password: `developer`
+2. E-mail : **[email protected]** Password: `administrator`
+3. 1. E-mail : **[email protected]** Password: `user`
+
+By default, all newly registered user will be assign role as `user`.
+
+### Access Control
+
+Access control for the application can be configure from `config/acl.php`. It consist of `roles`, `permissions` and `actions`. Default seeder for ACL is in `database/seeds/RolesAndPermissionsSeeder.php`. You may overwrite this as you please.
+
+Seeded roles and permissions based on `database/seeds/RolesAndPermissionsSeeder.php` will have all guards specify in `config/auth.php`.
+
 ### Commands
 
 There's some commands area ready built-in. Others, may refer to respective packages.
 
 - `reload:db` - Run `migrate:fresh --seed` with `profile:seed`. You may extend the usage.
 - `reload:cache` - Recache everything
+- `reload:all` - Run above two commands. Passing `-d` will seed `DevelopementSeeder` - useful for development setup.
+
+### API
+
+This boilerplate make use of Laravel Passport. Managing passport only allowed in for role developer. You can overwrite this behaviour in `routes/web.php`.
 
 ### Helpers
 
@@ -192,6 +215,10 @@ Simply record audit trail on given `$model`, with proper `$message`. You can opt
    ]
 ```
 
+**user()**
+
+The `user()` helper simply return the current logged in user object. The helper will take care your guard.
+
 ## Test
 
 To run the test, type `vendor/bin/phpunit` in your terminal.

app/Console/Commands/ReloadAllCommand.php

@@ -11,7 +11,8 @@ class ReloadAllCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'reload:all';
+    protected $signature = 'reload:all
+                                {--d|dev : Seed development data}';
 
     /**
      * The console command description.
@@ -37,5 +38,15 @@ public function handle()
     {
         $this->call('reload:cache');
         $this->call('reload:db');
+        $this->call('storage:link');
+        $this->call('passport:install', [
+            '--force' => true,
+        ]);
+
+        if ($this->option('dev')) {
+            $this->call('db:seed', [
+                '--class' => 'DevelopmentSeeder',
+            ]);
+        }
     }
 }

app/Http/Kernel.php

@@ -58,5 +58,7 @@ class Kernel extends HttpKernel
         'can'        => \Illuminate\Auth\Middleware\Authorize::class,
         'guest'      => \App\Http\Middleware\RedirectIfAuthenticated::class,
         'throttle'   => \Illuminate\Routing\Middleware\ThrottleRequests::class,
+        'role'       => \Spatie\Permission\Middlewares\RoleMiddleware::class,
+        'permission' => \Spatie\Permission\Middlewares\PermissionMiddleware::class,
     ];
 }

app/Models/User.php

@@ -10,12 +10,13 @@
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
+use Laravel\Passport\HasApiTokens;
 use Spatie\MediaLibrary\HasMedia\Interfaces\HasMediaConversions;
 use Spatie\Permission\Traits\HasRoles;
 
 class User extends Authenticatable implements HasMediaConversions
 {
-    use HasProfile, HasMediaExtended, HasThumbnail, HasRoles, HasSlugExtended, LogsActivityExtended, Notifiable, SoftDeletes;
+    use HasApiTokens, HasProfile, HasMediaExtended, HasThumbnail, HasRoles, HasSlugExtended, LogsActivityExtended, Notifiable, SoftDeletes;
 
     /**
      * Guarded Field.

app/Observers/Kernel.php

@@ -21,7 +21,7 @@ class Kernel
     protected $observeBy = [
         \App\Observers\ReferenceObserver::class => [
         ],
-        \App\Observers\HashidsObserver::class   => [
+        \App\Observers\HashidsObserver::class => [
             \App\Models\User::class,
             \Spatie\MediaLibrary\Media::class,
         ],

app/Providers/AppServiceProvider.php

@@ -15,6 +15,13 @@ public function boot()
         $this->bootProviders();
     }
 
+    /**
+     * Register any application services.
+     */
+    public function register()
+    {
+    }
+
     /**
      * Boot Providers Based On Environments.
      */
@@ -26,11 +33,4 @@ private function bootProviders()
             $this->app->register($provider);
         });
     }
-
-    /**
-     * Register any application services.
-     */
-    public function register()
-    {
-    }
 }

app/Providers/AuthServiceProvider.php

@@ -3,6 +3,7 @@
 namespace App\Providers;
 
 use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
+use Laravel\Passport\Passport;
 
 class AuthServiceProvider extends ServiceProvider
 {
@@ -21,5 +22,7 @@ class AuthServiceProvider extends ServiceProvider
     public function boot()
     {
         $this->registerPolicies();
+
+        Passport::routes();
     }
 }

app/Providers/EventServiceProvider.php

@@ -13,16 +13,16 @@ class EventServiceProvider extends ServiceProvider
      * @var array
      */
     protected $listen = [
-        'Illuminate\Auth\Events\Registered'    => [
+        'Illuminate\Auth\Events\Registered' => [
             'App\Listeners\AssignDefaultRole',
         ],
-        'Illuminate\Auth\Events\Login'         => [
+        'Illuminate\Auth\Events\Login' => [
             'App\Listeners\LogSuccessfulLogin',
         ],
-        'Illuminate\Auth\Events\Failed'        => [
+        'Illuminate\Auth\Events\Failed' => [
             'App\Listeners\LogFailedLogin',
         ],
-        'Illuminate\Auth\Events\Logout'        => [
+        'Illuminate\Auth\Events\Logout' => [
             'App\Listeners\LogSuccessfulLogout',
         ],
         'Illuminate\Auth\Events\PasswordReset' => [