Generator::validateSourceSizeList() - Code Metrics - Inspection of "Improve code climate" - jkphl/responsive-images-css - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2324c3...510281 )

by Joschi

created 2018-04-07 09:40 UTC

Generator::validateSourceSizeList() A

↳ Parent: Generator

Complexity

Conditions	3
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	2
nop	1
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
ccs	6
cts	6
cp	1
crap	3

<?php

/**
 * responsive-images-css
 *
 * @category   Jkphl
 * @package    Jkphl\Respimgcss
 * @subpackage Jkphl\Respimgcss\Infrastructure
 * @author     Joschi Kuphal <[email protected]> / @jkphl
 * @copyright  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Respimgcss\Infrastructure;

use Jkphl\Respimgcss\Application\Contract\UnitLengthInterface;
use Jkphl\Respimgcss\Application\Factory\ImageCandidateFactory;
use Jkphl\Respimgcss\Application\Factory\LengthFactory;
use Jkphl\Respimgcss\Application\Factory\SourceSizeFactory;
use Jkphl\Respimgcss\Application\Model\ImageCandidateSet;
use Jkphl\Respimgcss\Application\Service\CssRulesetCompilerService;
use Jkphl\Respimgcss\Domain\Contract\ImageCandidateInterface;
use Jkphl\Respimgcss\Ports\CssRuleset;
use Jkphl\Respimgcss\Ports\CssRulesetInterface;
use Jkphl\Respimgcss\Ports\GeneratorInterface;
use Jkphl\Respimgcss\Ports\InvalidArgumentException;

/**
 * Responsive image CSS generator (internal)
 *
 * @package    Jkphl\Respimgcss
 * @subpackage Jkphl\Respimgcss\Ports
 */
abstract class Generator implements GeneratorInterface
{
    /**
     * Breakpoints
     *
     * @var UnitLengthInterface[]
     */
    protected $breakpoints;
    /**
     * EM to pixel ratio
     *
     * @var int
     */
    protected $emPixel;
    /**
     * Image candidates
     *
     * @var ImageCandidateSet
     */
    protected $imageCandidates = null;

    /**
     * Generator constructor
     *
     * @param string[] $breakpoints List of breakpoint length strings
     * @param int $emPixel          EM to pixel ratio
     */
    public function __construct(array $breakpoints, int $emPixel)
    {
        $this->emPixel     = $emPixel;
        $lengthFactory     = new LengthFactory(new ViewportCalculatorServiceFactory(), $this->emPixel);
        $this->breakpoints = array_map(
            [$lengthFactory, 'createLengthFromString'],
            $breakpoints,
            array_fill(0, count($breakpoints), $this->emPixel)
        );
    }

    /**
     * Register an image candidate
     *
     * @param string $file            Image candidate file path and name
     * @param string|null $descriptor Image candidate descriptor
     *
     * @return GeneratorInterface Self reference
     * @api
     */
    public function registerImageCandidate(string $file, string $descriptor = null): GeneratorInterface
    {
        $imageCandidate = ($descriptor === null) ?
            ImageCandidateFactory::createImageCandidateFromString($file) :
            ImageCandidateFactory::createImageCandidateFromFileAndDescriptor($file, $descriptor);

        // If the image candidate set doesn't exist yet
        if ($this->imageCandidates === null) {
            $this->imageCandidates = new ImageCandidateSet($imageCandidate);

            return $this;
        }

        // Register the image candidate
        $this->imageCandidates[] = $imageCandidate;

        return $this;
    }

    /**
     * Return the registered image candidates
     *
     * @return ImageCandidateInterface[] Image candidates
     */
    public function getImageCandidates(): array
    {
        return ($this->imageCandidates === null) ? [] : $this->imageCandidates->toArray();
    }

    /**
     * Create a CSS ruleset for the registered image candidates
     *
     * @param float[] $densities Device display densities
     * @param string $sizes      Source sizes
     *
     * @return CssRulesetInterface CSS Ruleset
     */
    public function make(array $densities = [1], string $sizes = ''): CssRulesetInterface
    {
        $cssRuleset = new CssRuleset();

        // If all necessary properties are given
        if (count($this->breakpoints) && count($this->getImageCandidates()) && count($densities)) {
            $cssRuleset = $this->compileCssRuleset($cssRuleset, $densities, $sizes);
        }

        return $cssRuleset;
    }

    /**
     * Compile a CSS ruleset
     *
     * @param CssRuleset $baseCssRuleset                 Base CSS ruleset
     * @param ImageCandidateInterface[] $imageCandidates Image candidates
     * @param int[] $densities                           Densities
     * @param string $sizes                              Source sizes
     *
     * @return CssRulesetInterface Compile CSS ruleset
     */
    protected function compileCssRuleset(
        CssRuleset $baseCssRuleset,
        array $densities,
        string $sizes
    ): CssRulesetInterface {
        $sourceSizeList = $this->validateSourceSizeList($this->makeSourceSizeList($sizes));


        // Instantiate a CSS ruleset compiler service and compile for all densities
        $cssRulesetCompilerService = new CssRulesetCompilerService(
            $baseCssRuleset,
            $this->breakpoints,
            $this->imageCandidates,
            new ViewportCalculatorServiceFactory(),
            $this->emPixel
        );

        return new CssRuleset($cssRulesetCompilerService->compile($densities));
    }

    /**
     * Check whether a source sizes list can be applied
     *
     * @param SourceSizeList|null $sourceSizeList Source size list
     *
     * @return SourceSizeList|null Source size list
     * @throws InvalidArgumentException If source sizes are used with resolution based image candidates
     */
    protected function validateSourceSizeList(SourceSizeList $sourceSizeList = null): ?SourceSizeList
    {
        // If source sizes are used with resolution based image candidates
        if ($sourceSizeList && ($this->imageCandidates->getType() == ImageCandidateInterface::TYPE_DENSITY)) {
            throw new InvalidArgumentException(
                InvalidArgumentException::SIZES_NOT_ALLOWED_STR,
                InvalidArgumentException::SIZES_NOT_ALLOWED
            );
        }

        return $sourceSizeList;
    }

    /**
     * Create a size list from a source size list
     *
     * @param string $sourceSizeListStr SourceSizeList size list
     *
     * @return SourceSizeList Size list
     */
    protected function makeSourceSizeList(string $sourceSizeListStr): ?SourceSizeList
    {
        $sourceSizeFactory   = new SourceSizeFactory(new ViewportCalculatorServiceFactory(), $this->emPixel);
        $unparsedSourceSizes = array_filter(array_map('trim', explode(',', $sourceSizeListStr)));
        $sourceSizes         = array_map(
            function ($unparsedSourceSize) use ($sourceSizeFactory) {
                return $sourceSizeFactory->createFromSourceSizeStr($unparsedSourceSize);
            },
            $unparsedSourceSizes
        );

        return count($sourceSizes) ? new SourceSizeList($sourceSizes) : null;
    }
}

1		<?php
2
3		/**
4		* responsive-images-css
5		*
6		* @category Jkphl
7		* @package Jkphl\Respimgcss
8		* @subpackage Jkphl\Respimgcss\Infrastructure
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Jkphl\Respimgcss\Infrastructure;
38
39		use Jkphl\Respimgcss\Application\Contract\UnitLengthInterface;
40		use Jkphl\Respimgcss\Application\Factory\ImageCandidateFactory;
41		use Jkphl\Respimgcss\Application\Factory\LengthFactory;
42		use Jkphl\Respimgcss\Application\Factory\SourceSizeFactory;
43		use Jkphl\Respimgcss\Application\Model\ImageCandidateSet;
44		use Jkphl\Respimgcss\Application\Service\CssRulesetCompilerService;
45		use Jkphl\Respimgcss\Domain\Contract\ImageCandidateInterface;
46		use Jkphl\Respimgcss\Ports\CssRuleset;
47		use Jkphl\Respimgcss\Ports\CssRulesetInterface;
48		use Jkphl\Respimgcss\Ports\GeneratorInterface;
49		use Jkphl\Respimgcss\Ports\InvalidArgumentException;
50
51		/**
52		* Responsive image CSS generator (internal)
53		*
54		* @package Jkphl\Respimgcss
55		* @subpackage Jkphl\Respimgcss\Ports
56		*/
57		abstract class Generator implements GeneratorInterface
58		{
59		/**
60		* Breakpoints
61		*
62		* @var UnitLengthInterface[]
63		*/
64		protected $breakpoints;
65		/**
66		* EM to pixel ratio
67		*
68		* @var int
69		*/
70		protected $emPixel;
71		/**
72		* Image candidates
73		*
74		* @var ImageCandidateSet
75		*/
76		protected $imageCandidates = null;
77
78		/**
79		* Generator constructor
80		*
81		* @param string[] $breakpoints List of breakpoint length strings
82		* @param int $emPixel EM to pixel ratio
83		*/
84	6	public function __construct(array $breakpoints, int $emPixel)
85		{
86	6	$this->emPixel = $emPixel;
87	6	$lengthFactory = new LengthFactory(new ViewportCalculatorServiceFactory(), $this->emPixel);
88	6	$this->breakpoints = array_map(
89	6	[$lengthFactory, 'createLengthFromString'],
90	6	$breakpoints,
91	6	array_fill(0, count($breakpoints), $this->emPixel)
92		);
93	6	}
94
95		/**
96		* Register an image candidate
97		*
98		* @param string $file Image candidate file path and name
99		* @param string\|null $descriptor Image candidate descriptor
100		*
101		* @return GeneratorInterface Self reference
102		* @api
103		*/
104	6	public function registerImageCandidate(string $file, string $descriptor = null): GeneratorInterface
105		{
106	6	$imageCandidate = ($descriptor === null) ?
107	6	ImageCandidateFactory::createImageCandidateFromString($file) :
108	6	ImageCandidateFactory::createImageCandidateFromFileAndDescriptor($file, $descriptor);
109
110		// If the image candidate set doesn't exist yet
111	6	if ($this->imageCandidates === null) {
112	6	$this->imageCandidates = new ImageCandidateSet($imageCandidate);
113
114	6	return $this;
115		}
116
117		// Register the image candidate
118	6	$this->imageCandidates[] = $imageCandidate;
119
120	6	return $this;
121		}
122
123		/**
124		* Return the registered image candidates
125		*
126		* @return ImageCandidateInterface[] Image candidates
127		*/
128	6	public function getImageCandidates(): array
129		{
130	6	return ($this->imageCandidates === null) ? [] : $this->imageCandidates->toArray();
131		}
132
133		/**
134		* Create a CSS ruleset for the registered image candidates
135		*
136		* @param float[] $densities Device display densities
137		* @param string $sizes Source sizes
138		*
139		* @return CssRulesetInterface CSS Ruleset
140		*/
141	6	public function make(array $densities = [1], string $sizes = ''): CssRulesetInterface
142		{
143	6	$cssRuleset = new CssRuleset();
144
145		// If all necessary properties are given
146	6	if (count($this->breakpoints) && count($this->getImageCandidates()) && count($densities)) {
147	6	$cssRuleset = $this->compileCssRuleset($cssRuleset, $densities, $sizes);
148		}
149
150	4	return $cssRuleset;
151		}
152
153		/**
154		* Compile a CSS ruleset
155		*
156		* @param CssRuleset $baseCssRuleset Base CSS ruleset
157		* @param ImageCandidateInterface[] $imageCandidates Image candidates
158		* @param int[] $densities Densities
159		* @param string $sizes Source sizes
160		*
161		* @return CssRulesetInterface Compile CSS ruleset
162		*/
163	6	protected function compileCssRuleset(
164		CssRuleset $baseCssRuleset,
165		array $densities,
166		string $sizes
167		): CssRulesetInterface {
168	6	$sourceSizeList = $this->validateSourceSizeList($this->makeSourceSizeList($sizes));
		0 ignored issues – show Unused Code introduced 2018-04-07 09:42 UTC by Report Bug Copy Issue Report The assignment to `$sourceSizeList` is dead and can be removed. Loading history...
169
170		// Instantiate a CSS ruleset compiler service and compile for all densities
171	4	$cssRulesetCompilerService = new CssRulesetCompilerService(
172	4	$baseCssRuleset,
173	4	$this->breakpoints,
174	4	$this->imageCandidates,
175	4	new ViewportCalculatorServiceFactory(),
176	4	$this->emPixel
177		);
178
179	4	return new CssRuleset($cssRulesetCompilerService->compile($densities));
180		}
181
182		/**
183		* Check whether a source sizes list can be applied
184		*
185		* @param SourceSizeList\|null $sourceSizeList Source size list
186		*
187		* @return SourceSizeList\|null Source size list
188		* @throws InvalidArgumentException If source sizes are used with resolution based image candidates
189		*/
190	6	protected function validateSourceSizeList(SourceSizeList $sourceSizeList = null): ?SourceSizeList
191		{
192		// If source sizes are used with resolution based image candidates
193	6	if ($sourceSizeList && ($this->imageCandidates->getType() == ImageCandidateInterface::TYPE_DENSITY)) {
194	2	throw new InvalidArgumentException(
195	2	InvalidArgumentException::SIZES_NOT_ALLOWED_STR,
196	2	InvalidArgumentException::SIZES_NOT_ALLOWED
197		);
198		}
199
200	4	return $sourceSizeList;
201		}
202
203		/**
204		* Create a size list from a source size list
205		*
206		* @param string $sourceSizeListStr SourceSizeList size list
207		*
208		* @return SourceSizeList Size list
209		*/
210	6	protected function makeSourceSizeList(string $sourceSizeListStr): ?SourceSizeList
211		{
212	6	$sourceSizeFactory = new SourceSizeFactory(new ViewportCalculatorServiceFactory(), $this->emPixel);
213	6	$unparsedSourceSizes = array_filter(array_map('trim', explode(',', $sourceSizeListStr)));
214	6	$sourceSizes = array_map(
215	6	function ($unparsedSourceSize) use ($sourceSizeFactory) {
216	2	return $sourceSizeFactory->createFromSourceSizeStr($unparsedSourceSize);
217	6	},
218	6	$unparsedSourceSizes
219		);
220
221	6	return count($sourceSizes) ? new SourceSizeList($sourceSizes) : null;
222		}
223		}

jkphl / responsive-images-css

Push — master ( 2324c3...510281 )

Generator::validateSourceSizeList() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like