AbstractImage::withPalette() - Code Metrics - Inspection of "Immutable image and palette objects" - GravityMedia/Magickly - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c16185...55c0ed )

by Daniel

created 2016-09-15 19:43 UTC

AbstractImage::withPalette() A

↳ Parent: AbstractImage

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	9
cp	0
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	10
nc	3
nop	1
crap	12

<?php
/**
 * This file is part of the Magickly project.
 *
 * @author Daniel Schröder <[email protected]>
 */

namespace GravityMedia\Magickly\Image;

use GravityMedia\Magickly\Enum\ColorSpace;
use GravityMedia\Magickly\Image\Palette\PaletteInterface;

/**
 * Abstract image class.
 *
 * @package GravityMedia\Magickly\Image
 */
abstract class AbstractImage implements ImageInterface
{
    /**
     * {@inheritdoc}
     */
    public function getPalette()
    {
        switch ($this->getColorSpace()) {
            default:
                $palette = new Palette\RGB();
                break;
            case ColorSpace::COLOR_SPACE_CMYK:
                $palette = new Palette\CMYK();
                break;
            case ColorSpace::COLOR_SPACE_GRAYSCALE:
                $palette = new Palette\Grayscale();
                break;
        }

        $colorProfile = $this->getColorProfile();
        if (null !== $colorProfile) {
            $palette->setColorProfile($colorProfile);
        }

        return $palette;
    }

    /**
     * {@inheritdoc}
     */
    public function withPalette(PaletteInterface $palette)
    {
        $image = clone $this;

        if ($image->getColorSpace() === $palette->getColorSpace()) {
            return $image;
        }

        if (null === $image->getColorProfile()) {
            $image = $image->withColorProfile($image->getPalette()->getColorProfile());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        $image = $image
            ->withColorProfile($palette->getColorProfile())
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            ->withColorSpace($palette->getColorSpace());

        return $image;
    }
}


1			<?php
2			/**
3			* This file is part of the Magickly project.
4			*
5			* @author Daniel Schröder <[email protected]>
6			*/
7
8			namespace GravityMedia\Magickly\Image;
9
10			use GravityMedia\Magickly\Enum\ColorSpace;
11			use GravityMedia\Magickly\Image\Palette\PaletteInterface;
12
13			/**
14			* Abstract image class.
15			*
16			* @package GravityMedia\Magickly\Image
17			*/
18			abstract class AbstractImage implements ImageInterface
19			{
20			/**
21			* {@inheritdoc}
22			*/
23			public function getPalette()
24			{
25			switch ($this->getColorSpace()) {
26			default:
27			$palette = new Palette\RGB();
28			break;
29			case ColorSpace::COLOR_SPACE_CMYK:
30			$palette = new Palette\CMYK();
31			break;
32			case ColorSpace::COLOR_SPACE_GRAYSCALE:
33			$palette = new Palette\Grayscale();
34			break;
35			}
36
37			$colorProfile = $this->getColorProfile();
38			if (null !== $colorProfile) {
39			$palette->setColorProfile($colorProfile);
40			}
41
42			return $palette;
43			}
44
45			/**
46			* {@inheritdoc}
47			*/
48			public function withPalette(PaletteInterface $palette)
49			{
50			$image = clone $this;
51
52			if ($image->getColorSpace() === $palette->getColorSpace()) {
53			return $image;
54			}
55
56			if (null === $image->getColorProfile()) {
57			$image = $image->withColorProfile($image->getPalette()->getColorProfile());
			0 ignored issues – show Bug introduced 2016-09-15 19:55 UTC by Report Bug Copy Issue Report It seems like `$image->getPalette()->getColorProfile()` can be `null`; however, `withColorProfile()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
58			}
59
60			$image = $image
61			->withColorProfile($palette->getColorProfile())
			0 ignored issues – show Bug introduced 2016-09-15 19:55 UTC by Report Bug Copy Issue Report It seems like `$palette->getColorProfile()` can be `null`; however, `withColorProfile()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
62			->withColorSpace($palette->getColorSpace());
63
64			return $image;
65			}
66			}
67

GravityMedia / Magickly

Push — master ( c16185...55c0ed )

AbstractImage::withPalette() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like