Distilleries\Contentful\Models\Base\ContentfulMapper

Complexity

Total Complexity

33

Size/Duplication

Total Lines	227
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
	map()	0	1	?
B	toLocaleEntries()	0	34	6
A	mapPayload()	0	20	5
A	levelFallBack()	0	6	2
B	mapRelationships()	0	22	6
A	relationshipSignature()	0	16	4
A	isLink()	0	4	3
A	contentTypeFromSyncEntries()	0	13	2
A	contentTypeFromEntryTypes()	0	13	2
A	entryLocales()	0	11	3

<?php

namespace Distilleries\Contentful\Models\Base;

use Exception;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Distilleries\Contentful\Models\Locale;
use Illuminate\Support\Str;

abstract class ContentfulMapper
{
    /**
     * Map entry specific payload.
     *
     * @param  array $entry
     * @param  string $locale
     * @return array
     * @throws \Exception
     */
    abstract protected function map(array $entry, string $locale): array;

    /**
     * Map entry with common data + specific payload for each locales.
     *
     * @param  array $entry
     * @return array
     * @throws \Exception
     */
    public function toLocaleEntries(array $entry, Collection $locales): array
    {
        $entries = [];
        $common = [
            'contentful_id' => $entry['sys']['id'],
            'created_at' => new Carbon($entry['sys']['createdAt']),
            'updated_at' => new Carbon($entry['sys']['updatedAt']),
        ];

        foreach ($locales as $locale) {
            // Add specific fields
            $data = array_merge($common, $this->map($entry, $locale->code));

            $data['country'] = Locale::getCountry($locale->code);
            $data['locale'] = Locale::getLocale($locale->code);

            if (!isset($data['payload'])) {
                $data['payload'] = $this->mapPayload($entry, $locale->code);
            }

            if (!isset($data['relationships'])) {
                $data['relationships'] = $this->mapRelationships($data['payload']);
            }

            if (isset($data['slug']) && Str::contains($data['slug'], 'untitled-')) {
                $data['slug'] = null;
            }


            $entries[] = $data;
        }

        return $entries;
    }

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

    /**
     * Return raw entry fields payload for given locale.
     *
     * @param  array $entry
     * @param  string $locale
     * @return array
     */
    protected function mapPayload(array $entry, string $locale): array
    {
        $payload = [];

        $fallbackLocale = Locale::fallback($locale);
        foreach ($entry['fields'] as $field => $localesData) {
            if (isset($localesData[$locale])) {
                $payload[$field] = $localesData[$locale];
            } else {
                // Fallback field...
                if (isset($localesData[$fallbackLocale]) && $this->levelFallBack($field) == 'all') {
                    $payload[$field] = $localesData[$fallbackLocale];
                } else {
                    $payload[$field] = null;
                }
            }
        }

        return $payload;
    }


    protected function levelFallBack($field)
    {
        $levelMaster = ['slug'];
        return in_array($field, $levelMaster) ? 'master' : 'all';

    }

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

    /**
     * Map relationships in given payload.
     *
     * @param  array $payload
     * @return array
     * @throws \Exception
     */
    protected function mapRelationships($payload): array
    {
        $relationships = [];

        foreach ($payload as $field => $value) {
            if (is_array($value)) {
                if ($this->isLink($value)) {
                    $relationships[] = $this->relationshipSignature($value);
                } else {
                    foreach ($value as $entry) {
                        if ($this->isLink($entry)) {
                            $relationships[] = $this->relationshipSignature($entry);
                        }
                    }
                }
            } else {

This else statement is empty and can be removed.

                // No relationship
            }
        }

        return $relationships;
    }

    /**
     * Return relationship signature for given "localized" field.
     *
     * @param  array $localeField
     * @return array|null
     * @throws \Exception
     */
    private function relationshipSignature($localeField): ?array
    {
        if ($localeField['sys']['linkType'] === 'Asset') {
            return ['id' => $localeField['sys']['id'], 'type' => 'asset'];
        } else if ($localeField['sys']['linkType'] === 'Entry') {
            if (app()->runningInConsole()) {
                // From SYNC
                return ['id' => $localeField['sys']['id'], 'type' => $this->contentTypeFromSyncEntries($localeField['sys']['id'])];
            } else {
                // From Webhook
                return ['id' => $localeField['sys']['id'], 'type' => $this->contentTypeFromEntryTypes($localeField['sys']['id'])];
            }
        }

        throw new Exception('Invalid field signature... ' . PHP_EOL . print_r($localeField, true));
    }

    /**
     * Return if field is a Link one.
     *
     * @param  mixed $localeField
     * @return bool
     */
    private function isLink($localeField): bool
    {
        return isset($localeField['sys']) and isset($localeField['sys']['type']) and ($localeField['sys']['type'] === 'Link');

Using logical operators such as and instead of && is generally not recommended.

    }

    /**
     * Return contentful-type for given Contentful ID from `sync_entries` table.
     *
     * @param  string $contentfulId
     * @return string
     * @throws \Exception
     */
    private function contentTypeFromSyncEntries(string $contentfulId): string
    {
        $pivot = DB::table('sync_entries')
            ->select('contentful_type')
            ->where('contentful_id', '=', $contentfulId)
            ->first();

        if (empty($pivot)) {
            throw new Exception('Unknown content-type from synced entry: ' . $contentfulId);
        }

        return $pivot->contentful_type;
    }

    /**
     * Return content-type for given Contentful ID from `entry_types` table.
     *
     * @param  string $contentfulId
     * @return string
     * @throws \Exception
     */
    private function contentTypeFromEntryTypes(string $contentfulId): string
    {
        $pivot = DB::table('entry_types')
            ->select('contentful_type')
            ->where('contentful_id', '=', $contentfulId)
            ->first();

        if (empty($pivot)) {
            throw new Exception('Unknown content-type from webhook entry: ' . $contentfulId);
        }

        return $pivot->contentful_type;
    }

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

    /**
     * Return all locales in entry payload.
     *
     * @param  array $entry
     * @return array
     */
    private function entryLocales(array $entry): array

This method is not used, and could be removed.

    {
        $locales = [];

        if (isset($entry['fields']) and !empty($entry['fields'])) {

Using logical operators such as and instead of && is generally not recommended.

            $firstField = array_first($entry['fields']);
            $locales = array_keys($firstField);
        }

        return $locales;
    }
}