Cleaning up scaffholding, phpstan, readme updates

Author: andrewdrake

README.md

@@ -14,24 +14,49 @@ Automatically encrypt and decrypt database table fields.
 
 You can install the package via composer:
 
-```bash
+``` bash
 composer require venturedrake/laravel-encryptable
 ```
 
 You can publish the config file with:
-```bash
+``` bash
 php artisan vendor:publish --provider="VentureDrake\LaravelEncryptable\LaravelEncryptableServiceProvider" --tag="config"
 ```
 
 ## Usage
 
+Add the trait to your model and your encryptable rules.
 ``` php
-TBC
+<?php
+
+namespace App;
+
+use Illuminate\Database\Eloquent\Model;
+use VentureDrake\LaravelEncryptable\Traits\LaravelEncryptableTrait;
+
+class Person extends Model
+{
+    use LaravelEncryptableTrait;
+    
+    /**
+	 * Laravel Encryptable Rules
+	 *
+	 * @var array
+	 */
+    protected $encryptable = [
+        'first_name',
+        'last_name',
+    ];
+    
+...  
+}
 ```
 
+Now when you store, update or read from the model the first_name and last_name fields will automatically be encrypted and decrypted.
+
 ## Testing
 
-``` bash
+```bash
 composer test
 ```
 

composer.json

@@ -21,13 +21,12 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.17",
         "orchestra/testbench": "^4.0",
-        "phpunit/phpunit": "^8.0",
-        "vimeo/psalm": "^3.11"
+        "phpstan/phpstan": "^0.12.65",
+        "phpunit/phpunit": "^8.0"
     },
     "autoload": {
         "psr-4": {
-            "VentureDrake\\LaravelEncryptable\\": "src",
-            "VentureDrake\\LaravelEncryptable\\Database\\Factories\\": "database/factories"
+            "VentureDrake\\LaravelEncryptable\\": "src"
         }
     },
     "autoload-dev": {
@@ -36,10 +35,10 @@
         }
     },
     "scripts": {
-        "psalm": "vendor/bin/psalm",
         "test": "vendor/bin/phpunit --colors=always",
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage",
-        "format": "vendor/bin/php-cs-fixer fix --allow-risky=no"
+        "format": "vendor/bin/php-cs-fixer fix --allow-risky=no",
+        "analyse": "vendor/bin/phpstan analyse -c phpstan.neon"
     },
     "config": {
         "sort-packages": true
@@ -48,10 +47,7 @@
         "laravel": {
             "providers": [
                 "VentureDrake\\LaravelEncryptable\\LaravelEncryptableServiceProvider"
-            ],
-            "aliases": {
-                "LaravelEncryptable": "VentureDrake\\LaravelEncryptable\\Facades\\LaravelEncryptableFacade"
-            }
+            ]
         }
     },
     "minimum-stability": "dev",

database/factories/ModelFactory.php

@@ -0,0 +1,6 @@
+parameters:
+    level: 6
+    paths:
+        - config
+        - src
+        - tests

database/migrations/create_laravel_encryptable_table.php.stub

@@ -13,40 +13,15 @@ public function boot()
             $this->publishes([
                 __DIR__ . '/../config/laravel-encryptable.php' => config_path('laravel-encryptable.php'),
             ], 'config');
-
-            $this->publishes([
-                __DIR__ . '/../resources/views' => base_path('resources/views/vendor/laravel-encryptable'),
-            ], 'views');
-
-            $migrationFileName = 'create_laravel_encryptable_table.php';
-            if (! $this->migrationFileExists($migrationFileName)) {
-                $this->publishes([
-                    __DIR__ . "/../database/migrations/{$migrationFileName}.stub" => database_path('migrations/' . date('Y_m_d_His', time()) . '_' . $migrationFileName),
-                ], 'migrations');
-            }
-
+            
             $this->commands([
                 LaravelEncryptableCommand::class,
             ]);
         }
-
-        $this->loadViewsFrom(__DIR__ . '/../resources/views', 'laravel-encryptable');
     }
 
     public function register()
     {
         $this->mergeConfigFrom(__DIR__ . '/../config/laravel-encryptable.php', 'laravel-encryptable');
     }
-
-    public static function migrationFileExists(string $migrationFileName): bool
-    {
-        $len = strlen($migrationFileName);
-        foreach (glob(database_path("migrations/*.php")) as $filename) {
-            if ((substr($filename, -$len) === $migrationFileName)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
 }

phpstan.neon

@@ -34,10 +34,5 @@ public function getEnvironmentSetUp($app)
             'database' => ':memory:',
             'prefix' => '',
         ]);
-
-        /*
-        include_once __DIR__.'/../database/migrations/create_laravel_encryptable_table.php.stub';
-        (new \CreatePackageTable())->up();
-        */
     }
 }