CachedBuilder::getWithModels() - Code Metrics - Inspection of "Merge pull request #13 from GeneaLabs/laravel-5.5" - GeneaLabs/laravel-model-caching - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by Mike

created 2017-10-12 19:03 UTC

CachedBuilder::getWithModels() A

↳ Parent: CachedBuilder

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0

<?php namespace GeneaLabs\LaravelModelCaching;

use Closure;
use Illuminate\Cache\TaggableStore;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Eloquent\Relations\Pivot;
use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Relations\Relation;

class CachedBuilder extends EloquentBuilder
{
    protected function cache(array $tags = [])
    {
        $cache = cache();

        if (is_subclass_of($cache->getStore(), TaggableStore::class)) {
            $cache = $cache->tags($tags);
        }

        return $cache;
    }

    protected function getCacheKey(array $columns = ['*'], $idColumn = null) : string
    {
        $key = $this->getModelSlug();
        $key .= $this->getIdColumn($idColumn ?: '');
        $key .= $this->getQueryColumns($columns);
        $key .= $this->getWhereClauses();
        $key .= $this->getWithModels();
        $key .= $this->getOrderByClauses();
        $key .= $this->getOffsetClause();
        $key .= $this->getLimitClause();

        return $key;
    }

    protected function getIdColumn(string $idColumn) : string
    {

        return $idColumn ? "_{$idColumn}" : '';
    }

    protected function getLimitClause() : string
    {
        if (! $this->query->limit) {
            return '';
        }

        return "-limit_{$this->query->limit}";
    }

    protected function getModelSlug() : string
    {
        return str_slug(get_class($this->model));
    }

    protected function getOffsetClause() : string
    {
        if (! $this->query->offset) {
            return '';
        }

        return "-offset_{$this->query->offset}";
    }

    protected function getQueryColumns(array $columns) : string
    {
        if ($columns === ['*'] || $columns === []) {
            return '';
        }

        return '_' . implode('_', $columns);
    }

    protected function getWhereClauses(array $wheres = []) : string
    {
        $wheres = collect($wheres);

        if ($wheres->isEmpty()) {
            $wheres = collect($this->query->wheres);
        }

        return $wheres->reduce(function ($carry, $where) {
            if (in_array($where['type'], ['Exists', 'Nested'])) {
                return $this->getWhereClauses($where['query']->wheres);
            }

            if ($where['type'] === 'Column') {
                return "_{$where['boolean']}_{$where['first']}_{$where['operator']}_{$where['second']}";
            }

            if ($where['type'] === 'raw') {
                return "_{$where['boolean']}_" . str_slug($where['sql']);
            }

            $value = array_get($where, 'value');

            if (in_array($where['type'], ['In', 'Null', 'NotNull'])) {
                $value = strtolower($where['type']);
            }

            if (is_array(array_get($where, 'values'))) {
                $value .= '_' . implode('_', $where['values']);
            }

            return "{$carry}-{$where['column']}_{$value}";
        }) ?: '';
    }

    protected function getWithModels() : string
    {
        $eagerLoads = collect($this->eagerLoad);

        if ($eagerLoads->isEmpty()) {
            return '';
        }

        return '-' . implode('-', $eagerLoads->keys()->toArray());
    }

	protected function getOrderByClauses(){
        $orders = collect($this->query->orders);

        return $orders->reduce(function($carry, $order){
            return $carry . '_orderBy_' . $order['column'] . '_' . $order['direction'];
        });
    }

    protected function getCacheTags() : array
    {
        return collect($this->eagerLoad)->keys()
            ->map(function ($relationName) {
                $relation = collect(explode('.', $relationName))
                    ->reduce(function ($carry, $name) {
                        if (! $carry) {
                            $carry = $this->model;
                        }

                        if ($carry instanceof Relation) {
                            $carry = $carry->getQuery()->model;
                        }

                        return $carry->{$name}();
                    });

                return str_slug(get_class($relation->getQuery()->model));
            })
            ->prepend(str_slug(get_class($this->model)))
            ->values()
            ->toArray();
    }

    public function avg($column)
    {
        $tags = [str_slug(get_class($this->model))];
        $key = str_slug(get_class($this->model)) ."-avg_{$column}";

        return $this->cache($tags)
            ->rememberForever($key, function () use ($column) {
                return parent::avg($column);
            });
    }

    public function count($columns = ['*'])
    {
        $tags = [str_slug(get_class($this->model))];
        $key = str_slug(get_class($this->model)) ."-count";

        return $this->cache($tags)
            ->rememberForever($key, function () use ($columns) {
                return parent::count($columns);
            });
    }

    public function cursor()
    {
        $tags = [str_slug(get_class($this->model))];
        $key = str_slug(get_class($this->model)) ."-cursor";

        return $this->cache($tags)
            ->rememberForever($key, function () {
                return collect(parent::cursor());
            });
    }

    /**
     * @SuppressWarnings(PHPMD.ShortVariable)
     */
    public function find($id, $columns = ['*'])
    {
        $tags = $this->getCacheTags();
        $key = $this->getCacheKey($columns, $id);

        return $this->cache($tags)
            ->rememberForever($key, function () use ($id, $columns) {
                return parent::find($id, $columns);
            });
    }

    public function first($columns = ['*'])
    {
        $tags = $this->getCacheTags();
        $key = $this->getCacheKey($columns) . '-first';

        return $this->cache($tags)
            ->rememberForever($key, function () use ($columns) {
                return parent::first($columns);
            });
    }

    public function get($columns = ['*'])
    {
        $tags = $this->getCacheTags();
        $key = $this->getCacheKey($columns);

        return $this->cache($tags)
            ->rememberForever($key, function () use ($columns) {
                return parent::get($columns);
            });
    }

    public function max($column)
    {
        $tags = [str_slug(get_class($this->model))];
        $key = str_slug(get_class($this->model)) ."-max_{$column}";

        return $this->cache($tags)
            ->rememberForever($key, function () use ($column) {
                return parent::max($column);
            });
    }

    public function min($column)
    {
        $tags = [str_slug(get_class($this->model))];
        $key = str_slug(get_class($this->model)) ."-min_{$column}";

        return $this->cache($tags)
            ->rememberForever($key, function () use ($column) {
                return parent::min($column);
            });
    }

    public function pluck($column, $key = null)
    {
        $tags = $this->getCacheTags();
        $cacheKey = $this->getCacheKey([$column]) . "-pluck_{$column}";

        if ($key) {
            $cacheKey .= "_{$key}";
        }

        return $this->cache($tags)
            ->rememberForever($cacheKey, function () use ($column, $key) {
                return parent::pluck($column, $key);
            });
    }

    public function sum($column)
    {
        $tags = [str_slug(get_class($this->model))];
        $key = str_slug(get_class($this->model)) ."-sum_{$column}";

        return $this->cache($tags)
            ->rememberForever($key, function () use ($column) {
                return parent::sum($column);
            });
    }
}


1		<?php namespace GeneaLabs\LaravelModelCaching;
2
3		use Closure;
4		use Illuminate\Cache\TaggableStore;
5		use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
6		use Illuminate\Database\Eloquent\Relations\Pivot;
7		use Illuminate\Support\Collection;
8		use Illuminate\Database\Eloquent\Relations\Relation;
9
10		class CachedBuilder extends EloquentBuilder
11		{
12		protected function cache(array $tags = [])
13		{
14		$cache = cache();
15
16		if (is_subclass_of($cache->getStore(), TaggableStore::class)) {
17		$cache = $cache->tags($tags);
18		}
19
20		return $cache;
21		}
22
23		protected function getCacheKey(array $columns = ['*'], $idColumn = null) : string
24		{
25		$key = $this->getModelSlug();
26		$key .= $this->getIdColumn($idColumn ?: '');
27		$key .= $this->getQueryColumns($columns);
28		$key .= $this->getWhereClauses();
29		$key .= $this->getWithModels();
30		$key .= $this->getOrderByClauses();
31		$key .= $this->getOffsetClause();
32		$key .= $this->getLimitClause();
33
34		return $key;
35		}
36
37		protected function getIdColumn(string $idColumn) : string
38		{
39
40		return $idColumn ? "_{$idColumn}" : '';
41		}
42
43		protected function getLimitClause() : string
44		{
45		if (! $this->query->limit) {
46		return '';
47		}
48
49		return "-limit_{$this->query->limit}";
50		}
51
52		protected function getModelSlug() : string
53		{
54		return str_slug(get_class($this->model));
55		}
56
57		protected function getOffsetClause() : string
58		{
59		if (! $this->query->offset) {
60		return '';
61		}
62
63		return "-offset_{$this->query->offset}";
64		}
65
66		protected function getQueryColumns(array $columns) : string
67		{
68		if ($columns === ['*'] \|\| $columns === []) {
69		return '';
70		}
71
72		return '_' . implode('_', $columns);
73		}
74
75		protected function getWhereClauses(array $wheres = []) : string
76		{
77		$wheres = collect($wheres);
78
79		if ($wheres->isEmpty()) {
80		$wheres = collect($this->query->wheres);
81		}
82
83		return $wheres->reduce(function ($carry, $where) {
84		if (in_array($where['type'], ['Exists', 'Nested'])) {
85		return $this->getWhereClauses($where['query']->wheres);
86		}
87
88		if ($where['type'] === 'Column') {
89		return "_{$where['boolean']}_{$where['first']}_{$where['operator']}_{$where['second']}";
90		}
91
92		if ($where['type'] === 'raw') {
93		return "_{$where['boolean']}_" . str_slug($where['sql']);
94		}
95
96		$value = array_get($where, 'value');
97
98		if (in_array($where['type'], ['In', 'Null', 'NotNull'])) {
99		$value = strtolower($where['type']);
100		}
101
102		if (is_array(array_get($where, 'values'))) {
103		$value .= '_' . implode('_', $where['values']);
104		}
105
106		return "{$carry}-{$where['column']}_{$value}";
107		}) ?: '';
108		}
109
110		protected function getWithModels() : string
111		{
112		$eagerLoads = collect($this->eagerLoad);
113
114		if ($eagerLoads->isEmpty()) {
115		return '';
116		}
117
118		return '-' . implode('-', $eagerLoads->keys()->toArray());
119		}
120
121		protected function getOrderByClauses(){
122		$orders = collect($this->query->orders);
123
124		return $orders->reduce(function($carry, $order){
125		return $carry . '_orderBy_' . $order['column'] . '_' . $order['direction'];
126		});
127		}
128
129		protected function getCacheTags() : array
130		{
131		return collect($this->eagerLoad)->keys()
132		->map(function ($relationName) {
133		$relation = collect(explode('.', $relationName))
134		->reduce(function ($carry, $name) {
135		if (! $carry) {
136		$carry = $this->model;
137		}
138
139		if ($carry instanceof Relation) {
140		$carry = $carry->getQuery()->model;
141		}
142
143		return $carry->{$name}();
144		});
145
146		return str_slug(get_class($relation->getQuery()->model));
147		})
148		->prepend(str_slug(get_class($this->model)))
149		->values()
150		->toArray();
151		}
152
153	View Code Duplication	public function avg($column)
154		{
155		$tags = [str_slug(get_class($this->model))];
156		$key = str_slug(get_class($this->model)) ."-avg_{$column}";
157
158		return $this->cache($tags)
159		->rememberForever($key, function () use ($column) {
160		return parent::avg($column);
161		});
162		}
163
164	View Code Duplication	public function count($columns = ['*'])
165		{
166		$tags = [str_slug(get_class($this->model))];
167		$key = str_slug(get_class($this->model)) ."-count";
168
169		return $this->cache($tags)
170		->rememberForever($key, function () use ($columns) {
171		return parent::count($columns);
172		});
173		}
174
175	View Code Duplication	public function cursor()
176		{
177		$tags = [str_slug(get_class($this->model))];
178		$key = str_slug(get_class($this->model)) ."-cursor";
179
180		return $this->cache($tags)
181		->rememberForever($key, function () {
182		return collect(parent::cursor());
183		});
184		}
185
186		/**
187		* @SuppressWarnings(PHPMD.ShortVariable)
188		*/
189	View Code Duplication	public function find($id, $columns = ['*'])
190		{
191		$tags = $this->getCacheTags();
192		$key = $this->getCacheKey($columns, $id);
193
194		return $this->cache($tags)
195		->rememberForever($key, function () use ($id, $columns) {
196		return parent::find($id, $columns);
197		});
198		}
199
200	View Code Duplication	public function first($columns = ['*'])
201		{
202		$tags = $this->getCacheTags();
203		$key = $this->getCacheKey($columns) . '-first';
204
205		return $this->cache($tags)
206		->rememberForever($key, function () use ($columns) {
207		return parent::first($columns);
208		});
209		}
210
211	View Code Duplication	public function get($columns = ['*'])
212		{
213		$tags = $this->getCacheTags();
214		$key = $this->getCacheKey($columns);
215
216		return $this->cache($tags)
217		->rememberForever($key, function () use ($columns) {
218		return parent::get($columns);
219		});
220		}
221
222	View Code Duplication	public function max($column)
223		{
224		$tags = [str_slug(get_class($this->model))];
225		$key = str_slug(get_class($this->model)) ."-max_{$column}";
226
227		return $this->cache($tags)
228		->rememberForever($key, function () use ($column) {
229		return parent::max($column);
230		});
231		}
232
233	View Code Duplication	public function min($column)
234		{
235		$tags = [str_slug(get_class($this->model))];
236		$key = str_slug(get_class($this->model)) ."-min_{$column}";
237
238		return $this->cache($tags)
239		->rememberForever($key, function () use ($column) {
240		return parent::min($column);
241		});
242		}
243
244		public function pluck($column, $key = null)
245		{
246		$tags = $this->getCacheTags();
247		$cacheKey = $this->getCacheKey([$column]) . "-pluck_{$column}";
248
249		if ($key) {
250		$cacheKey .= "_{$key}";
251		}
252
253		return $this->cache($tags)
254		->rememberForever($cacheKey, function () use ($column, $key) {
255		return parent::pluck($column, $key);
256		});
257		}
258
259	View Code Duplication	public function sum($column)
260		{
261		$tags = [str_slug(get_class($this->model))];
262		$key = str_slug(get_class($this->model)) ."-sum_{$column}";
263
264		return $this->cache($tags)
265		->rememberForever($key, function () use ($column) {
266		return parent::sum($column);
267		});
268		}
269		}
270

GeneaLabs / laravel-model-caching

Pull Request — master (#18)

CachedBuilder::getWithModels() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like