EntriesRepository::isCastedAsArray() - Code Metrics - Inspection of "Merge pull request #10 from bbs-smuller/feature/ca..." - Distilleries/Laravel-Contentful-Utilities - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 29d5bf...009409 )

by Maxime

created 2019-06-26 15:33 UTC

EntriesRepository::isCastedAsArray() A

↳ Parent: EntriesRepository

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	3
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	7
ccs	0
cts	6
cp	0
crap	12
rs	10

<?php

namespace Distilleries\Contentful\Repositories;

use Exception;
use Illuminate\Support\Str;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Illuminate\Database\Eloquent\Builder;
use Distilleries\Contentful\Models\Locale;
use Distilleries\Contentful\Helpers\NamespaceResolver;
use Distilleries\Contentful\Models\Base\ContentfulModel;
use Distilleries\Contentful\Models\Base\ContentfulMapper;

class EntriesRepository
{
    use Traits\EntryType;

    /**
     * Truncate all tables extending a ContentfulModel.
     *
     * @return void
     */
    public function truncateRelatedTables()
    {
        $modelPath = config('contentful.generator.model');

        foreach (glob($modelPath . '/*.php') as $file) {
            $modelInstance = NamespaceResolver::model(str_replace(
                [$modelPath, '.php', '/'],
                ['', '', '\\'],
                $file
            ));

            if (! empty($modelInstance) && $modelInstance instanceof ContentfulModel) {
                $modelInstance->query()->truncate();
            }
        }

        DB::table('entry_types')->truncate();
        DB::table('entry_relationships')->truncate();
    }

    /**
     * Map Contentful entry payload to an Eloquent one.
     *
     * @param  array  $entry
     * @param \Illuminate\Support\Collection  $locales
     * @return void
     * @throws \Exception
     */
    public function toContentfulModel(array $entry, Collection $locales)
    {
        $this->upsertEntryType($entry, $this->entryContentType($entry));
        $this->deleteRelationships($entry);

        $localeEntries = $this->entryMapper($entry)->toLocaleEntries($entry, $locales);
        foreach ($localeEntries as $localeEntry) {
            $model = $this->upsertLocale($entry, $localeEntry);

            if (! empty($model)) {
                if (isset($localeEntry['relationships'])) {
                    $this->handleRelationships($localeEntry['locale'],$localeEntry['country'], $localeEntry['contentful_id'], $this->entryContentType($entry), $localeEntry['relationships']);
                    unset($localeEntry['relationships']);
                }
            } else {
                if (isset($localeEntry['relationships'])) {
                    unset($localeEntry['relationships']);
                }
            }
        }
    }

    /**
     * Delete entry and relationships.
     *
     * @param  array  $entry
     * @return void
     * @throws \Exception
     */
    public function delete(array $entry)
    {
        $this->deleteEntryType($entry['sys']['id']);
        $this->deleteRelationships($entry);

        $this->entryModel($entry)->query()->where('contentful_id', '=', $entry['sys']['id'])->delete();
    }

    // --------------------------------------------------------------------------------
    // --------------------------------------------------------------------------------
    // --------------------------------------------------------------------------------

    /**
     * Return entry content-type.
     *
     * @param  array  $entry
     * @return string
     */
    private function entryContentType(array $entry): string
    {
        return $entry['sys']['contentType']['sys']['id'];
    }

    /**
     * Return entry content-type mapper class instance.
     *
     * @param  array  $entry
     * @return \Distilleries\Contentful\Models\Base\ContentfulMapper
     * @throws \Exception
     */
    private function entryMapper(array $entry): ContentfulMapper
    {
        $class = Str::studly($this->entryContentType($entry)) . 'Mapper';
        $mapperClass = NamespaceResolver::mapper($class);

        if (empty($mapperClass) && ! ($mapperClass instanceof ContentfulMapper)) {
            throw new Exception('Unknown mapper: ' . $class);
        }

        return new $mapperClass;
    }

    /**
     * Return entry content-type model class instance.
     *
     * @param  array  $entry
     * @return \Distilleries\Contentful\Models\Base\ContentfulModel
     * @throws \Exception
     */
    private function entryModel(array $entry): ContentfulModel
    {
        $model = Str::studly($this->entryContentType($entry));
        $modelClass = NamespaceResolver::modelClass($model);

        if (empty($modelClass)) {
            throw new Exception('Unknown model: ' . $model);
        }

        return new $modelClass;
    }

    // --------------------------------------------------------------------------------
    // --------------------------------------------------------------------------------
    // --------------------------------------------------------------------------------

    /**
     * Handle mapped relationships to fill `entry_relationships` pivot table.
     *
     * @param  string  $locale
     * @param  string  $country
     * @param  string  $sourceId
     * @param  string  $sourceType
     * @param  array  $relationships
     * @return void
     * @throws \Exception
     */
    private function handleRelationships(string $locale, string $country, string $sourceId, string $sourceType, array $relationships = [])
    {
        DB::table('entry_relationships')
            ->where('locale', '=', $locale)
            ->where('country', '=', $country)
            ->where('source_contentful_id', '=', $sourceId)
            ->delete();

        $order = 1;
        foreach ($relationships as $relationship) {
            if (! isset($relationship['id']) || ! isset($relationship['type'])) {
                throw new Exception('Relationships malformed! (' . print_r($relationship, true) . ')');
            }

            DB::table('entry_relationships')->insert([
                'locale' => $locale,
                'country' => $country,
                'source_contentful_id' => $sourceId,
                'source_contentful_type' => $sourceType,
                'related_contentful_id' => $relationship['id'],
                'related_contentful_type' => $relationship['type'],
                'order' => $order,
                'relation' => isset($relationship['field']) ? $relationship['field'] : null,
            ]);

            $order++;
        }
    }

    /**
     * Delete entry relationships for given Contentful entry.
     *
     * @param  array  $entry
     * @return void
     */
    private function deleteRelationships(array $entry)
    {
        DB::table('entry_relationships')
            ->where('source_contentful_id', '=', $entry['sys']['id'])
            ->where('source_contentful_type', '=', $this->entryContentType($entry))
            ->delete();
    }

    // --------------------------------------------------------------------------------
    // --------------------------------------------------------------------------------
    // --------------------------------------------------------------------------------

    /**
     * Return inserted / updated model instance for given parameters.
     *
     * @param  array  $entry
     * @param  array  $data
     * @return \Distilleries\Contentful\Models\Base\ContentfulModel|null
     * @throws \Exception
     */
    private function upsertLocale(array $entry, array $data): ?ContentfulModel
    {
        $model = $this->entryModel($entry);
        if ((method_exists($model, 'bootNotNullSlug') && empty($data['slug'])) || ! Locale::canBeSave($data['country'], $data['locale'])) {
            // Remove instance if slug is empty
            $instance = $this->instanceQueryBuilder($model, $data)->first();
            if (! empty($instance)) {
                $instance->delete();
            }

            return null;
        }

        if (! isset($data['payload'])) {
            throw new Exception('Mapper for model ' . class_basename($model) . ' must set a "payload" key');
        }

        $instance = $this->instanceQueryBuilder($model, $data)->first();

        if (empty($instance)) {
            $model->fill($data)->save();
        } else {
            $this->overridePayloadAndExtraFillables($model, $data);
        }

        return $this->instanceQueryBuilder($model, $data)->first();
    }
    
    /**
     * Override Eloquent entry with all fillable data.
     *
     * @param  \Distilleries\Contentful\Models\Base\ContentfulModel  $model
     * @param  array  $data
     * @return void
     */
    private function overridePayloadAndExtraFillables(ContentfulModel $model, array $data)
    {
        $fillables = $model->getFillable();
        $casts = $model->getCasts();

        // In this way we can delegate extra field update to
        // the Model itself (eg. adding slug or publishing date).
        $update = [];
        foreach ($data as $key => $value) {
            if (in_array($key, $fillables)) {
                $update[$key] = $this->isCastedAsArray($casts, $key) ? json_encode($value) : $value;
            }
        }

        $this->instanceQueryBuilder($model, $data)->update($update);
    }

    /**
     * Return if key is casted as array in model attributes casts.
     *
     * @param  array  $casts
     * @param  string  $key
     * @return bool
     */
    private function isCastedAsArray(array $casts, string $key): bool
    {
        if (isset($casts[$key]) && (Str::lower($casts[$key]) === 'array')) {
            return true;
        }

        return false;
    }

    /**
     * Return Eloquent QueryBuilder to target given entry.
     *
     * @param  \Distilleries\Contentful\Models\Base\ContentfulModel  $model
     * @param  array  $data
     * @return \Illuminate\Database\Eloquent\Builder
     */
    private function instanceQueryBuilder(ContentfulModel $model, array $data): Builder
    {
        return $model
            ->withoutGlobalScopes()
            ->where('contentful_id', '=', $data['contentful_id'])
            ->where('locale', '=', $data['locale'])
            ->where('country', '=', $data['country']);
    }
}


1			<?php
2
3			namespace Distilleries\Contentful\Repositories;
4
5			use Exception;
6			use Illuminate\Support\Str;
7			use Illuminate\Support\Collection;
8			use Illuminate\Support\Facades\DB;
9			use Illuminate\Database\Eloquent\Builder;
10			use Distilleries\Contentful\Models\Locale;
11			use Distilleries\Contentful\Helpers\NamespaceResolver;
12			use Distilleries\Contentful\Models\Base\ContentfulModel;
13			use Distilleries\Contentful\Models\Base\ContentfulMapper;
14
15			class EntriesRepository
16			{
17			use Traits\EntryType;
18
19			/**
20			* Truncate all tables extending a ContentfulModel.
21			*
22			* @return void
23			*/
24			public function truncateRelatedTables()
25			{
26			$modelPath = config('contentful.generator.model');
27
28			foreach (glob($modelPath . '/*.php') as $file) {
29			$modelInstance = NamespaceResolver::model(str_replace(
30			[$modelPath, '.php', '/'],
31			['', '', '\\'],
32			$file
33			));
34
35			if (! empty($modelInstance) && $modelInstance instanceof ContentfulModel) {
36			$modelInstance->query()->truncate();
37			}
38			}
39
40			DB::table('entry_types')->truncate();
41			DB::table('entry_relationships')->truncate();
42			}
43
44			/**
45			* Map Contentful entry payload to an Eloquent one.
46			*
47			* @param array $entry
48			* @param \Illuminate\Support\Collection $locales
49			* @return void
50			* @throws \Exception
51			*/
52			public function toContentfulModel(array $entry, Collection $locales)
53			{
54			$this->upsertEntryType($entry, $this->entryContentType($entry));
55			$this->deleteRelationships($entry);
56
57			$localeEntries = $this->entryMapper($entry)->toLocaleEntries($entry, $locales);
58			foreach ($localeEntries as $localeEntry) {
59			$model = $this->upsertLocale($entry, $localeEntry);
60
61			if (! empty($model)) {
62			if (isset($localeEntry['relationships'])) {
63			$this->handleRelationships($localeEntry['locale'],$localeEntry['country'], $localeEntry['contentful_id'], $this->entryContentType($entry), $localeEntry['relationships']);
64			unset($localeEntry['relationships']);
65			}
66			} else {
67			if (isset($localeEntry['relationships'])) {
68			unset($localeEntry['relationships']);
69			}
70			}
71			}
72			}
73
74			/**
75			* Delete entry and relationships.
76			*
77			* @param array $entry
78			* @return void
79			* @throws \Exception
80			*/
81			public function delete(array $entry)
82			{
83			$this->deleteEntryType($entry['sys']['id']);
84			$this->deleteRelationships($entry);
85
86			$this->entryModel($entry)->query()->where('contentful_id', '=', $entry['sys']['id'])->delete();
87			}
88
89			// --------------------------------------------------------------------------------
90			// --------------------------------------------------------------------------------
91			// --------------------------------------------------------------------------------
92
93			/**
94			* Return entry content-type.
95			*
96			* @param array $entry
97			* @return string
98			*/
99			private function entryContentType(array $entry): string
100			{
101			return $entry['sys']['contentType']['sys']['id'];
102			}
103
104			/**
105			* Return entry content-type mapper class instance.
106			*
107			* @param array $entry
108			* @return \Distilleries\Contentful\Models\Base\ContentfulMapper
109			* @throws \Exception
110			*/
111			private function entryMapper(array $entry): ContentfulMapper
112			{
113			$class = Str::studly($this->entryContentType($entry)) . 'Mapper';
114			$mapperClass = NamespaceResolver::mapper($class);
115
116			if (empty($mapperClass) && ! ($mapperClass instanceof ContentfulMapper)) {
117			throw new Exception('Unknown mapper: ' . $class);
118			}
119
120			return new $mapperClass;
121			}
122
123			/**
124			* Return entry content-type model class instance.
125			*
126			* @param array $entry
127			* @return \Distilleries\Contentful\Models\Base\ContentfulModel
128			* @throws \Exception
129			*/
130			private function entryModel(array $entry): ContentfulModel
131			{
132			$model = Str::studly($this->entryContentType($entry));
133			$modelClass = NamespaceResolver::modelClass($model);
134
135			if (empty($modelClass)) {
136			throw new Exception('Unknown model: ' . $model);
137			}
138
139			return new $modelClass;
140			}
141
142			// --------------------------------------------------------------------------------
143			// --------------------------------------------------------------------------------
144			// --------------------------------------------------------------------------------
145
146			/**
147			* Handle mapped relationships to fill `entry_relationships` pivot table.
148			*
149			* @param string $locale
150			* @param string $country
151			* @param string $sourceId
152			* @param string $sourceType
153			* @param array $relationships
154			* @return void
155			* @throws \Exception
156			*/
157			private function handleRelationships(string $locale, string $country, string $sourceId, string $sourceType, array $relationships = [])
158			{
159			DB::table('entry_relationships')
160			->where('locale', '=', $locale)
161			->where('country', '=', $country)
162			->where('source_contentful_id', '=', $sourceId)
163			->delete();
164
165			$order = 1;
166			foreach ($relationships as $relationship) {
167			if (! isset($relationship['id']) \|\| ! isset($relationship['type'])) {
168			throw new Exception('Relationships malformed! (' . print_r($relationship, true) . ')');
169			}
170
171			DB::table('entry_relationships')->insert([
172			'locale' => $locale,
173			'country' => $country,
174			'source_contentful_id' => $sourceId,
175			'source_contentful_type' => $sourceType,
176			'related_contentful_id' => $relationship['id'],
177			'related_contentful_type' => $relationship['type'],
178			'order' => $order,
179			'relation' => isset($relationship['field']) ? $relationship['field'] : null,
180			]);
181
182			$order++;
183			}
184			}
185
186			/**
187			* Delete entry relationships for given Contentful entry.
188			*
189			* @param array $entry
190			* @return void
191			*/
192			private function deleteRelationships(array $entry)
193			{
194			DB::table('entry_relationships')
195			->where('source_contentful_id', '=', $entry['sys']['id'])
196			->where('source_contentful_type', '=', $this->entryContentType($entry))
197			->delete();
198			}
199
200			// --------------------------------------------------------------------------------
201			// --------------------------------------------------------------------------------
202			// --------------------------------------------------------------------------------
203
204			/**
205			* Return inserted / updated model instance for given parameters.
206			*
207			* @param array $entry
208			* @param array $data
209			* @return \Distilleries\Contentful\Models\Base\ContentfulModel\|null
210			* @throws \Exception
211			*/
212			private function upsertLocale(array $entry, array $data): ?ContentfulModel
213			{
214			$model = $this->entryModel($entry);
215			if ((method_exists($model, 'bootNotNullSlug') && empty($data['slug'])) \|\| ! Locale::canBeSave($data['country'], $data['locale'])) {
216			// Remove instance if slug is empty
217			$instance = $this->instanceQueryBuilder($model, $data)->first();
218			if (! empty($instance)) {
219			$instance->delete();
220			}
221
222			return null;
223			}
224
225			if (! isset($data['payload'])) {
226			throw new Exception('Mapper for model ' . class_basename($model) . ' must set a "payload" key');
227			}
228
229			$instance = $this->instanceQueryBuilder($model, $data)->first();
230
231			if (empty($instance)) {
232			$model->fill($data)->save();
233			} else {
234			$this->overridePayloadAndExtraFillables($model, $data);
235			}
236
237			return $this->instanceQueryBuilder($model, $data)->first();
238			}
239
240			/**
241			* Override Eloquent entry with all fillable data.
242			*
243			* @param \Distilleries\Contentful\Models\Base\ContentfulModel $model
244			* @param array $data
245			* @return void
246			*/
247			private function overridePayloadAndExtraFillables(ContentfulModel $model, array $data)
248			{
249			$fillables = $model->getFillable();
250			$casts = $model->getCasts();
251
252			// In this way we can delegate extra field update to
253			// the Model itself (eg. adding slug or publishing date).
254			$update = [];
255			foreach ($data as $key => $value) {
256			if (in_array($key, $fillables)) {
257			$update[$key] = $this->isCastedAsArray($casts, $key) ? json_encode($value) : $value;
258			}
259			}
260
261			$this->instanceQueryBuilder($model, $data)->update($update);
262			}
263
264			/**
265			* Return if key is casted as array in model attributes casts.
266			*
267			* @param array $casts
268			* @param string $key
269			* @return bool
270			*/
271			private function isCastedAsArray(array $casts, string $key): bool
272			{
273			if (isset($casts[$key]) && (Str::lower($casts[$key]) === 'array')) {
274			return true;
275			}
276
277			return false;
278			}
279
280			/**
281			* Return Eloquent QueryBuilder to target given entry.
282			*
283			* @param \Distilleries\Contentful\Models\Base\ContentfulModel $model
284			* @param array $data
285			* @return \Illuminate\Database\Eloquent\Builder
286			*/
287			private function instanceQueryBuilder(ContentfulModel $model, array $data): Builder
288			{
289			return $model
290			->withoutGlobalScopes()
291			->where('contentful_id', '=', $data['contentful_id'])
292			->where('locale', '=', $data['locale'])
293			->where('country', '=', $data['country']);
294			}
295			}
296

Distilleries / Laravel-Contentful-Utilities

Push — master ( 29d5bf...009409 )

EntriesRepository::isCastedAsArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like