GeneaLabs /
laravel-model-caching
| Total Complexity | 46 |
| Total Lines | 323 |
| Duplicated Lines | 38.7 % |
| Changes | 0 | ||
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like CachedBuilder often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CachedBuilder, and based on these observations, apply Extract Interface, too.
| 1 | <?php namespace GeneaLabs\LaravelModelCaching; |
||
| 11 | class CachedBuilder extends EloquentBuilder |
||
| 12 | { |
||
| 13 | protected function cache(array $tags = []) |
||
| 14 | { |
||
| 15 | $cache = cache(); |
||
| 16 | |||
| 17 | if (is_subclass_of($cache->getStore(), TaggableStore::class)) { |
||
| 18 | $cache = $cache->tags($tags); |
||
| 19 | } |
||
| 20 | |||
| 21 | return $cache; |
||
| 22 | } |
||
| 23 | |||
| 24 | protected function getCacheKey(array $columns = ['*'], $idColumn = null) : string |
||
| 25 | { |
||
| 26 | $key = $this->getModelSlug(); |
||
| 27 | $key .= $this->getIdColumn($idColumn ?: ''); |
||
| 28 | $key .= $this->getQueryColumns($columns); |
||
| 29 | $key .= $this->getWhereClauses(); |
||
| 30 | $key .= $this->getWithModels(); |
||
| 31 | $key .= $this->getOffsetClause(); |
||
| 32 | $key .= $this->getLimitClause(); |
||
| 33 | |||
| 34 | return $key; |
||
| 35 | } |
||
| 36 | |||
| 37 | protected function getIdColumn(string $idColumn) : string |
||
| 38 | { |
||
| 39 | return $idColumn ? "_{$idColumn}" : ''; |
||
| 40 | } |
||
| 41 | |||
| 42 | protected function getLimitClause() : string |
||
| 43 | { |
||
| 44 | if (! $this->query->limit) { |
||
| 45 | return ''; |
||
| 46 | } |
||
| 47 | |||
| 48 | return "-limit_{$this->query->limit}"; |
||
| 49 | } |
||
| 50 | |||
| 51 | protected function getModelSlug() : string |
||
| 52 | { |
||
| 53 | return str_slug(get_class($this->model)); |
||
| 54 | } |
||
| 55 | |||
| 56 | protected function getOffsetClause() : string |
||
| 57 | { |
||
| 58 | if (! $this->query->offset) { |
||
| 59 | return ''; |
||
| 60 | } |
||
| 61 | |||
| 62 | return "-offset_{$this->query->offset}"; |
||
| 63 | } |
||
| 64 | |||
| 65 | protected function getQueryColumns(array $columns) : string |
||
| 66 | { |
||
| 67 | if ($columns === ['*'] || $columns === []) { |
||
| 68 | return ''; |
||
| 69 | } |
||
| 70 | |||
| 71 | return '_' . implode('_', $columns); |
||
| 72 | } |
||
| 73 | |||
| 74 | protected function getWhereClauses() : string |
||
| 75 | { |
||
| 76 | return collect($this->query->wheres)->reduce(function ($carry, $where) { |
||
| 77 | $value = $where['value'] ?? implode('_', ($where['values'] ?? [])); |
||
| 78 | |||
| 79 | return "{$carry}-{$where['column']}_{$value}"; |
||
| 80 | }) ?: ''; |
||
| 81 | } |
||
| 82 | |||
| 83 | protected function getWithModels() : string |
||
| 84 | { |
||
| 85 | $eagerLoads = collect($this->eagerLoad); |
||
| 86 | |||
| 87 | if ($eagerLoads->isEmpty()) { |
||
| 88 | return ''; |
||
| 89 | } |
||
| 90 | |||
| 91 | return '-' . implode('-', $eagerLoads->keys()->toArray()); |
||
| 92 | } |
||
| 93 | |||
| 94 | protected function getCacheTags() : array |
||
| 95 | { |
||
| 96 | return collect($this->eagerLoad)->keys() |
||
| 97 | ->map(function ($relationName) { |
||
| 98 | $relation = collect(explode('.', $relationName)) |
||
| 99 | ->reduce(function ($carry, $name) { |
||
| 100 | if (! $carry) { |
||
| 101 | $carry = $this->model; |
||
| 102 | } |
||
| 103 | |||
| 104 | if ($carry instanceof Relation) { |
||
| 105 | $carry = $carry->getQuery()->model; |
||
|
1 ignored issue
–
show
|
|||
| 106 | } |
||
| 107 | |||
| 108 | return $carry->{$name}(); |
||
| 109 | }); |
||
| 110 | |||
| 111 | return str_slug(get_class($relation->getQuery()->model)); |
||
| 112 | }) |
||
| 113 | ->prepend(str_slug(get_class($this->model))) |
||
| 114 | ->values() |
||
| 115 | ->toArray(); |
||
| 116 | } |
||
| 117 | |||
| 118 | protected function isCaching() : bool |
||
| 119 | { |
||
| 120 | return (session('genealabs-laravel-model-is-caching') !== null); |
||
| 121 | } |
||
| 122 | |||
| 123 | protected function setCachingFlag() : string |
||
| 124 | { |
||
| 125 | |||
| 126 | $cachingFlag = UUID::uuid4()->toString(); |
||
| 127 | session(['genealabs-laravel-model-is-caching' => $cachingFlag]); |
||
| 128 | |||
| 129 | return $cachingFlag; |
||
| 130 | } |
||
| 131 | |||
| 132 | protected function clearCachingFlag(string $cachingFlag) |
||
| 133 | { |
||
| 134 | if (session('genealabs-laravel-model-is-caching') === $cachingFlag) { |
||
| 135 | session()->forget('genealabs-laravel-model-is-caching'); |
||
| 136 | } |
||
| 137 | } |
||
| 138 | |||
| 139 | View Code Duplication | public function avg($column) |
|
|
1 ignored issue
–
show
|
|||
| 140 | { |
||
| 141 | $tags = [str_slug(get_class($this->model))]; |
||
| 142 | $key = str_slug(get_class($this->model)) ."-avg_{$column}"; |
||
| 143 | |||
| 144 | if ($this->isCaching()) { |
||
| 145 | return parent::avg($column); |
||
|
1 ignored issue
–
show
|
|||
| 146 | } |
||
| 147 | |||
| 148 | $cachingFlag = $this->setCachingFlag(); |
||
| 149 | $result = $this->cache($tags) |
||
| 150 | ->rememberForever($key, function () use ($column) { |
||
| 151 | return parent::avg($column); |
||
| 152 | }); |
||
| 153 | $this->clearCachingFlag($cachingFlag); |
||
| 154 | |||
| 155 | return $result; |
||
| 156 | } |
||
| 157 | |||
| 158 | View Code Duplication | public function count($columns = ['*']) |
|
| 159 | { |
||
| 160 | $tags = [str_slug(get_class($this->model))]; |
||
| 161 | $key = str_slug(get_class($this->model)) ."-count"; |
||
| 162 | |||
| 163 | if ($this->isCaching()) { |
||
| 164 | return parent::count($columns); |
||
|
1 ignored issue
–
show
|
|||
| 165 | } |
||
| 166 | |||
| 167 | $cachingFlag = $this->setCachingFlag(); |
||
| 168 | $result = $this->cache($tags) |
||
| 169 | ->rememberForever($key, function () use ($columns) { |
||
| 170 | return parent::count($columns); |
||
| 171 | }); |
||
| 172 | $this->clearCachingFlag($cachingFlag); |
||
| 173 | |||
| 174 | return $result; |
||
| 175 | } |
||
| 176 | |||
| 177 | public function cursor() |
||
| 178 | { |
||
| 179 | $tags = [str_slug(get_class($this->model))]; |
||
| 180 | $key = str_slug(get_class($this->model)) ."-cursor"; |
||
| 181 | |||
| 182 | if ($this->isCaching()) { |
||
| 183 | return collect(parent::cursor()); |
||
| 184 | } |
||
| 185 | |||
| 186 | $cachingFlag = $this->setCachingFlag(); |
||
| 187 | $result = $this->cache($tags) |
||
| 188 | ->rememberForever($key, function () { |
||
| 189 | return collect(parent::cursor()); |
||
| 190 | }); |
||
| 191 | $this->clearCachingFlag($cachingFlag); |
||
| 192 | |||
| 193 | return $result; |
||
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * @SuppressWarnings(PHPMD.ShortVariable) |
||
| 198 | */ |
||
| 199 | public function find($id, $columns = ['*']) |
||
| 200 | { |
||
| 201 | $tags = $this->getCacheTags(); |
||
| 202 | $key = $this->getCacheKey($columns, $id); |
||
| 203 | |||
| 204 | if ($this->isCaching()) { |
||
| 205 | return parent::find($id, $columns); |
||
| 206 | } |
||
| 207 | |||
| 208 | $cachingFlag = $this->setCachingFlag(); |
||
| 209 | $result = $this->cache($tags) |
||
| 210 | ->rememberForever($key, function () use ($id, $columns) { |
||
| 211 | return parent::find($id, $columns); |
||
| 212 | }); |
||
| 213 | $this->clearCachingFlag($cachingFlag); |
||
| 214 | |||
| 215 | return $result; |
||
| 216 | } |
||
| 217 | |||
| 218 | View Code Duplication | public function first($columns = ['*']) |
|
| 219 | { |
||
| 220 | $tags = $this->getCacheTags(); |
||
| 221 | $key = $this->getCacheKey($columns) . '-first'; |
||
| 222 | |||
| 223 | if ($this->isCaching()) { |
||
| 224 | return parent::first($columns); |
||
| 225 | } |
||
| 226 | |||
| 227 | $cachingFlag = $this->setCachingFlag(); |
||
| 228 | $result = $this->cache($tags) |
||
| 229 | ->rememberForever($key, function () use ($columns) { |
||
| 230 | return parent::first($columns); |
||
| 231 | }); |
||
| 232 | $this->clearCachingFlag($cachingFlag); |
||
| 233 | |||
| 234 | return $result; |
||
| 235 | } |
||
| 236 | |||
| 237 | View Code Duplication | public function get($columns = ['*']) |
|
| 238 | { |
||
| 239 | $tags = $this->getCacheTags(); |
||
| 240 | $key = $this->getCacheKey($columns); |
||
| 241 | |||
| 242 | if ($this->isCaching()) { |
||
| 243 | return parent::get($columns); |
||
| 244 | } |
||
| 245 | |||
| 246 | $cachingFlag = $this->setCachingFlag(); |
||
| 247 | $result = $this->cache($tags) |
||
| 248 | ->rememberForever($key, function () use ($columns) { |
||
| 249 | return parent::get($columns); |
||
| 250 | }); |
||
| 251 | $this->clearCachingFlag($cachingFlag); |
||
| 252 | |||
| 253 | return $result; |
||
| 254 | } |
||
| 255 | |||
| 256 | View Code Duplication | public function max($column) |
|
| 257 | { |
||
| 258 | $tags = [str_slug(get_class($this->model))]; |
||
| 259 | $key = str_slug(get_class($this->model)) ."-max_{$column}"; |
||
| 260 | |||
| 261 | if ($this->isCaching()) { |
||
| 262 | return parent::max($column); |
||
|
1 ignored issue
–
show
|
|||
| 263 | } |
||
| 264 | |||
| 265 | $cachingFlag = $this->setCachingFlag(); |
||
| 266 | $result = $this->cache($tags) |
||
| 267 | ->rememberForever($key, function () use ($column) { |
||
| 268 | return parent::max($column); |
||
| 269 | }); |
||
| 270 | $this->clearCachingFlag($cachingFlag); |
||
| 271 | |||
| 272 | return $result; |
||
| 273 | } |
||
| 274 | |||
| 275 | View Code Duplication | public function min($column) |
|
| 292 | } |
||
| 293 | |||
| 294 | public function pluck($column, $key = null) |
||
| 315 | } |
||
| 316 | |||
| 317 | View Code Duplication | public function sum($column) |
|
| 318 | { |
||
| 319 | $tags = [str_slug(get_class($this->model))]; |
||
| 320 | $key = str_slug(get_class($this->model)) ."-sum_{$column}"; |
||
| 321 | |||
| 322 | if ($this->isCaching()) { |
||
| 323 | return parent::sum($column); |
||
|
1 ignored issue
–
show
|
|||
| 324 | } |
||
| 325 | |||
| 326 | $cachingFlag = $this->setCachingFlag(); |
||
| 327 | $result = $this->cache($tags) |
||
| 328 | ->rememberForever($key, function () use ($column) { |
||
| 329 | return parent::sum($column); |
||
| 330 | }); |
||
| 331 | $this->clearCachingFlag($cachingFlag); |
||
| 332 | |||
| 333 | return $result; |
||
| 334 | } |
||
| 335 | } |
||
| 336 |
Loading history...