Image - Code Metrics - Inspection of "add quality() method in Image field" - Cherry-Pie/Jarboe - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b6337b...c70fa1 )

by Yaro

created 2021-05-11 10:42 UTC

Image C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	342
Duplicated Lines	2.63 %

Coupling/Cohesion

Components	2
Dependencies	13

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	54
lcom	2
cbo	13
dl	9
loc	342
ccs	0
cts	234
cp	0
rs	6.4799
c	0
b	0
f	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isEncode()	0	4	1
A	encode()	0	6	1
B	storeFile()	0	31	10
C	value()	0	79	10
A	crop()	0	6	1
A	ratio()	0	7	1
A	isCrop()	0	4	1
A	getRatio()	0	12	3
A	getListView()	0	7	1
A	getEditFormView()	9	9	2
A	getCreateFormView()	0	7	1
A	getImage()	0	4	1
A	isTransparentColor()	0	13	2
A	generateFilename()	0	18	5
B	getImagesPack()	0	24	6
A	autoOpen()	0	6	1
A	shouldAutoOpenModal()	0	8	2
A	quality()	0	13	3
A	getQuality()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

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:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Image 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

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 Image, and based on these observations, apply Extract Interface, too.

<?php

namespace Yaro\Jarboe\Table\Fields;

use Illuminate\Http\Request;
use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage as IlluminateStorage;
use Illuminate\Support\Str;
use Intervention\Image\ImageManagerStatic as InterventionImage;
use Yaro\Jarboe\Table\Fields\Traits\Filename;
use Yaro\Jarboe\Table\Fields\Traits\Nullable;
use Yaro\Jarboe\Table\Fields\Traits\Placeholder;
use Yaro\Jarboe\Table\Fields\Traits\Storage;

class Image extends AbstractField
{
    use Storage;
    use Placeholder;
    use Nullable;
    use Filename;

    protected $encode = false;
    protected $crop = false;
    protected $shouldAutoOpen = null;
    protected $ratio = [
        'width'  => false,
        'height' => false,
    ];
    private $originalImageData;
    private $defaultImageDataStructure =  [
        'storage' => [
            'disk' => null,
            'is_encoded' => false,
        ],
        'crop' => [
            'width' => null,
            'height' => null,
            'x' => null,
            'y' => null,
            'rotate' => null,
            'rotate_background' => null,
        ],
        'sources' => [
            'original' => null,
            'cropped' => null,
        ],
    ];

    /**
     * @var int
     */
    private $quality = 100;

    public function __construct()
    {
        $this->disk = config('filesystems.default');
    }

    public function isEncode()
    {
        return $this->encode;
    }

    /**
     * Encode image as data-url.
     *
     * @param bool $encode
     * @return $this
     */
    public function encode(bool $encode = true)
    {
        $this->encode = $encode;

        return $this;
    }

    protected function storeFile($filepath, $filename, $width = null, $height = null, $x = null, $y = null, $rotate = null, $rotateBackgroundColor = null)
    {
        $image = InterventionImage::make($filepath);
        $rotateBackgroundColor = $rotateBackgroundColor ?: 'rgba(255, 255, 255, 0)';

        if ($rotate) {
            // because js plugin and php library rotating in different directions.
            $angle = $rotate * -1;
            $image->rotate($angle, $rotateBackgroundColor);
        }
        $hasCropProperties = !is_null($width) && !is_null($height) && !is_null($x) && !is_null($y);
        if ($this->isCrop() && $hasCropProperties) {
            $image->crop(round($width), round($height), round($x), round($y));
        }

        if ($this->isEncode()) {
            return (string) $image->encode('data-url', $this->getQuality());
        }

        $format = '';
        if ($this->isTransparentColor($rotateBackgroundColor)) {
            $format = 'png';
        }
        $path = trim($this->getPath() .'/'. $filename, '/');
        IlluminateStorage::disk($this->getDisk())->put(
            $path,
            (string) $image->encode($format, $this->getQuality())
        );

        return $path;
    }

    public function value(Request $request)

    {
        $images = $request->all($this->name());
        $images = $images[$this->name()];

        $data = [];
        foreach ($images as $image) {
            $imageData = $this->defaultImageDataStructure;
            $imageData['storage'] = [
                'disk' => $this->getDisk(),
                'is_encoded' => $this->isEncode(),
            ];

            $imageData['crop'] = $image['crop'];
            $imageData['sources'] = $image['sources'];
            /** @var UploadedFile|null $file */
            $file = $image['file'] ?? null;
            if ($file) {
                $imageData['sources']['original'] = $this->storeFile(
                    $file->getRealPath(),
                    $this->generateFilename(
                        $request,
                        $file,
                        $image,
                        $this->isTransparentColor((string) $image['crop']['rotate_background']),
                        true
                    )
                );
                $imageData['sources']['cropped'] = $this->storeFile(
                    $file->getRealPath(),
                    $this->generateFilename(
                        $request,
                        $file,
                        $image,
                        $this->isTransparentColor((string) $image['crop']['rotate_background']),
                        false
                    ),
                    $image['crop']['width'],
                    $image['crop']['height'],
                    $image['crop']['x'],
                    $image['crop']['y'],
                    $image['crop']['rotate'],
                    $image['crop']['rotate_background']
                );
            } elseif (!$image['sources']['original']) {
                continue;
            } elseif ($this->isCrop() && !$image['sources']['cropped']) {
                $imageData['sources']['cropped'] = $this->storeFile(
                    IlluminateStorage::disk($this->getDisk())->path($imageData['sources']['original']),
                    $this->generateFilename(
                        $request,
                        null,
                        $image,
                        $this->isTransparentColor((string) $image['crop']['rotate_background']),
                        false
                    ),
                    $image['crop']['width'],
                    $image['crop']['height'],
                    $image['crop']['x'],
                    $image['crop']['y'],
                    $image['crop']['rotate'],
                    $image['crop']['rotate_background']
                );
            }

            $data[] = $imageData;
        }

        if (!$this->isMultiple()) {
            $data = array_pop($data);
        }

        $data = $data ?: [];
        if ($this->isNullable()) {
            $data = $data ?: null;
        }

        return $data;
    }

    public function crop(bool $enabled = true)
    {
        $this->crop = $enabled;

        return $this;
    }

    public function ratio(int $width, int $height)
    {
        $this->ratio['width'] = $width;
        $this->ratio['height'] = $height;

        return $this;
    }

    public function isCrop()
    {
        return $this->crop;
    }

    public function getRatio(string $type)

    {
        $type = strtolower($type);

        switch ($type) {
            case 'width':
            case 'height':
                return $this->ratio[$type];
            default:
                return false;
        }
    }

    public function getListView($model)
    {
        return view('jarboe::crud.fields.image.list', [
            'model' => $model,
            'field' => $this,
        ]);
    }

    public function getEditFormView($model)
    {
        $template = $this->isReadonly() ? 'readonly' : 'edit';

        return view('jarboe::crud.fields.image.'. $template, [
            'model' => $model,
            'field' => $this,
        ]);
    }

    public function getCreateFormView()
    {
        return view('jarboe::crud.fields.image.create', [
            'model' => null,
            'field' => $this,
        ]);
    }

    public function getImage($data = []): \Yaro\Jarboe\Pack\Image
    {
        return new \Yaro\Jarboe\Pack\Image($data);
    }

    private function isTransparentColor(string $rgbaColor)
    {
        if (!$rgbaColor) {
            return false;
        }

        $segmentsString = preg_replace('~rgba\(|\)~', '', $rgbaColor);
        $segments = explode(',', $segmentsString);

        $opacity = $segments[3] ?? 0;

        return $opacity < 1;
    }

    /**
     * @param Request $request
     * @param UploadedFile|null $file
     * @param array $imageData
     * @param bool $hasTransparentColor
     * @param bool $isOriginalImage
     * @return string
     */
    private function generateFilename(Request $request, UploadedFile $file = null, array $imageData, bool $hasTransparentColor, bool $isOriginalImage): string
    {
        $isRecropFromOriginal = !$file && !$isOriginalImage;
        $extension = $isRecropFromOriginal ? pathinfo($imageData['sources']['original'], PATHINFO_EXTENSION) : $file->extension();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
        $filename = Str::random(40) .'.'. $extension;

        $closure = $this->filenameClosure;
        if (is_callable($closure)) {
            $filename = $closure($file, $request, $imageData, $isOriginalImage);
        }

        if ($hasTransparentColor) {
            $regexp = '~'. preg_quote(pathinfo($filename, PATHINFO_EXTENSION)) .'$~';
            $filename = preg_replace($regexp, 'png', $filename);
        }

        return (string) $filename;
    }

    public function getImagesPack($model): array
    {
        $defaultImage = $this->getImage();
        if (!$model) {
            return [$defaultImage];
        }

        $imagesData = $this->getAttribute($model);
        if (!is_array($imagesData)) {
            $imagesData = [];
        }

        if (!$this->isMultiple()) {
            $imagesData = [$imagesData];
        }


        $pack = [];
        foreach ($imagesData as $imageData) {
            $pack[] = $this->getImage($imageData);
        }

        return $pack ?: [$defaultImage];
    }

    public function autoOpen(bool $shouldAutoOpen = true)
    {
        $this->shouldAutoOpen = $shouldAutoOpen;

        return $this;
    }

    public function shouldAutoOpenModal(): bool
    {
        if (!is_null($this->shouldAutoOpen)) {
            return $this->shouldAutoOpen;
        }

        return $this->isCrop();
    }

    public function quality(int $quality)
    {
        if ($quality < 0) {
            $quality = 0;
        }
        if ($quality > 100) {
            $quality = 100;
        }

        $this->quality = $quality;

        return $this;
    }

    /**
     * @return int
     */
    public function getQuality(): int
    {
        return $this->quality;
    }
}


1		<?php
2
3		namespace Yaro\Jarboe\Table\Fields;
4
5		use Illuminate\Http\Request;
6		use Illuminate\Http\UploadedFile;
7		use Illuminate\Support\Facades\Storage as IlluminateStorage;
8		use Illuminate\Support\Str;
9		use Intervention\Image\ImageManagerStatic as InterventionImage;
10		use Yaro\Jarboe\Table\Fields\Traits\Filename;
11		use Yaro\Jarboe\Table\Fields\Traits\Nullable;
12		use Yaro\Jarboe\Table\Fields\Traits\Placeholder;
13		use Yaro\Jarboe\Table\Fields\Traits\Storage;
14
15		class Image extends AbstractField
16		{
17		use Storage;
18		use Placeholder;
19		use Nullable;
20		use Filename;
21
22		protected $encode = false;
23		protected $crop = false;
24		protected $shouldAutoOpen = null;
25		protected $ratio = [
26		'width' => false,
27		'height' => false,
28		];
29		private $originalImageData;
30		private $defaultImageDataStructure = [
31		'storage' => [
32		'disk' => null,
33		'is_encoded' => false,
34		],
35		'crop' => [
36		'width' => null,
37		'height' => null,
38		'x' => null,
39		'y' => null,
40		'rotate' => null,
41		'rotate_background' => null,
42		],
43		'sources' => [
44		'original' => null,
45		'cropped' => null,
46		],
47		];
48
49		/**
50		* @var int
51		*/
52		private $quality = 100;
53
54		public function __construct()
55		{
56		$this->disk = config('filesystems.default');
57		}
58
59		public function isEncode()
60		{
61		return $this->encode;
62		}
63
64		/**
65		* Encode image as data-url.
66		*
67		* @param bool $encode
68		* @return $this
69		*/
70		public function encode(bool $encode = true)
71		{
72		$this->encode = $encode;
73
74		return $this;
75		}
76
77		protected function storeFile($filepath, $filename, $width = null, $height = null, $x = null, $y = null, $rotate = null, $rotateBackgroundColor = null)
78		{
79		$image = InterventionImage::make($filepath);
80		$rotateBackgroundColor = $rotateBackgroundColor ?: 'rgba(255, 255, 255, 0)';
81
82		if ($rotate) {
83		// because js plugin and php library rotating in different directions.
84		$angle = $rotate * -1;
85		$image->rotate($angle, $rotateBackgroundColor);
86		}
87		$hasCropProperties = !is_null($width) && !is_null($height) && !is_null($x) && !is_null($y);
88		if ($this->isCrop() && $hasCropProperties) {
89		$image->crop(round($width), round($height), round($x), round($y));
90		}
91
92		if ($this->isEncode()) {
93		return (string) $image->encode('data-url', $this->getQuality());
94		}
95
96		$format = '';
97		if ($this->isTransparentColor($rotateBackgroundColor)) {
98		$format = 'png';
99		}
100		$path = trim($this->getPath() .'/'. $filename, '/');
101		IlluminateStorage::disk($this->getDisk())->put(
102		$path,
103		(string) $image->encode($format, $this->getQuality())
104		);
105
106		return $path;
107		}
108
109		public function value(Request $request)
		0 ignored issues – show Documentation introduced 2019-08-31 12:57 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
110		{
111		$images = $request->all($this->name());
112		$images = $images[$this->name()];
113
114		$data = [];
115		foreach ($images as $image) {
116		$imageData = $this->defaultImageDataStructure;
117		$imageData['storage'] = [
118		'disk' => $this->getDisk(),
119		'is_encoded' => $this->isEncode(),
120		];
121
122		$imageData['crop'] = $image['crop'];
123		$imageData['sources'] = $image['sources'];
124		/** @var UploadedFile\|null $file */
125		$file = $image['file'] ?? null;
126		if ($file) {
127		$imageData['sources']['original'] = $this->storeFile(
128		$file->getRealPath(),
129		$this->generateFilename(
130		$request,
131		$file,
132		$image,
133		$this->isTransparentColor((string) $image['crop']['rotate_background']),
134		true
135		)
136		);
137		$imageData['sources']['cropped'] = $this->storeFile(
138		$file->getRealPath(),
139		$this->generateFilename(
140		$request,
141		$file,
142		$image,
143		$this->isTransparentColor((string) $image['crop']['rotate_background']),
144		false
145		),
146		$image['crop']['width'],
147		$image['crop']['height'],
148		$image['crop']['x'],
149		$image['crop']['y'],
150		$image['crop']['rotate'],
151		$image['crop']['rotate_background']
152		);
153		} elseif (!$image['sources']['original']) {
154		continue;
155		} elseif ($this->isCrop() && !$image['sources']['cropped']) {
156		$imageData['sources']['cropped'] = $this->storeFile(
157		IlluminateStorage::disk($this->getDisk())->path($imageData['sources']['original']),
158		$this->generateFilename(
159		$request,
160		null,
161		$image,
162		$this->isTransparentColor((string) $image['crop']['rotate_background']),
163		false
164		),
165		$image['crop']['width'],
166		$image['crop']['height'],
167		$image['crop']['x'],
168		$image['crop']['y'],
169		$image['crop']['rotate'],
170		$image['crop']['rotate_background']
171		);
172		}
173
174		$data[] = $imageData;
175		}
176
177		if (!$this->isMultiple()) {
178		$data = array_pop($data);
179		}
180
181		$data = $data ?: [];
182		if ($this->isNullable()) {
183		$data = $data ?: null;
184		}
185
186		return $data;
187		}
188
189		public function crop(bool $enabled = true)
190		{
191		$this->crop = $enabled;
192
193		return $this;
194		}
195
196		public function ratio(int $width, int $height)
197		{
198		$this->ratio['width'] = $width;
199		$this->ratio['height'] = $height;
200
201		return $this;
202		}
203
204		public function isCrop()
205		{
206		return $this->crop;
207		}
208
209		public function getRatio(string $type)
		0 ignored issues – show Documentation introduced 2020-04-26 10:12 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
210		{
211		$type = strtolower($type);
212
213		switch ($type) {
214		case 'width':
215		case 'height':
216		return $this->ratio[$type];
217		default:
218		return false;
219		}
220		}
221
222		public function getListView($model)
223		{
224		return view('jarboe::crud.fields.image.list', [
225		'model' => $model,
226		'field' => $this,
227		]);
228		}
229
230	View Code Duplication	public function getEditFormView($model)
231		{
232		$template = $this->isReadonly() ? 'readonly' : 'edit';
233
234		return view('jarboe::crud.fields.image.'. $template, [
235		'model' => $model,
236		'field' => $this,
237		]);
238		}
239
240		public function getCreateFormView()
241		{
242		return view('jarboe::crud.fields.image.create', [
243		'model' => null,
244		'field' => $this,
245		]);
246		}
247
248		public function getImage($data = []): \Yaro\Jarboe\Pack\Image
249		{
250		return new \Yaro\Jarboe\Pack\Image($data);
251		}
252
253		private function isTransparentColor(string $rgbaColor)
254		{
255		if (!$rgbaColor) {
256		return false;
257		}
258
259		$segmentsString = preg_replace('~rgba\(\|\)~', '', $rgbaColor);
260		$segments = explode(',', $segmentsString);
261
262		$opacity = $segments[3] ?? 0;
263
264		return $opacity < 1;
265		}
266
267		/**
268		* @param Request $request
269		* @param UploadedFile\|null $file
270		* @param array $imageData
271		* @param bool $hasTransparentColor
272		* @param bool $isOriginalImage
273		* @return string
274		*/
275		private function generateFilename(Request $request, UploadedFile $file = null, array $imageData, bool $hasTransparentColor, bool $isOriginalImage): string
276		{
277		$isRecropFromOriginal = !$file && !$isOriginalImage;
278		$extension = $isRecropFromOriginal ? pathinfo($imageData['sources']['original'], PATHINFO_EXTENSION) : $file->extension();
		0 ignored issues – show Bug introduced 2020-04-26 10:12 UTC by Report Bug Copy Issue Report It seems like `$file` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
279		$filename = Str::random(40) .'.'. $extension;
280
281		$closure = $this->filenameClosure;
282		if (is_callable($closure)) {
283		$filename = $closure($file, $request, $imageData, $isOriginalImage);
284		}
285
286		if ($hasTransparentColor) {
287		$regexp = '~'. preg_quote(pathinfo($filename, PATHINFO_EXTENSION)) .'$~';
288		$filename = preg_replace($regexp, 'png', $filename);
289		}
290
291		return (string) $filename;
292		}
293
294		public function getImagesPack($model): array
295		{
296		$defaultImage = $this->getImage();
297		if (!$model) {
298		return [$defaultImage];
299		}
300
301		$imagesData = $this->getAttribute($model);
302		if (!is_array($imagesData)) {
303		$imagesData = [];
304		}
305
306		if (!$this->isMultiple()) {
307		$imagesData = [$imagesData];
308		}
309
310
311		$pack = [];
312		foreach ($imagesData as $imageData) {
313		$pack[] = $this->getImage($imageData);
314		}
315
316		return $pack ?: [$defaultImage];
317		}
318
319		public function autoOpen(bool $shouldAutoOpen = true)
320		{
321		$this->shouldAutoOpen = $shouldAutoOpen;
322
323		return $this;
324		}
325
326		public function shouldAutoOpenModal(): bool
327		{
328		if (!is_null($this->shouldAutoOpen)) {
329		return $this->shouldAutoOpen;
330		}
331
332		return $this->isCrop();
333		}
334
335		public function quality(int $quality)
336		{
337		if ($quality < 0) {
338		$quality = 0;
339		}
340		if ($quality > 100) {
341		$quality = 100;
342		}
343
344		$this->quality = $quality;
345
346		return $this;
347		}
348
349		/**
350		* @return int
351		*/
352		public function getQuality(): int
353		{
354		return $this->quality;
355		}
356		}
357

Cherry-Pie / Jarboe