SyncFlatten::flattenSyncedData() - Code Metrics - Inspection of "Fix sync trait" - Distilleries/Laravel-Contentful-Utilities - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 09cc32...487230 )

by Maxime

created 2018-08-02 13:42 UTC

SyncFlatten::flattenSyncedData() A

↳ Parent: SyncFlatten

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
nc	3
nop	0
dl	0
loc	21
ccs	0
cts	18
cp	0
crap	12
rs	9.584
c	0
b	0
f	0

<?php

namespace Distilleries\Contentful\Commands\Sync;

use stdClass;
use Exception;
use Illuminate\Console\Command;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Distilleries\Contentful\Models\Locale;
use Symfony\Component\Console\Helper\ProgressBar;
use Distilleries\Contentful\Repositories\AssetsRepository;
use Distilleries\Contentful\Repositories\EntriesRepository;

class SyncFlatten extends Command
{
    use Traits\SyncTrait;

    /**
     * Number of entries to fetch per pagination.
     *
     * @var integer
     */
    const PER_BATCH = 50;

    /**
     * {@inheritdoc}
     */
    protected $signature = 'contentful:sync-flatten {--preview}';

    /**
     * {@inheritdoc}
     */
    protected $description = 'Map and persist previously synced Contentful data';

    /**
     * Assets repository instance.
     *
     * @var \Distilleries\Contentful\Repositories\AssetsRepository
     */
    protected $assets;

    /**
     * Entries repository instance.
     *
     * @var \Distilleries\Contentful\Repositories\EntriesRepository
     */
    protected $entries;

    /**
     * MapEntries command constructor.
     *
     * @return void

     */
    public function __construct()
    {
        parent::__construct();

        $this->assets = new AssetsRepository;

        $this->entries = new EntriesRepository;
    }

    /**
     * Execute the console command.
     *
     * @return void
     */
    public function handle()
    {
        $isPreview = $this->option('preview');
        if ($isPreview) {
            use_contentful_preview();
        }

        $dumpPath = $this->dumpSync($isPreview);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->putSync($dumpPath, $isPreview,'mysql_sync');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->switchToSyncDb();
        $this->line('Truncate Contentful related tables');
        $this->assets->truncateRelatedTables();
        $this->entries->truncateRelatedTables();
        $this->line('Map and persist synced data');

        try {
            $this->flattenSyncedData();
        } catch (Exception $e) {
            echo PHP_EOL;
            $this->error($e->getMessage());
            return;
        }

        $dumpPath = $this->dumpSync($isPreview,'mysql_sync');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->putSync($dumpPath, $isPreview);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Map and persist synced data.
     *
     * @return void
     * @throws \Exception
     */
    private function flattenSyncedData()
    {
        $page = 1;
        $paginator = DB::table('sync_entries')->paginate(static::PER_BATCH, ['*'], 'page', $page);
        $locales = Locale::all();

        $bar = $this->createProgressBar($paginator->total());
        while ($paginator->isNotEmpty()) {
            foreach ($paginator->items() as $item) {
                $bar->setMessage('Map entry ID: ' . $item->contentful_id);
                $this->mapItemToContentfulModel($item,$locales);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $bar->advance();
            }

            $page++;
            $paginator = DB::table('sync_entries')->paginate(static::PER_BATCH, ['*'], 'page', $page);
        }
        $bar->finish();

        echo PHP_EOL;
    }

    /**
     * Create custom progress bar.
     *
     * @param  integer  $total
     * @return \Symfony\Component\Console\Helper\ProgressBar
     */
    private function createProgressBar(int $total): ProgressBar
    {
        $bar = $this->output->createProgressBar($total);

        $bar->setFormat("%message%" . PHP_EOL . " %current%/%max% [%bar%] %percent:3s%%");

        return $bar;
    }

    /**
     * Map and persist given sync_entries item.
     *
     * @param  \stdClass  $item
     * @param \Illuminate\Support\Collection $locales
     * @return void
     * @throws \Exception
     */
    private function mapItemToContentfulModel(stdClass $item, Collection $locales)
    {
        $entry = json_decode($item->payload, true);

        if ($item->contentful_type === 'asset') {
            $this->assets->toContentfulModel($entry,$locales);
        } else {
            $this->entries->toContentfulModel($entry,$locales);
        }
    }
}


1			<?php
2
3			namespace Distilleries\Contentful\Commands\Sync;
4
5			use stdClass;
6			use Exception;
7			use Illuminate\Console\Command;
8			use Illuminate\Support\Collection;
9			use Illuminate\Support\Facades\DB;
10			use Distilleries\Contentful\Models\Locale;
11			use Symfony\Component\Console\Helper\ProgressBar;
12			use Distilleries\Contentful\Repositories\AssetsRepository;
13			use Distilleries\Contentful\Repositories\EntriesRepository;
14
15			class SyncFlatten extends Command
16			{
17			use Traits\SyncTrait;
18
19			/**
20			* Number of entries to fetch per pagination.
21			*
22			* @var integer
23			*/
24			const PER_BATCH = 50;
25
26			/**
27			* {@inheritdoc}
28			*/
29			protected $signature = 'contentful:sync-flatten {--preview}';
30
31			/**
32			* {@inheritdoc}
33			*/
34			protected $description = 'Map and persist previously synced Contentful data';
35
36			/**
37			* Assets repository instance.
38			*
39			* @var \Distilleries\Contentful\Repositories\AssetsRepository
40			*/
41			protected $assets;
42
43			/**
44			* Entries repository instance.
45			*
46			* @var \Distilleries\Contentful\Repositories\EntriesRepository
47			*/
48			protected $entries;
49
50			/**
51			* MapEntries command constructor.
52			*
53			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-07-10 09:53 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
54			*/
55			public function __construct()
56			{
57			parent::__construct();
58
59			$this->assets = new AssetsRepository;
60
61			$this->entries = new EntriesRepository;
62			}
63
64			/**
65			* Execute the console command.
66			*
67			* @return void
68			*/
69			public function handle()
70			{
71			$isPreview = $this->option('preview');
72			if ($isPreview) {
73			use_contentful_preview();
74			}
75
76			$dumpPath = $this->dumpSync($isPreview);
			0 ignored issues – show Documentation introduced 2018-07-10 09:53 UTC by Report Bug Copy Issue Report `$isPreview` is of type `string\|array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
77			$this->putSync($dumpPath, $isPreview,'mysql_sync');
			0 ignored issues – show Documentation introduced 2018-07-13 15:05 UTC by Report Bug Copy Issue Report `$isPreview` is of type `string\|array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
78
79			$this->switchToSyncDb();
80			$this->line('Truncate Contentful related tables');
81			$this->assets->truncateRelatedTables();
82			$this->entries->truncateRelatedTables();
83			$this->line('Map and persist synced data');
84
85			try {
86			$this->flattenSyncedData();
87			} catch (Exception $e) {
88			echo PHP_EOL;
89			$this->error($e->getMessage());
90			return;
91			}
92
93			$dumpPath = $this->dumpSync($isPreview,'mysql_sync');
			0 ignored issues – show Documentation introduced 2018-07-13 15:05 UTC by Report Bug Copy Issue Report `$isPreview` is of type `string\|array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
94			$this->putSync($dumpPath, $isPreview);
			0 ignored issues – show Documentation introduced 2018-07-10 09:53 UTC by Report Bug Copy Issue Report `$isPreview` is of type `string\|array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
95			}
96
97			/**
98			* Map and persist synced data.
99			*
100			* @return void
101			* @throws \Exception
102			*/
103			private function flattenSyncedData()
104			{
105			$page = 1;
106			$paginator = DB::table('sync_entries')->paginate(static::PER_BATCH, ['*'], 'page', $page);
107			$locales = Locale::all();
108
109			$bar = $this->createProgressBar($paginator->total());
110			while ($paginator->isNotEmpty()) {
111			foreach ($paginator->items() as $item) {
112			$bar->setMessage('Map entry ID: ' . $item->contentful_id);
113			$this->mapItemToContentfulModel($item,$locales);
			0 ignored issues – show Bug introduced 2018-07-13 15:05 UTC by Report Bug Copy Issue Report It seems like `$locales` defined by `\Distilleries\Contentful\Models\Locale::all()` on line `107` can also be of type `array<integer,object<Ill...base\Eloquent\Builder>>`; however, `Distilleries\Contentful\...ItemToContentfulModel()` does only seem to accept `object<Illuminate\Support\Collection>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
114			$bar->advance();
115			}
116
117			$page++;
118			$paginator = DB::table('sync_entries')->paginate(static::PER_BATCH, ['*'], 'page', $page);
119			}
120			$bar->finish();
121
122			echo PHP_EOL;
123			}
124
125			/**
126			* Create custom progress bar.
127			*
128			* @param integer $total
129			* @return \Symfony\Component\Console\Helper\ProgressBar
130			*/
131			private function createProgressBar(int $total): ProgressBar
132			{
133			$bar = $this->output->createProgressBar($total);
134
135			$bar->setFormat("%message%" . PHP_EOL . " %current%/%max% [%bar%] %percent:3s%%");
136
137			return $bar;
138			}
139
140			/**
141			* Map and persist given sync_entries item.
142			*
143			* @param \stdClass $item
144			* @param \Illuminate\Support\Collection $locales
145			* @return void
146			* @throws \Exception
147			*/
148			private function mapItemToContentfulModel(stdClass $item, Collection $locales)
149			{
150			$entry = json_decode($item->payload, true);
151
152			if ($item->contentful_type === 'asset') {
153			$this->assets->toContentfulModel($entry,$locales);
154			} else {
155			$this->entries->toContentfulModel($entry,$locales);
156			}
157			}
158			}
159

Distilleries / Laravel-Contentful-Utilities

Push — master ( 09cc32...487230 )

SyncFlatten::flattenSyncedData() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like