Make version model configurable

mpociot · Sep 6, 2018 · 9abd756 · 9abd756
1 parent d8c3783
commit 9abd756
Show file tree

Hide file tree

Showing 7 changed files with 99 additions and 135 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .DS_Store
 composer.lock
-/vendor/
+/vendor/
+.idea
diff --git a/composer.json b/composer.json
@@ -26,10 +26,9 @@
         "illuminate/support": "~5.3"
     },
     "require-dev": {
-        "phpunit/phpunit": "5.*",
+        "phpunit/phpunit": "7.*",
         "mockery/mockery": "^1.0",
-        "illuminate/database": "~5.3",
-        "illuminate/events": "~5.3"
+        "orchestra/testbench": "^3.7"
     },
     "autoload": {
         "classmap": [
@@ -50,4 +49,4 @@
             ]
         }
     }
-}
+}
diff --git a/src/Mpociot/Providers/ServiceProvider.php → ...Versionable/Providers/ServiceProvider.php b/src/Mpociot/Providers/ServiceProvider.php → ...Versionable/Providers/ServiceProvider.php
@@ -13,6 +13,7 @@ class ServiceProvider extends LaravelServiceProvider
      */
     public function register ()
     {
+        $this->mergeConfigFrom(__DIR__.'/../../../config/config.php', 'versionable');
     }
 
     /**
@@ -22,6 +23,11 @@ public function register ()
      */
     public function boot()
     {
-        $this->loadMigrationsFrom(__DIR__ . '/../../migrations');
+        $this->loadMigrationsFrom(__DIR__ . '/../../../migrations');
+
+
+        $this->publishes([
+            __DIR__.'/../../../config/config.php' => config_path('versionable.php'),
+        ], 'config');
     }
 }
diff --git a/src/Mpociot/Versionable/VersionableTrait.php b/src/Mpociot/Versionable/VersionableTrait.php
@@ -21,9 +21,11 @@ trait VersionableTrait
      */
     protected function getVersionClass()
     {
-        if( property_exists( self::class, 'versionClass') )
-            return $this->versionClass ;
-        return Version::class ;
+        if( property_exists( self::class, 'versionClass') ) {
+            return $this->versionClass;
+        }
+
+        return config('versionable.version_model', Version::class);
     }
 
     /**

diff --git a/src/config/config.php b/src/config/config.php
@@ -0,0 +1,12 @@
+<?php
+
+return [
+
+    /*
+     * The version model to use.
+     * Feel free to change this, if you need specific version
+     * model logic.
+     */
+    'version_model' => \Mpociot\Versionable\Version::class
+
+];
diff --git a/tests/VersionableTest.php b/tests/VersionableTest.php
@@ -11,20 +11,6 @@
 class VersionableTest extends VersionableTestCase
 {
 
-    public function setUp()
-    {
-        parent::setUp();
-
-        TestVersionableUser::flushEventListeners();
-        TestVersionableUser::boot();
-
-        TestVersionableSoftDeleteUser::flushEventListeners();
-        TestVersionableSoftDeleteUser::boot();
-
-        TestPartialVersionableUser::flushEventListeners();
-        TestPartialVersionableUser::boot();
-    }
-
     public function tearDown()
     {
         m::close();
@@ -33,9 +19,6 @@ public function tearDown()
 
     public function testVersionableRelation()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -49,9 +32,6 @@ public function testVersionableRelation()
 
     public function testInitialSaveShouldCreateVersion()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -64,9 +44,6 @@ public function testInitialSaveShouldCreateVersion()
 
     public function testRetrievePreviousVersionFails()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -80,9 +57,6 @@ public function testRetrievePreviousVersionFails()
 
     public function testRetrievePreviousVersionExists()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -103,9 +77,6 @@ public function testRetrievePreviousVersionExists()
 
     public function testVersionAndModelAreEqual()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -142,28 +113,18 @@ public function testVersionsAreRelatedToUsers()
 
     public function testGetResponsibleUserAttribute()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( true );
-
-        Auth::shouldReceive('id')
-            ->andReturn( 1 );
-
-
         $responsibleOrigUser = new TestVersionableUser();
         $responsibleOrigUser->name = "Marcel";
         $responsibleOrigUser->email = "m.pociot@test.php";
         $responsibleOrigUser->password = "12345";
         $responsibleOrigUser->last_login = $responsibleOrigUser->freshTimestamp();
         $responsibleOrigUser->save();
 
+        auth()->login($responsibleOrigUser);
+
         // Needed because otherwise timestamps are exactly the same
         sleep(1);
 
-        Config::shouldReceive('get')
-            ->once()
-            ->with("auth.providers.users.model")
-            ->andReturn('TestVersionableUser');
-
         $user = new TestVersionableUser();
         $user->name = "John";
         $user->email = "j.tester@test.php";
@@ -182,9 +143,6 @@ public function testGetResponsibleUserAttribute()
 
     public function testDontVersionEveryAttribute()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestPartialVersionableUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -201,9 +159,6 @@ public function testDontVersionEveryAttribute()
 
     public function testVersionEveryAttribute()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -219,9 +174,6 @@ public function testVersionEveryAttribute()
 
     public function testCheckForVersioningEnabled()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
         $user->disableVersioning();
 
@@ -246,9 +198,6 @@ public function testCheckForVersioningEnabled()
 
     public function testCheckForVersioningEnabledLaterOn()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
 
         $user->name = "Marcel";
@@ -266,9 +215,6 @@ public function testCheckForVersioningEnabledLaterOn()
 
     public function testCanRevertVersion()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableUser();
 
         $user->name = "Marcel";
@@ -294,9 +240,6 @@ public function testCanRevertVersion()
 
     public function testCanRevertSoftDeleteVersion()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableSoftDeleteUser();
 
         $user->name = "Marcel";
@@ -323,9 +266,6 @@ public function testCanRevertSoftDeleteVersion()
 
     public function testGetVersionModel()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         // Create 3 versions
         $user = new TestVersionableUser();
         $user->name = "Marcel";
@@ -351,9 +291,6 @@ public function testGetVersionModel()
 
     public function testUseReasonAttribute()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         // Create 3 versions
         $user = new TestVersionableUser();
         $user->name = "Marcel";
@@ -368,9 +305,6 @@ public function testUseReasonAttribute()
 
     public function testIgnoreDeleteTimestamp()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableSoftDeleteUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -391,8 +325,6 @@ public function testIgnoreDeleteTimestamp()
 
     public function testDiffTwoVersions()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
 
         $user = new TestVersionableUser();
         $user->name = "Marcel";
@@ -414,9 +346,6 @@ public function testDiffTwoVersions()
 
     public function testDiffIgnoresTimestamps()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $user = new TestVersionableSoftDeleteUser();
         $user->name = "Marcel";
         $user->email = "m.pociot@test.php";
@@ -440,9 +369,6 @@ public function testDiffIgnoresTimestamps()
 
     public function testDiffSpecificVersions()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         // Create 3 versions
         $user = new TestVersionableSoftDeleteUser();
         $user->name = "Marcel";
@@ -477,24 +403,21 @@ public function testDiffSpecificVersions()
 
     public function testDynamicVersionModel()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
-
         $name_v1 = 'first' ;
         $name_v2 = 'second' ;
-        
+
         $model = new ModelWithDynamicVersion();
         $model->name = $name_v1 ;
         $model->save();
-        
+
         sleep(1);
 
         $model->name = $name_v2 ;
         $model->save();
 
         // Assert that no row in default Version table
         $this->assertEquals( 0, Version::all()->count() );
-        
+
         // But are in Custom version table
         $this->assertEquals( 2, DynamicVersionModel::all()->count() );
 
@@ -509,11 +432,34 @@ public function testDynamicVersionModel()
         $this->assertEquals( $name_v1, $model->name );
     }
 
-    public function testKeepMaxVersionCount()
+    public function testItUsesConfigurableVersionClass()
     {
-        Auth::shouldReceive('check')
-            ->andReturn( false );
+        $this->app['config']->set('versionable.version_model', DynamicVersionModel::class);
 
+
+        $name_v1 = 'first' ;
+        $name_v2 = 'second' ;
+
+        $model = new TestVersionableUser();
+        $model->name = $name_v1 ;
+        $model->email = $name_v1 ;
+        $model->password = $name_v1 ;
+        $model->save();
+
+        sleep(1);
+
+        $model->name = $name_v2 ;
+        $model->save();
+
+        // Assert that no row in default Version table
+        $this->assertCount(0, Version::all());
+
+        // But are in Custom version table
+        $this->assertCount(2, DynamicVersionModel::all());
+    }
+
+    public function testKeepMaxVersionCount()
+    {
         $name_v1 = 'first' ;
         $name_v2 = 'second' ;
         $name_v3 = 'third' ;
@@ -558,7 +504,7 @@ public function testKeepMaxVersionCount()
 
 
 
-class TestVersionableUser extends Illuminate\Database\Eloquent\Model {
+class TestVersionableUser extends \Illuminate\Foundation\Auth\User {
     use \Mpociot\Versionable\VersionableTrait;
 
     protected $table = "users";