Merge branch 'master' into develop

Author: mikebronner

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.2.26] - 16 Feb 2018
+### Added
+- refactor functionality to trait (thanks @rs-sliske!).
+
 ## [0.2.25] - 16 Feb 2018
 ### Fixed
 - readme spelling errors (thanks @fridzema!).

README.md

@@ -32,7 +32,7 @@ composer require genealabs/laravel-model-caching
 ```
 
 ## Configuration
-### Optional Custom Cache Store
+### Recommended (Optional) Custom Cache Store
 If you would like to use a different cache store than the default one used by
 your Laravel application, you may do so by setting the `MODEL_CACHE_STORE`
 environment variable in your `.env` file to the name of a cache store configured
@@ -49,18 +49,19 @@ mean that the entire cache is cleared each time a model is created, saved,
 updated, or deleted.
 
 For ease of maintenance, I would recommend adding a `BaseModel` model that
-extends `CachedModel`, from which all your other models are extended. If you
+uses `Cachable`, from which all your other models are extended. If you
 don't want to do that, simply extend your models directly from `CachedModel`.
 
 Here's an example `BaseModel` class:
 
 ```php
 <?php namespace App;
 
-use GeneaLabs\LaravelModelCaching\CachedModel;
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
 
-abstract class BaseModel extends CachedModel
+abstract class BaseModel
 {
+    use Cachable;
     //
 }
 ```

src/CachedModel.php

@@ -1,65 +1,9 @@
 <?php namespace GeneaLabs\LaravelModelCaching;
 
-use GeneaLabs\LaravelModelCaching\CachedBuilder as Builder;
 use GeneaLabs\LaravelModelCaching\Traits\Cachable;
-use Illuminate\Cache\CacheManager;
-use Illuminate\Cache\TaggableStore;
-use Illuminate\Cache\TaggedCache;
-use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\Relation;
-use Illuminate\Support\Collection;
-use LogicException;
 
 abstract class CachedModel extends Model
 {
     use Cachable;
-
-    public function newEloquentBuilder($query)
-    {
-        if (session('genealabs-laravel-model-caching-is-disabled')) {
-            session()->forget('genealabs-laravel-model-caching-is-disabled');
-
-            return new EloquentBuilder($query);
-        }
-
-        return new Builder($query);
-    }
-
-    public static function boot()
-    {
-        parent::boot();
-
-        $class = get_called_class();
-        $instance = new $class;
-
-        static::created(function () use ($instance) {
-            $instance->flushCache();
-        });
-
-        static::deleted(function () use ($instance) {
-            $instance->flushCache();
-        });
-
-        static::saved(function () use ($instance) {
-            $instance->flushCache();
-        });
-
-        static::updated(function () use ($instance) {
-            $instance->flushCache();
-        });
-    }
-
-    public static function all($columns = ['*'])
-    {
-        $class = get_called_class();
-        $instance = new $class;
-        $tags = [str_slug(get_called_class())];
-        $key = $instance->makeCacheKey();
-
-        return $instance->cache($tags)
-            ->rememberForever($key, function () use ($columns) {
-                return parent::all($columns);
-            });
-    }
 }

src/Console/Commands/Flush.php

@@ -1,7 +1,6 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Console\Commands;
 
 use Illuminate\Console\Command;
-use GeneaLabs\LaravelModelCaching\CachedModel;
 
 class Flush extends Command
 {
@@ -21,7 +20,7 @@ public function handle()
 
         $model = new $option;
 
-        if (! $model instanceof CachedModel) {
+        if (! method_exists($model, 'flushCache')) {
             $this->error("'{$option}' is not an instance of CachedModel.");
             $this->line("Only CachedModel instances can be flushed.");
 

src/Traits/Cachable.php

@@ -5,6 +5,8 @@
 use GeneaLabs\LaravelModelCaching\CachedModel;
 use Illuminate\Cache\TaggableStore;
 use Illuminate\Database\Query\Builder;
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use GeneaLabs\LaravelModelCaching\CachedBuilder;
 
 trait Cachable
 {
@@ -39,6 +41,10 @@ public function disableCache()
 
     public function flushCache(array $tags = [])
     {
+        if (count($tags) === 0) {
+            $tags = $this->makeCacheTags();
+        }
+
         $this->cache($tags)->flush();
     }
 
@@ -57,7 +63,44 @@ protected function makeCacheKey(
 
     protected function makeCacheTags() : array
     {
-        return (new CacheTags($this->eagerLoad, $this->model))
+        $tags = (new CacheTags($this->eagerLoad ?? [], $this->model ?? $this))
             ->make();
+
+        return $tags;
+    }
+
+    public static function bootCachable()
+    {
+        static::saved(function ($instance) {
+            $instance->flushCache();
+        });
+    }
+
+    public static function all($columns = ['*'])
+    {
+        if (session('genealabs-laravel-model-caching-is-disabled')) {
+            return parent::all($columns);
+        }
+
+        $class = get_called_class();
+        $instance = new $class;
+        $tags = [str_slug(get_called_class())];
+        $key = $instance->makeCacheKey();
+
+        return $instance->cache($tags)
+            ->rememberForever($key, function () use ($columns) {
+                return parent::all($columns);
+            });
+    }
+
+    public function newEloquentBuilder($query)
+    {
+        if (session('genealabs-laravel-model-caching-is-disabled')) {
+            session()->forget('genealabs-laravel-model-caching-is-disabled');
+
+            return new EloquentBuilder($query);
+        }
+
+        return new CachedBuilder($query);
     }
 }

tests/Fixtures/Author.php

@@ -1,12 +1,15 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
 
-use GeneaLabs\LaravelModelCaching\CachedModel;
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 
-class Author extends CachedModel
+class Author extends Model
 {
+    use Cachable;
+
     protected $fillable = [
         'name',
         'email',

tests/Fixtures/Book.php

@@ -1,11 +1,14 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
 
-use GeneaLabs\LaravelModelCaching\CachedModel;
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
-class Book extends CachedModel
+class Book extends Model
 {
+    use Cachable;
+
     protected $casts = [
         'price' => 'float',
     ];

tests/Fixtures/Profile.php

@@ -1,11 +1,14 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
 
-use GeneaLabs\LaravelModelCaching\CachedModel;
-use Illuminate\Database\Eloquent\Relations\HasMany;
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 
-class Profile extends CachedModel
+class Profile extends Model
 {
+    use Cachable;
+
     protected $fillable = [
         'first_name',
         'last_name',

tests/Fixtures/Publisher.php

@@ -1,10 +1,13 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
 
-use GeneaLabs\LaravelModelCaching\CachedModel;
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 
-class Publisher extends CachedModel
+class Publisher extends Model
 {
+    use Cachable;
+
     protected $fillable = [
         'name',
     ];

tests/Fixtures/Store.php

@@ -1,10 +1,13 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
 
-use GeneaLabs\LaravelModelCaching\CachedModel;
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
-class Store extends CachedModel
+class Store extends Model
 {
+    use Cachable;
+
     protected $fillable = [
         'address',
         'name',