Merge branch 'master' into bugfix/fix-for-non-integer-key-models

specialtactics · specialtactics · commit d33cacaa3808 · 2019-09-13T15:33:51.000+10:00
# Conflicts:
#	composer.json
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .idea
 /vendor
 composer.lock
+.vscode
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -9,18 +9,6 @@ filter:
 
 build:
   nodes:
-    php71:
-      environment:
-        php:
-          version: 7.1.3
-      tests:
-        override:
-          - php-scrutinizer-run
-          -
-            command: vendor/bin/phpunit --coverage-clover=coverage71
-            coverage:
-              file: coverage71
-              format: php-clover
     php72:
       environment:
         php:
diff --git a/.travis.yml b/.travis.yml
@@ -5,7 +5,6 @@ env:
 language: php
 
 php:
-    - 7.1
     - 7.2
 
 before_script:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## v9.0.0 (2019-03-02)
+### Added
+- Illuminate 5.8 support
+
 ## v8.0.4 (2018-11-20)
 ### Changed
 - Make the `auditable()` and `user()` method return types loose
diff --git a/README.md b/README.md
@@ -22,7 +22,8 @@ The package documentation can be found on the [official website](http://laravel-
 ## Version Information
  Version   | Illuminate    | Status                  | PHP Version
 :----------|:--------------|:------------------------|:------------
- 8.x       | 5.2.x - 5.7.x | Active support :rocket: | >= 7.0.13
+ 9.x       | 5.8.x - 6.x.x | Active support :rocket: | >= 7.1.3
+ 8.x       | 5.2.x - 5.7.x | Active support          | >= 7.0.13
  7.x       | 5.2.x - 5.6.x | End of life             | >= 7.0.13
  6.x       | 5.2.x - 5.6.x | End of life             | >= 7.0.13
  5.x       | 5.2.x - 5.5.x | End of life             | >= 7.0.13
diff --git a/composer.json b/composer.json
@@ -39,13 +39,14 @@
         }
     ],
     "require": {
-        "php": ">=7.1.3",
-        "illuminate/console": "^5.8",
-        "illuminate/database": "^5.8",
-        "illuminate/filesystem": "^5.8"
+        "php": ">=7.2",
+        "illuminate/console": "^5.8|^6.0",
+        "illuminate/database": "^5.8|^6.0",
+        "illuminate/filesystem": "^5.8|^6.0",
+        "laravel/helpers": "^1.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5",
+        "phpunit/phpunit": "^8.0",
         "mockery/mockery": "^1.0",
         "orchestra/testbench": "^3.8",
         "ramsey/uuid": "^3.0"
@@ -65,12 +66,14 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "8.0-dev"
+            "dev-master": "9.0-dev"
         },
         "laravel": {
             "providers": [
                 "OwenIt\\Auditing\\AuditingServiceProvider"
             ]
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }
diff --git a/config/audit.php b/config/audit.php
@@ -2,6 +2,8 @@
 
 return [
 
+    'enabled' => env('AUDITING_ENABLED', true),
+
     /*
     |--------------------------------------------------------------------------
     | Audit Implementation
diff --git a/database/migrations/audits.stub b/database/migrations/audits.stub
@@ -14,7 +14,7 @@ class CreateAuditsTable extends Migration
     public function up()
     {
         Schema::create('audits', function (Blueprint $table) {
-            $table->increments('id');
+            $table->bigIncrements('id');
             $table->string('user_type')->nullable();
             $table->unsignedBigInteger('user_id')->nullable();
             $table->string('event');
@@ -23,10 +23,10 @@ class CreateAuditsTable extends Migration
             $table->text('new_values')->nullable();
             $table->text('url')->nullable();
             $table->ipAddress('ip_address')->nullable();
-            $table->string('user_agent')->nullable();
+            $table->string('user_agent', 1023)->nullable();
             $table->string('tags')->nullable();
             $table->timestamps();
-			
+
             $table->index(['user_id', 'user_type']);
         });
     }
diff --git a/src/Audit.php b/src/Audit.php
@@ -3,8 +3,9 @@
 namespace OwenIt\Auditing;
 
 use DateTimeInterface;
-use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Str;
 use Illuminate\Support\Facades\Config;
+use Illuminate\Database\Eloquent\Model;
 use OwenIt\Auditing\Contracts\AttributeEncoder;
 
 trait Audit
@@ -146,12 +147,12 @@ public function getDataValue(string $key)
         $value = $this->data[$key];
 
         // User value
-        if ($this->user && starts_with($key, 'user_')) {
+        if ($this->user && Str::startsWith($key, 'user_')) {
             return $this->getFormattedValue($this->user, substr($key, 5), $value);
         }
 
         // Auditable value
-        if ($this->auditable && starts_with($key, ['new_', 'old_'])) {
+        if ($this->auditable && Str::startsWith($key, ['new_', 'old_'])) {
             $attribute = substr($key, 4);
 
             return $this->getFormattedValue(
diff --git a/src/Auditable.php b/src/Auditable.php
@@ -46,7 +46,7 @@ trait Auditable
      */
     public static function bootAuditable()
     {
-        if (static::isAuditingEnabled()) {
+        if (!self::$auditingDisabled && static::isAuditingEnabled()) {
             static::observe(new AuditableObserver());
         }
     }
@@ -284,8 +284,8 @@ public function toAudit(): array
             'event'              => $this->auditEvent,
             'auditable_id'       => $this->getKey(),
             'auditable_type'     => $this->getMorphClass(),
-            $morphPrefix.'_id'   => $user ? $user->getAuthIdentifier() : null,
-            $morphPrefix.'_type' => $user ? $user->getMorphClass() : null,
+            $morphPrefix . '_id'   => $user ? $user->getAuthIdentifier() : null,
+            $morphPrefix . '_type' => $user ? $user->getMorphClass() : null,
             'url'                => $this->resolveUrl(),
             'ip_address'         => $this->resolveIpAddress(),
             'user_agent'         => $this->resolveUserAgent(),
@@ -488,7 +488,7 @@ public static function isAuditingEnabled(): bool
             return Config::get('audit.console', false);
         }
 
-        return true;
+        return Config::get('audit.enabled', true);
     }
 
     /**
diff --git a/src/AuditingServiceProvider.php b/src/AuditingServiceProvider.php
@@ -4,8 +4,10 @@
 
 use Illuminate\Contracts\Support\DeferrableProvider;
 use Illuminate\Support\ServiceProvider;
-use OwenIt\Auditing\Console\AuditDriverMakeCommand;
+
 use OwenIt\Auditing\Contracts\Auditor;
+use OwenIt\Auditing\Console\AuditDriverCommand;
+use OwenIt\Auditing\Console\InstallCommand;
 
 class AuditingServiceProvider extends ServiceProvider implements DeferrableProvider
 {
@@ -16,19 +18,8 @@ class AuditingServiceProvider extends ServiceProvider implements DeferrableProvi
      */
     public function boot()
     {
-        $config = __DIR__.'/../config/audit.php';
-        $migration = __DIR__.'/../database/migrations/audits.stub';
-
-        // Lumen lacks a config_path() helper, so we use base_path()
-        $this->publishes([
-            $config => base_path('config/audit.php'),
-        ], 'config');
-
-        $this->publishes([
-            $migration => database_path(sprintf('migrations/%s_create_audits_table.php', date('Y_m_d_His'))),
-        ], 'migrations');
-
-        $this->mergeConfigFrom($config, 'audit');
+        $this->registerPublishing();
+        $this->mergeConfigFrom(__DIR__.'/../config/audit.php', 'audit');
     }
 
     /**
@@ -39,14 +30,36 @@ public function boot()
     public function register()
     {
         $this->commands([
-            AuditDriverMakeCommand::class,
+            AuditDriverCommand::class,
+            InstallCommand::class,
         ]);
 
         $this->app->singleton(Auditor::class, function ($app) {
             return new \OwenIt\Auditing\Auditor($app);
         });
     }
 
+    /**
+     * Register the package's publishable resources.
+     *
+     * @return void
+     */
+    private function registerPublishing()
+    {
+        if ($this->app->runningInConsole()) {
+            // Lumen lacks a config_path() helper, so we use base_path()
+            $this->publishes([
+                __DIR__.'/../config/audit.php' => base_path('config/audit.php'),
+            ], 'config');
+
+            $this->publishes([
+                __DIR__.'/../database/migrations/audits.stub' => database_path(
+                    sprintf('migrations/%s_create_audits_table.php', date('Y_m_d_His'))
+                ),
+            ], 'migrations');
+        }
+    }
+
     /**
      * {@inheritdoc}
      */
diff --git a/src/Console/AuditDriverCommand.php b/src/Console/AuditDriverCommand.php
@@ -4,12 +4,12 @@
 
 use Illuminate\Console\GeneratorCommand;
 
-class AuditDriverMakeCommand extends GeneratorCommand
+class AuditDriverCommand extends GeneratorCommand
 {
     /**
      * {@inheritdoc}
      */
-    protected $name = 'make:audit-driver';
+    protected $name = 'auditing:audit-driver';
 
     /**
      * {@inheritdoc}
diff --git a/src/Console/InstallCommand.php b/src/Console/InstallCommand.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace OwenIt\Auditing\Console;
+
+use Illuminate\Support\Str;
+use Illuminate\Console\Command;
+use Illuminate\Console\DetectsApplicationNamespace;
+
+class InstallCommand extends Command
+{
+    use DetectsApplicationNamespace;
+
+    /**
+     * {@inheritdoc}
+     */
+    protected $signature = 'auditing:install';
+
+    /**
+     * {@inheritdoc}
+     */
+    protected $description = 'Install all of the Auditing resources';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handle()
+    {
+        $this->comment('Publishing Auditing Configuration...');
+        $this->callSilent('vendor:publish', ['--tag' => 'config']);
+
+        $this->comment('Publishing Auditing Migrations...');
+        $this->callSilent('vendor:publish', ['--tag' => 'migrations']);
+
+        $this->registerAuditingServiceProvider();
+
+        $this->info('Auditing installed successfully.');
+    }
+
+    /**
+     * Register the Auditing service provider in the application configuration file.
+     *
+     * @return void
+     */
+    protected function registerAuditingServiceProvider()
+    {
+        $namespace = str_replace_last('\\', '', $this->getAppNamespace());
+
+        $appConfig = file_get_contents(config_path('app.php'));
+
+        if (Str::contains($appConfig, 'OwenIt\\Auditing\\AuditingServiceProvider::class')) {
+            return;
+        }
+
+        file_put_contents(config_path('app.php'), str_replace(
+            "{$namespace}\\Providers\EventServiceProvider::class,".PHP_EOL,
+            "{$namespace}\\Providers\EventServiceProvider::class,".PHP_EOL."        OwenIt\Auditing\AuditingServiceProvider::class,".PHP_EOL,
+            $appConfig
+        ));
+    }
+}
diff --git a/tests/Functional/CommandTest.php b/tests/Functional/CommandTest.php
@@ -18,7 +18,7 @@ public function itWillGenerateTheAuditDriver()
 
         $this->assertInstanceOf(
             \Illuminate\Foundation\Testing\PendingCommand::class,
-            $this->artisan('make:audit-driver', [
+            $this->artisan('auditing:audit-driver', [
                     'name' => 'TestDriver',
                 ]
             )
diff --git a/tests/Unit/AuditableTest.php b/tests/Unit/AuditableTest.php
@@ -67,6 +67,23 @@ public function itWillAlwaysAuditModelsWhenNotRunningFromTheConsole()
         $this->assertTrue(Article::isAuditingEnabled());
     }
 
+    /**
+     * @group Auditable::bootAuditable
+     * @test
+     */
+    public function itWillNotBootTraitWhenStaticFlagIsSet()
+    {
+        App::spy();
+
+        Article::$auditingDisabled = true;
+
+        new Article();
+
+        App::shouldNotHaveReceived('runningInConsole');
+
+        Article::$auditingDisabled = false;
+    }
+
     /**
      * @group Auditable::getAuditEvent
      * @test

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 .idea
 /vendor
 composer.lock
 +.vscode
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ trait Auditable`
`46`	`46`	`*/`
`47`	`47`	`public static function bootAuditable()`
`48`	`48`	`{`
`49`		`- if (static::isAuditingEnabled()) {`
	`49`	`+ if (!self::$auditingDisabled && static::isAuditingEnabled()) {`
`50`	`50`	`static::observe(new AuditableObserver());`
`51`	`51`	`}`
`52`	`52`	`}`
`@@ -284,8 +284,8 @@ public function toAudit(): array`
`284`	`284`	`'event' => $this->auditEvent,`
`285`	`285`	`'auditable_id' => $this->getKey(),`
`286`	`286`	`'auditable_type' => $this->getMorphClass(),`
`287`		`- $morphPrefix.'_id' => $user ? $user->getAuthIdentifier() : null,`
`288`		`- $morphPrefix.'_type' => $user ? $user->getMorphClass() : null,`
	`287`	`+ $morphPrefix . '_id' => $user ? $user->getAuthIdentifier() : null,`
	`288`	`+ $morphPrefix . '_type' => $user ? $user->getMorphClass() : null,`
`289`	`289`	`'url' => $this->resolveUrl(),`
`290`	`290`	`'ip_address' => $this->resolveIpAddress(),`
`291`	`291`	`'user_agent' => $this->resolveUserAgent(),`
`@@ -488,7 +488,7 @@ public static function isAuditingEnabled(): bool`
`488`	`488`	`return Config::get('audit.console', false);`
`489`	`489`	`}`
`490`	`490`
`491`		`- return true;`
	`491`	`+ return Config::get('audit.enabled', true);`
`492`	`492`	`}`
`493`	`493`
`494`	`494`	`/**`