RenderableFilesProcessor::processFiles() - Code Metrics - Inspection of "Merge pull request #16 from Symplify/v3-adding-2" - Symplify/PHP7_Sculpin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9b25f2...d42705 )

by Tomáš

created 2016-10-02 17:33 UTC

RenderableFilesProcessor::processFiles() C

↳ Parent: RenderableFilesProcessor

Complexity

Conditions	8
Paths	65

Size

Total Lines	42
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes

Metric	Value
dl	0
loc	42
ccs	0
cts	18
cp	0
rs	5.3846
c	0
b	0
f	0
cc	8
eloc	17
nc	65
nop	1
crap	72

<?php

declare(strict_types=1);

/*
 * This file is part of Symplify
 * Copyright (c) 2016 Tomas Votruba (http://tomasvotruba.cz).
 */

namespace Symplify\PHP7_Sculpin\Renderable;

use SplFileInfo;
use Symplify\PHP7_Sculpin\Output\FileSystemWriter;
use Symplify\PHP7_Sculpin\Configuration\Configuration;
use Symplify\PHP7_Sculpin\Renderable\Configuration\ConfigurationDecorator;
use Symplify\PHP7_Sculpin\Renderable\File\FileFactory;
use Symplify\PHP7_Sculpin\Renderable\File\PostFile;
use Symplify\PHP7_Sculpin\Renderable\Latte\LatteDecorator;
use Symplify\PHP7_Sculpin\Renderable\Markdown\MarkdownDecorator;
use Symplify\PHP7_Sculpin\Renderable\Routing\RouteDecorator;
use Symplify\PHP7_Sculpin\Renderable\Sorting\PostSorter;

final class RenderableFilesProcessor
{
    /**
     * @var FileFactory
     */
    private $fileFactory;

    /**
     * @var RouteDecorator
     */
    private $routeDecorator;

    /**
     * @var PostSorter
     */
    private $postSorter;

    /**
     * @var ConfigurationDecorator
     */
    private $configurationDecorator;

    /**
     * @var MarkdownDecorator
     */
    private $markdownDecorator;
    /**
     * @var LatteDecorator
     */
    private $latteDecorator;

    /**
     * @var FileSystemWriter
     */
    private $fileSystemWriter;
    /**
     * @var Configuration
     */
    private $configuration;

    public function __construct(
        FileFactory $fileFactory,
        RouteDecorator $routeDecorator,
        PostSorter $postSorter,
        ConfigurationDecorator $configurationDecorator,
        MarkdownDecorator $markdownDecorator,
        LatteDecorator $latteDecorator,
        FileSystemWriter $fileSystemWriter,
        Configuration $configuration
    ) {
        $this->fileFactory = $fileFactory;
        $this->routeDecorator = $routeDecorator;
        $this->postSorter = $postSorter;
        $this->configurationDecorator = $configurationDecorator;
        $this->markdownDecorator = $markdownDecorator;
        $this->latteDecorator = $latteDecorator;
        $this->fileSystemWriter = $fileSystemWriter;
        $this->configuration = $configuration;
    }

    /**
     * @param SplFileInfo[] $files
     */
    public function processFiles(array $files)
    {
        if (!count($files)) {
            return;
        }

        // 1. create file objects
        foreach ($files as $id => $file) {
            $files[$id] = $this->fileFactory->create($file);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        // 2. set routes
        foreach ($files as $file) {
            $this->routeDecorator->decorateFile($file);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        // 3. order (should be performed before render)
        if ($files[0] instanceof PostFile) {
            $files = $this->postSorter->sort($files);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            // set posts to configuration
            $this->configuration->addOption('posts', $files);
        }

        // 4. detect and set options
        foreach ($files as $file) {
            $this->configurationDecorator->decorateFile($file);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        // 5. format Markdown to HTML
        foreach ($files as $file) {
            $this->markdownDecorator->decorateFile($file);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        // 6. format Latte to HTML
        foreach ($files as $file) {
            $this->latteDecorator->decorateFile($file);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        // 7. save files
        $this->fileSystemWriter->copyRenderableFiles($files);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of Symplify
7			* Copyright (c) 2016 Tomas Votruba (http://tomasvotruba.cz).
8			*/
9
10			namespace Symplify\PHP7_Sculpin\Renderable;
11
12			use SplFileInfo;
13			use Symplify\PHP7_Sculpin\Output\FileSystemWriter;
14			use Symplify\PHP7_Sculpin\Configuration\Configuration;
15			use Symplify\PHP7_Sculpin\Renderable\Configuration\ConfigurationDecorator;
16			use Symplify\PHP7_Sculpin\Renderable\File\FileFactory;
17			use Symplify\PHP7_Sculpin\Renderable\File\PostFile;
18			use Symplify\PHP7_Sculpin\Renderable\Latte\LatteDecorator;
19			use Symplify\PHP7_Sculpin\Renderable\Markdown\MarkdownDecorator;
20			use Symplify\PHP7_Sculpin\Renderable\Routing\RouteDecorator;
21			use Symplify\PHP7_Sculpin\Renderable\Sorting\PostSorter;
22
23			final class RenderableFilesProcessor
24			{
25			/**
26			* @var FileFactory
27			*/
28			private $fileFactory;
29
30			/**
31			* @var RouteDecorator
32			*/
33			private $routeDecorator;
34
35			/**
36			* @var PostSorter
37			*/
38			private $postSorter;
39
40			/**
41			* @var ConfigurationDecorator
42			*/
43			private $configurationDecorator;
44
45			/**
46			* @var MarkdownDecorator
47			*/
48			private $markdownDecorator;
49			/**
50			* @var LatteDecorator
51			*/
52			private $latteDecorator;
53
54			/**
55			* @var FileSystemWriter
56			*/
57			private $fileSystemWriter;
58			/**
59			* @var Configuration
60			*/
61			private $configuration;
62
63			public function __construct(
64			FileFactory $fileFactory,
65			RouteDecorator $routeDecorator,
66			PostSorter $postSorter,
67			ConfigurationDecorator $configurationDecorator,
68			MarkdownDecorator $markdownDecorator,
69			LatteDecorator $latteDecorator,
70			FileSystemWriter $fileSystemWriter,
71			Configuration $configuration
72			) {
73			$this->fileFactory = $fileFactory;
74			$this->routeDecorator = $routeDecorator;
75			$this->postSorter = $postSorter;
76			$this->configurationDecorator = $configurationDecorator;
77			$this->markdownDecorator = $markdownDecorator;
78			$this->latteDecorator = $latteDecorator;
79			$this->fileSystemWriter = $fileSystemWriter;
80			$this->configuration = $configuration;
81			}
82
83			/**
84			* @param SplFileInfo[] $files
85			*/
86			public function processFiles(array $files)
87			{
88			if (!count($files)) {
89			return;
90			}
91
92			// 1. create file objects
93			foreach ($files as $id => $file) {
94			$files[$id] = $this->fileFactory->create($file);
			0 ignored issues – show Bug introduced 2016-10-02 17:40 UTC by Report Bug Copy Issue Report It seems like `$file` defined by `$file` on line `93` can also be of type `object<Symplify\PHP7_Scu...n\Renderable\File\File>`; however, `Symplify\PHP7_Sculpin\Re...e\FileFactory::create()` does only seem to accept `object<SplFileInfo>`, 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...
95			}
96
97			// 2. set routes
98			foreach ($files as $file) {
99			$this->routeDecorator->decorateFile($file);
			0 ignored issues – show Bug introduced 2016-10-02 17:40 UTC by Report Bug Copy Issue Report It seems like `$file` defined by `$file` on line `98` can also be of type `object<SplFileInfo>`; however, `Symplify\PHP7_Sculpin\Re...corator::decorateFile()` does only seem to accept `object<Symplify\PHP7_Scu...n\Renderable\File\File>`, 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...
100			}
101
102			// 3. order (should be performed before render)
103			if ($files[0] instanceof PostFile) {
104			$files = $this->postSorter->sort($files);
			0 ignored issues – show Documentation introduced 2016-10-02 17:40 UTC by Report Bug Copy Issue Report `$files` is of type `array<integer,object<Spl...ble\\File\\PostFile>"}>`, but the function expects a `array<integer,object<Sym...derable\File\PostFile>>`. 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...
105
106			// set posts to configuration
107			$this->configuration->addOption('posts', $files);
108			}
109
110			// 4. detect and set options
111			foreach ($files as $file) {
112			$this->configurationDecorator->decorateFile($file);
			0 ignored issues – show Bug introduced 2016-10-02 17:40 UTC by Report Bug Copy Issue Report It seems like `$file` defined by `$file` on line `111` can also be of type `object<SplFileInfo>`; however, `Symplify\PHP7_Sculpin\Re...corator::decorateFile()` does only seem to accept `object<Symplify\PHP7_Scu...n\Renderable\File\File>`, 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...
113			}
114
115			// 5. format Markdown to HTML
116			foreach ($files as $file) {
117			$this->markdownDecorator->decorateFile($file);
			0 ignored issues – show Bug introduced 2016-10-02 17:40 UTC by Report Bug Copy Issue Report It seems like `$file` defined by `$file` on line `116` can also be of type `object<SplFileInfo>`; however, `Symplify\PHP7_Sculpin\Re...corator::decorateFile()` does only seem to accept `object<Symplify\PHP7_Scu...n\Renderable\File\File>`, 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...
118			}
119
120			// 6. format Latte to HTML
121			foreach ($files as $file) {
122			$this->latteDecorator->decorateFile($file);
			0 ignored issues – show Bug introduced 2016-10-02 17:40 UTC by Report Bug Copy Issue Report It seems like `$file` defined by `$file` on line `121` can also be of type `object<SplFileInfo>`; however, `Symplify\PHP7_Sculpin\Re...corator::decorateFile()` does only seem to accept `object<Symplify\PHP7_Scu...n\Renderable\File\File>`, 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...
123			}
124
125			// 7. save files
126			$this->fileSystemWriter->copyRenderableFiles($files);
			0 ignored issues – show Documentation introduced 2016-10-02 17:40 UTC by Report Bug Copy Issue Report `$files` is of type `array<integer,object<Spl...\Renderable\File\File>>`, but the function expects a `array<integer,object<Sym...\Renderable\File\File>>`. 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...
127			}
128			}
129

Symplify / PHP7_Sculpin

Push — master ( 9b25f2...d42705 )

RenderableFilesProcessor::processFiles() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like