Published flag scope configurable auto apply (#26)

* Published flag scope configurable auto apply
* Fix migrate command to 5.4 support. Drop 5.4 support till trait be fixed.

Author: Pe Ell

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `laravel-eloquent-flag` will be documented in this file.
 
+## [3.8.0] - 2017-01-29
+
+### Added
+
+- `shouldApplyPublishedAtScope` & `shouldApplyPublishedFlagScope` methods to skip Published flags global scope auto apply.
+
 ## [3.7.0] - 2017-01-14
 
 ### Added
@@ -121,6 +127,7 @@ All notable changes to `laravel-eloquent-flag` will be documented in this file.
 
 - `is_active` boolean flag added.
 
+[3.8.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/3.7.0...3.8.0
 [3.7.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/3.6.0...3.7.0
 [3.6.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/3.5.0...3.6.0
 [3.5.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/3.4.0...3.5.0

composer.json

@@ -52,7 +52,7 @@
         "docs": "https://github.com/cybercog/laravel-eloquent-flag/wiki"
     },
     "require": {
-        "illuminate/database": "~5.2.0|~5.3.0|~5.4.0",
+        "illuminate/database": "~5.2.0|~5.3.0",
         "php": "^5.6|^7.0"
     },
     "require-dev": {

src/Scopes/Classic/PublishedAtScope.php

@@ -39,6 +39,10 @@ class PublishedAtScope implements Scope
      */
     public function apply(Builder $builder, Model $model)
     {
+        if (method_exists($model, 'shouldApplyPublishedAtScope') && !$model->shouldApplyPublishedAtScope()) {
+            return $builder;
+        }
+
         return $builder->whereNotNull('published_at');
     }
 

src/Scopes/Classic/PublishedFlagScope.php

@@ -38,6 +38,10 @@ class PublishedFlagScope implements Scope
      */
     public function apply(Builder $builder, Model $model)
     {
+        if (method_exists($model, 'shouldApplyPublishedFlagScope') && !$model->shouldApplyPublishedFlagScope()) {
+            return $builder;
+        }
+
         return $builder->where('is_published', 1);
     }
 

tests/TestCase.php

@@ -70,7 +70,7 @@ protected function destroyPackageMigrations()
     protected function migrateUnitTestTables()
     {
         $this->artisan('migrate', [
-            '--realpath' => realpath(__DIR__ . '/database/migrations'),
+            '--path' => '../../../../tests/database/migrations',
         ]);
     }
 

tests/stubs/Models/Classic/EntityWithPublishedAtUnapplied.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of Laravel Eloquent Flag.
+ *
+ * (c) Anton Komarev <a.komarev@cybercog.su>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Flag\Tests\Stubs\Models\Classic;
+
+/**
+ * Class EntityWithPublishedAtUnapplied.
+ *
+ * @package Cog\Flag\Tests\Stubs\Models\Classic
+ */
+class EntityWithPublishedAtUnapplied extends EntityWithPublishedAt
+{
+    /**
+     * Determine if PublishedAtScope should be applied by default.
+     *
+     * @return bool
+     */
+    public function shouldApplyPublishedAtScope()
+    {
+        return false;
+    }
+}

tests/stubs/Models/Classic/EntityWithPublishedFlagUnapplied.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of Laravel Eloquent Flag.
+ *
+ * (c) Anton Komarev <a.komarev@cybercog.su>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Flag\Tests\Stubs\Models\Classic;
+
+/**
+ * Class EntityWithPublishedFlagUnapplied.
+ *
+ * @package Cog\Flag\Tests\Stubs\Models\Classic
+ */
+class EntityWithPublishedFlagUnapplied extends EntityWithPublishedFlag
+{
+    /**
+     * Determine if PublishedFlagScope should be applied by default.
+     *
+     * @return bool
+     */
+    public function shouldApplyPublishedFlagScope()
+    {
+        return false;
+    }
+}

tests/unit/Scopes/Classic/PublishedAtScopeTest.php

@@ -13,6 +13,7 @@
 
 use Carbon\Carbon;
 use Cog\Flag\Tests\Stubs\Models\Classic\EntityWithPublishedAt;
+use Cog\Flag\Tests\Stubs\Models\Classic\EntityWithPublishedAtUnapplied;
 use Cog\Flag\Tests\TestCase;
 
 /**
@@ -109,4 +110,19 @@ public function it_can_unpublish_model()
 
         $this->assertNull($model->published_at);
     }
+
+    /** @test */
+    public function it_can_skip_apply()
+    {
+        factory(EntityWithPublishedAt::class, 3)->create([
+            'published_at' => Carbon::now()->subDay(),
+        ]);
+        factory(EntityWithPublishedAt::class, 2)->create([
+            'published_at' => null,
+        ]);
+
+        $entities = EntityWithPublishedAtUnapplied::all();
+
+        $this->assertCount(5, $entities);
+    }
 }

tests/unit/Scopes/Classic/PublishedFlagScopeTest.php

@@ -12,6 +12,7 @@
 namespace Cog\Flag\Tests\Unit\Scopes\Classic;
 
 use Cog\Flag\Tests\Stubs\Models\Classic\EntityWithPublishedFlag;
+use Cog\Flag\Tests\Stubs\Models\Classic\EntityWithPublishedFlagUnapplied;
 use Cog\Flag\Tests\TestCase;
 
 /**
@@ -108,4 +109,19 @@ public function it_can_unpublish_model()
 
         $this->assertFalse($model->is_published);
     }
+
+    /** @test */
+    public function it_can_skip_apply()
+    {
+        factory(EntityWithPublishedFlag::class, 3)->create([
+            'is_published' => true,
+        ]);
+        factory(EntityWithPublishedFlag::class, 2)->create([
+            'is_published' => false,
+        ]);
+
+        $entities = EntityWithPublishedFlagUnapplied::all();
+
+        $this->assertCount(5, $entities);
+    }
 }