Separate flag scopes, helpers and behavior traits

Author: antonkomarev

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to `laravel-eloquent-flag` will be documented in this file.
 
+## 3.0.0 - [Unreleased]
+
+### Added
+
+- `Has{Name}FlagScope` traits which include global scopes.
+- `Has{Name}FlagHelpers` traits which include flag related helper methods.
+- `Has{Name}FlagBehavior` traits which include flag specific behavior.
+
+### Changed
+
+- Each Flag trait was spliced on 2 additional traits: `Has{Name}Flag` = `Has{Name}FlagScope` + `Has{Name}FlagHelpers`
+- Kept Flag trait was spliced on 3 additional traits, because events were pulled out to `HasKeptFlagBehavior` trait.
+
 ## 2.1.0 - 2016-01-04
 
 - `is_closed` inverse boolean flag added.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "cybercog/laravel-eloquent-flag",
-    "description": "Laravel Eloquent flagged attributes behavior",
+    "description": "Laravel Eloquent flagged attributes behavior.",
     "type": "library",
     "license": "MIT",
     "keywords": [
@@ -50,14 +50,14 @@
         "docs": "https://github.com/cybercog/laravel-eloquent-flag/wiki"
     },
     "require": {
-        "php": "^5.6|^7.0",
-        "illuminate/database": "~5.2.0|~5.3.0|~5.4.0"
+        "illuminate/database": "~5.2.0|~5.3.0|~5.4.0",
+        "php": "^5.6|^7.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^1.11",
-        "phpunit/phpunit": "^5.2",
+        "mockery/mockery": "^0.9.5",
         "orchestra/testbench": "~3.0",
-        "mockery/mockery": "^0.9.5"
+        "phpunit/phpunit": "^5.2"
     },
     "autoload": {
         "psr-4": {

src/Traits/Classic/HasAcceptedFlag.php

@@ -18,5 +18,6 @@
  */
 trait HasAcceptedFlag
 {
-    use HasAcceptedFlagScope;
+    use HasAcceptedFlagHelpers,
+        HasAcceptedFlagScope;
 }

src/Traits/Classic/HasAcceptedFlagHelpers.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of Laravel Eloquent Flag.
+ *
+ * (c) CyberCog <support@cybercog.su>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Flag\Traits\Classic;
+
+/**
+ * Class HasAcceptedFlagHelpers.
+ *
+ * @package Cog\Flag\Traits\Classic
+ */
+trait HasAcceptedFlagHelpers
+{
+    //
+}

src/Traits/Classic/HasActiveFlag.php

@@ -18,5 +18,6 @@
  */
 trait HasActiveFlag
 {
-    use HasActiveFlagScope;
+    use HasActiveFlagHelpers,
+        HasActiveFlagScope;
 }

src/Traits/Classic/HasActiveFlagHelpers.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of Laravel Eloquent Flag.
+ *
+ * (c) CyberCog <support@cybercog.su>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Flag\Traits\Classic;
+
+/**
+ * Class HasActiveFlagHelpers.
+ *
+ * @package Cog\Flag\Traits\Classic
+ */
+trait HasActiveFlagHelpers
+{
+    //
+}

src/Traits/Classic/HasApprovedFlag.php

@@ -18,5 +18,6 @@
  */
 trait HasApprovedFlag
 {
-    use HasApprovedFlagScope;
+    use HasApprovedFlagHelpers,
+        HasApprovedFlagScope;
 }

src/Traits/Classic/HasApprovedFlagHelpers.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of Laravel Eloquent Flag.
+ *
+ * (c) CyberCog <support@cybercog.su>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Flag\Traits\Classic;
+
+/**
+ * Class HasApprovedFlagHelpers.
+ *
+ * @package Cog\Flag\Traits\Classic
+ */
+trait HasApprovedFlagHelpers
+{
+    //
+}

src/Traits/Classic/HasKeptFlag.php

@@ -11,58 +11,14 @@
 
 namespace Cog\Flag\Traits\Classic;
 
-use Carbon\Carbon;
-use Illuminate\Database\Eloquent\Builder;
-
 /**
  * Class HasKeptFlag.
  *
  * @package Cog\Flag\Traits\Classic
  */
 trait HasKeptFlag
 {
-    use HasKeptFlagScope;
-
-    /**
-     * Boot the HasKeptFlag trait for a model.
-     *
-     * @return void
-     */
-    public static function bootHasKeptFlag()
-    {
-        static::creating(function ($entity) {
-            if (!$entity->is_kept) {
-                $entity->is_kept = false;
-            }
-        });
-
-        static::updating(function ($entity) {
-            if (!$entity->is_kept) {
-                $entity->is_kept = true;
-            }
-        });
-    }
-
-    /**
-     * Determine if the model instance has `is_kept` state.
-     *
-     * @return bool
-     */
-    public function isKept()
-    {
-        return (bool) $this->is_kept;
-    }
-
-    /**
-     * Get unkept models that are older than the given number of hours.
-     *
-     * @param \Illuminate\Database\Eloquent\Builder $builder
-     * @param int $hours
-     * @return \Illuminate\Database\Eloquent\Builder
-     */
-    public function scopeOnlyUnkeptOlderThanHours(Builder $builder, $hours)
-    {
-        return $builder->onlyUnkept()
-            ->where(static::getCreatedAtColumn(), '<=', Carbon::now()->subHours($hours)->toDateTimeString());
-    }
+    use HasKeptFlagBehavior,
+        HasKeptFlagHelpers,
+        HasKeptFlagScope;
 }

src/Traits/Classic/HasKeptFlagBehavior.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of Laravel Eloquent Flag.
+ *
+ * (c) CyberCog <support@cybercog.su>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Flag\Traits\Classic;
+
+/**
+ * Class HasKeptFlagBehavior.
+ *
+ * @package Cog\Flag\Traits\Classic
+ */
+trait HasKeptFlagBehavior
+{
+    /**
+     * Boot the bootHasKeptFlagBehavior trait for a model.
+     *
+     * @return void
+     */
+    public static function bootHasKeptFlagBehavior()
+    {
+        static::creating(function ($entity) {
+            if (!$entity->is_kept) {
+                $entity->is_kept = false;
+            }
+        });
+
+        static::updating(function ($entity) {
+            if (!$entity->is_kept) {
+                $entity->is_kept = true;
+            }
+        });
+    }
+}