Compiler - Code Metrics - Inspection of "Fix Watch command inability to compile updated par..." - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#46)

by Vladimir

created 2017-04-15 08:21 UTC

Compiler B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	428
Duplicated Lines	7.01 %

Coupling/Cohesion

Components	1
Dependencies	15

Test Coverage

Coverage

80.15%

Importance

Changes

Metric	Value
wmc	37
lcom	1
cbo	15
dl	30
loc	428
ccs	109
cts	136
cp	0.8015
rs	7.8833
c	0
b	0
f	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	setRedirectTemplate()	0	4	1
A	setTargetFolder()	0	4	1
A	setPageViews()	0	5	1
A	setThemeName()	0	4	1
A	isParentTemplate()	0	4	1
A	refreshParent()	0	7	2
A	compileAll()	0	7	2
A	compileSome()	0	11	3
B	compilePageView()	0	25	4
A	compileStaticPageView()	0	8	1
B	compileDynamicPageViews()	0	23	4
A	compileRepeaterPageViews()	17	17	2
A	compileContentItem()	13	13	1
A	compileStandardRedirects()	0	15	2
A	compileExpandedRedirects()	0	22	3
A	renderRepeaterPageView()	0	14	1
A	renderDynamicPageView()	0	9	1
A	renderStaticPageView()	0	10	1
B	createTwigTemplate()	0	33	4

How to fix Duplicated Code

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx;

use allejo\stakx\Command\BuildableCommand;
use allejo\stakx\Document\ContentItem;
use allejo\stakx\Document\DynamicPageView;
use allejo\stakx\Document\PageView;
use allejo\stakx\Document\RepeaterPageView;
use allejo\stakx\FrontMatter\ExpandedValue;
use allejo\stakx\Manager\BaseManager;
use allejo\stakx\Manager\ThemeManager;
use allejo\stakx\Manager\TwigManager;
use allejo\stakx\System\Folder;
use Twig_Environment;
use Twig_Error_Syntax;
use Twig_Source;
use Twig_Template;

/**
 * This class takes care of rendering the Twig body of PageViews with the respective information and it also takes care
 * of writing the rendered Twig to the filesystem.
 *
 * @internal
 *
 * @since 0.1.1
 */
class Compiler extends BaseManager
{
    /** @var string|false */
    private $redirectTemplate;

    /** @var Twig_Template[] */
    private $templateDependencies;

    /** @var PageView[] */
    private $pageViewsFlattened;

    /** @var PageView[][] */
    private $pageViews;

    /** @var Folder */
    private $folder;

    /** @var string */
    private $theme;

    /** @var Twig_Environment */
    private $twig;

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

        $this->twig = TwigManager::getInstance();
        $this->theme = '';
    }

    /**
     * @param string|false $template
     */
    public function setRedirectTemplate($template)
    {
        $this->redirectTemplate = $template;
    }

    /**
     * @param Folder $folder
     */
    public function setTargetFolder(Folder $folder)
    {
        $this->folder = $folder;
    }

    /**
     * @param PageView[][] $pageViews
     * @param PageView[]   $pageViewsFlattened
     */
    public function setPageViews(array &$pageViews, array &$pageViewsFlattened)
    {
        $this->pageViews = &$pageViews;
        $this->pageViewsFlattened = &$pageViewsFlattened;
    }

    public function setThemeName($themeName)
    {
        $this->theme = $themeName;
    }

    ///
    // Twig parent templates
    ///

    /**
     * Check whether a given file path is used as a parent template by a PageView
     *
     * @param  string $filePath
     *
     * @return bool
     */
    public function isParentTemplate($filePath)
    {
        return isset($this->templateDependencies[$filePath]);
    }

    /**
     * Rebuild all of the PageViews that used a given template as a parent
     *
     * @param string $filePath The file path to the parent Twig template
     */
    public function refreshParent($filePath)
    {
        foreach ($this->templateDependencies[$filePath] as &$parentTemplate)

        {
            $this->compilePageView($parentTemplate);
        }
    }

    ///
    // IO Functionality
    ///

    /**
     * Compile all of the PageViews registered with the compiler.
     *
     * @since 0.1.0
     */
    public function compileAll()
    {
        foreach ($this->pageViewsFlattened as &$pageView)
        {
            $this->compilePageView($pageView);
        }
    }

    public function compileSome($filter = array())
    {
        /** @var PageView $pageView */
        foreach ($this->pageViewsFlattened as &$pageView)
        {
            if ($pageView->hasTwigDependency($filter['namespace'], $filter['dependency']))
            {
                $this->compilePageView($pageView);
            }
        }
    }

    /**
     * Compile an individual PageView item.
     *
     * This function will take care of determining *how* to treat the PageView and write the compiled output to a the
     * respective target file.
     *
     * @param DynamicPageView|RepeaterPageView|PageView $pageView The PageView that needs to be compiled
     *
     * @since 0.1.1
     */
    public function compilePageView(&$pageView)
    {
        $this->output->debug('Compiling {type} PageView: {pageview}', array(
            'pageview' => $pageView->getRelativeFilePath(),
            'type' => $pageView->getType()
        ));

        switch ($pageView->getType())
        {
            case PageView::STATIC_TYPE:
                $this->compileStaticPageView($pageView);
                $this->compileStandardRedirects($pageView);
                break;

            case PageView::DYNAMIC_TYPE:
                $this->compileDynamicPageViews($pageView);

                $this->compileStandardRedirects($pageView);
                break;

            case PageView::REPEATER_TYPE:
                $this->compileRepeaterPageViews($pageView);

                $this->compileExpandedRedirects($pageView);
                break;
        }
    }

    /**
     * Write the compiled output for a static PageView.
     *
     * @param PageView $pageView
     *
     * @since 0.1.1
     */
    private function compileStaticPageView(&$pageView)
    {
        $targetFile = $pageView->getTargetFile();
        $output = $this->renderStaticPageView($pageView);

        $this->output->notice('Writing file: {file}', array('file' => $targetFile));
        $this->folder->writeFile($targetFile, $output);
    }

    /**
     * Write the compiled output for a dynamic PageView.
     *
     * @param DynamicPageView $pageView
     *
     * @since 0.1.1
     */
    private function compileDynamicPageViews(&$pageView)
    {
        $contentItems = $pageView->getContentItems();
        $template = $this->createTwigTemplate($pageView);

        foreach ($contentItems as &$contentItem)
        {
            if ($contentItem->isDraft() && !Service::getParameter(BuildableCommand::USE_DRAFTS))
            {
                $this->output->debug('{file}: marked as a draft', array(
                    'file' => $contentItem->getRelativeFilePath()
                ));

                continue;
            }

            $targetFile = $contentItem->getTargetFile();
            $output = $this->renderDynamicPageView($template, $pageView, $contentItem);

            $this->output->notice('Writing file: {file}', array('file' => $targetFile));
            $this->folder->writeFile($targetFile, $output);
        }
    }

    /**
     * Write the compiled output for a repeater PageView.
     *
     * @param RepeaterPageView $pageView
     *
     * @since 0.1.1
     */
    private function compileRepeaterPageViews(&$pageView)

    {
        $pageView->rewindPermalink();

        $template = $this->createTwigTemplate($pageView);
        $permalinks = $pageView->getRepeaterPermalinks();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        foreach ($permalinks as $permalink)
        {
            $pageView->bumpPermalink();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $targetFile = $pageView->getTargetFile();
            $output = $this->renderRepeaterPageView($template, $pageView, $permalink);

            $this->output->notice('Writing repeater file: {file}', array('file' => $targetFile));
            $this->folder->writeFile($targetFile, $output);
        }
    }

    /**
     * @deprecated
     *
     * @todo This function needs to be rewritten or removed. Something
     *
     * @param ContentItem $contentItem
     */
    public function compileContentItem(&$contentItem)

    {
        $pageView = $contentItem->getPageView();
        $template = $this->createTwigTemplate($pageView);

        $contentItem->evaluateFrontMatter($pageView->getFrontMatter(false));

        $targetFile = $contentItem->getTargetFile();
        $output = $this->renderDynamicPageView($template, $pageView, $contentItem);

        $this->output->notice('Writing file: {file}', array('file' => $targetFile));
        $this->folder->writeFile($targetFile, $output);
    }

    ///
    // Redirect handling
    ///

    /**
     * Write redirects for standard redirects.
     *
     * @param PageView $pageView
     *
     * @since 0.1.1
     */
    private function compileStandardRedirects(&$pageView)
    {
        $redirects = $pageView->getRedirects();

        foreach ($redirects as $redirect)
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
        {
            $redirectPageView = PageView::createRedirect(
                $redirect,
                $pageView->getPermalink(),
                $this->redirectTemplate
            );

            $this->compileStaticPageView($redirectPageView);
        }
    }

    /**
     * Write redirects for expanded redirects.
     *
     * @param RepeaterPageView $pageView
     *
     * @since 0.1.1
     */
    private function compileExpandedRedirects(&$pageView)
    {
        $permalinks = $pageView->getRepeaterPermalinks();

        /** @var ExpandedValue[] $repeaterRedirect */
        foreach ($pageView->getRepeaterRedirects() as $repeaterRedirect)
        {
            /**
             * @var int           $index
             * @var ExpandedValue $redirect
             */
            foreach ($repeaterRedirect as $index => $redirect)
            {
                $redirectPageView = PageView::createRedirect(
                    $redirect->getEvaluated(),
                    $permalinks[$index]->getEvaluated(),
                    $this->redirectTemplate
                );
                $this->compilePageView($redirectPageView);
            }
        }
    }

    ///
    // Twig Functionality
    ///

    /**
     * Get the compiled HTML for a specific iteration of a repeater PageView.
     *
     * @param Twig_Template $template
     * @param PageView      $pageView
     * @param ExpandedValue $expandedValue
     *
     * @since  0.1.1
     *
     * @return string
     */
    private function renderRepeaterPageView(&$template, &$pageView, &$expandedValue)
    {
        $this->twig->addGlobal('__currentTemplate', $pageView->getFilePath());

        $pageView->setFrontMatter(array(
            'permalink' => $expandedValue->getEvaluated(),
            'iterators' => $expandedValue->getIterators(),
        ));

        return $template
            ->render(array(
                'this' => $pageView->createJail(),
            ));
    }

    /**
     * Get the compiled HTML for a specific ContentItem.
     *
     * @param Twig_Template $template
     * @param PageView      $pageView
     * @param ContentItem   $contentItem
     *
     * @since  0.1.1
     *
     * @return string
     */
    private function renderDynamicPageView(&$template, &$pageView, &$contentItem)
    {
        $this->twig->addGlobal('__currentTemplate', $pageView->getFilePath());

        return $template
            ->render(array(
                'this' => $contentItem->createJail(),
            ));
    }

    /**
     * Get the compiled HTML for a static PageView.
     *
     * @param PageView $pageView
     *
     * @since  0.1.1
     *
     * @throws \Exception
     * @throws \Throwable
     * @throws Twig_Error_Syntax
     *
     * @return string
     */
    private function renderStaticPageView(&$pageView)
    {
        $this->twig->addGlobal('__currentTemplate', $pageView->getFilePath());

        return $this
            ->createTwigTemplate($pageView)
            ->render(array(
                'this' => $pageView->createJail(),
            ));
    }

    /**
     * Create a Twig template that just needs an array to render.
     *
     * @param PageView $pageView The PageView whose body will be used for Twig compilation
     *
     * @since  0.1.1
     *
     * @throws \Exception
     * @throws \Throwable
     * @throws Twig_Error_Syntax
     *
     * @return Twig_Template
     */
    private function createTwigTemplate(&$pageView)
    {
        try
        {
            $template = $this->twig->createTemplate($pageView->getContent());

            if (Service::getParameter(BuildableCommand::WATCHING))
            {
                $parent = $template->getParent(array());

                while (false !== $parent)
                {
                    $path = str_replace('@theme', $this->fs->appendPath(ThemeManager::THEME_FOLDER, $this->theme), $parent->getTemplateName());
                    $this->templateDependencies[$path][$pageView->getName()] = &$pageView;

                    $parent = $parent->getParent(array());
                }
            }

            return $template;
        }
        catch (Twig_Error_Syntax $e)
        {
            $e->setTemplateLine($e->getTemplateLine() + $pageView->getLineOffset());
            $e->setSourceContext(new Twig_Source(
                $pageView->getContent(),
                $pageView->getName(),
                $pageView->getRelativeFilePath()
            ));

            throw $e;
        }
    }
}


Pull Request — master (#46)

Compiler B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

20 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* @copyright 2017 Vladimir Jimenez
5			* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6			*/
7
8			namespace allejo\stakx;
9
10			use allejo\stakx\Command\BuildableCommand;
11			use allejo\stakx\Document\ContentItem;
12			use allejo\stakx\Document\DynamicPageView;
13			use allejo\stakx\Document\PageView;
14			use allejo\stakx\Document\RepeaterPageView;
15			use allejo\stakx\FrontMatter\ExpandedValue;
16			use allejo\stakx\Manager\BaseManager;
17			use allejo\stakx\Manager\ThemeManager;
18			use allejo\stakx\Manager\TwigManager;
19			use allejo\stakx\System\Folder;
20			use Twig_Environment;
21			use Twig_Error_Syntax;
22			use Twig_Source;
23			use Twig_Template;
24
25			/**
26			* This class takes care of rendering the Twig body of PageViews with the respective information and it also takes care
27			* of writing the rendered Twig to the filesystem.
28			*
29			* @internal
30			*
31			* @since 0.1.1
32			*/
33			class Compiler extends BaseManager
34			{
35			/** @var string\|false */
36			private $redirectTemplate;
37
38			/** @var Twig_Template[] */
39			private $templateDependencies;
40
41			/** @var PageView[] */
42			private $pageViewsFlattened;
43
44			/** @var PageView[][] */
45			private $pageViews;
46
47			/** @var Folder */
48			private $folder;
49	14
50			/** @var string */
51	14		private $theme;
52
53	14		/** @var Twig_Environment */
54	14		private $twig;
55
56			public function __construct()
57			{
58			parent::__construct();
59
60			$this->twig = TwigManager::getInstance();
61			$this->theme = '';
62			}
63
64			/**
65			* @param string\|false $template
66			*/
67	14		public function setRedirectTemplate($template)
68			{
69	14		$this->redirectTemplate = $template;
70	14		}
71
72			/**
73			* @param Folder $folder
74			*/
75			public function setTargetFolder(Folder $folder)
76	14		{
77			$this->folder = $folder;
78	14		}
79	14
80	14		/**
81			* @param PageView[][] $pageViews
82			* @param PageView[] $pageViewsFlattened
83			*/
84			public function setPageViews(array &$pageViews, array &$pageViewsFlattened)
85			{
86			$this->pageViews = &$pageViews;
87			$this->pageViewsFlattened = &$pageViewsFlattened;
88			}
89
90			public function setThemeName($themeName)
91	14		{
92			$this->theme = $themeName;
93	14		}
94
95	14		///
96	14		// Twig parent templates
97	14		///
98
99			/**
100			* Check whether a given file path is used as a parent template by a PageView
101			*
102			* @param string $filePath
103			*
104			* @return bool
105			*/
106			public function isParentTemplate($filePath)
107			{
108			return isset($this->templateDependencies[$filePath]);
109			}
110
111			/**
112			* Rebuild all of the PageViews that used a given template as a parent
113			*
114			* @param string $filePath The file path to the parent Twig template
115			*/
116			public function refreshParent($filePath)
117			{
118			foreach ($this->templateDependencies[$filePath] as &$parentTemplate)
			0 ignored issues – show Bug introduced 2017-04-12 05:03 UTC by Report Bug Copy Issue Report The expression `$this->templateDependencies[$filePath]` of type `object<Twig_Template>` is not traversable. Loading history...
119			{
120			$this->compilePageView($parentTemplate);
121	14		}
122			}
123	14
124	14		///
125	14		// IO Functionality
126	14		///
127
128	14		/**
129			* Compile all of the PageViews registered with the compiler.
130	14		*
131	10		* @since 0.1.0
132	10		*/
133	10		public function compileAll()
134			{
135	4		foreach ($this->pageViewsFlattened as &$pageView)
136	2		{
137	2		$this->compilePageView($pageView);
138	2		}
139			}
140	2
141	2		public function compileSome($filter = array())
142	2		{
143	2		/** @var PageView $pageView */
144	14		foreach ($this->pageViewsFlattened as &$pageView)
145	14		{
146			if ($pageView->hasTwigDependency($filter['namespace'], $filter['dependency']))
147			{
148			$this->compilePageView($pageView);
149			}
150			}
151			}
152
153			/**
154	10		* Compile an individual PageView item.
155			*
156	10		* This function will take care of determining how to treat the PageView and write the compiled output to a the
157	10		* respective target file.
158			*
159	10		* @param DynamicPageView\|RepeaterPageView\|PageView $pageView The PageView that needs to be compiled
160	10		*
161	10		* @since 0.1.1
162			*/
163			public function compilePageView(&$pageView)
164			{
165			$this->output->debug('Compiling {type} PageView: {pageview}', array(
166			'pageview' => $pageView->getRelativeFilePath(),
167			'type' => $pageView->getType()
168			));
169
170	3		switch ($pageView->getType())
171			{
172	2		case PageView::STATIC_TYPE:
173	2		$this->compileStaticPageView($pageView);
174			$this->compileStandardRedirects($pageView);
175	2		break;
176
177	2		case PageView::DYNAMIC_TYPE:
178	2		$this->compileDynamicPageViews($pageView);
			1 ignored issue – show Compatibility introduced 2017-03-25 04:29 UTC by Report Bug Copy Issue Report `$pageView` of type `object<allejo\stakx\Document\PageView>` is not a sub-type of `object<allejo\stakx\Document\DynamicPageView>`. It seems like you assume a child class of the class `allejo\stakx\Document\PageView` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
179	1		$this->compileStandardRedirects($pageView);
180	1		break;
181	1
182			case PageView::REPEATER_TYPE:
183	1		$this->compileRepeaterPageViews($pageView);
			1 ignored issue – show Compatibility introduced 2017-03-25 04:29 UTC by Report Bug Copy Issue Report `$pageView` of type `object<allejo\stakx\Document\PageView>` is not a sub-type of `object<allejo\stakx\Document\RepeaterPageView>`. It seems like you assume a child class of the class `allejo\stakx\Document\PageView` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
184			$this->compileExpandedRedirects($pageView);
185			break;
186	2		}
187	3		}
188
189	2		/**
190	2		* Write the compiled output for a static PageView.
191	2		*
192	2		* @param PageView $pageView
193			*
194			* @since 0.1.1
195			*/
196			private function compileStaticPageView(&$pageView)
197			{
198			$targetFile = $pageView->getTargetFile();
199			$output = $this->renderStaticPageView($pageView);
200
201	2		$this->output->notice('Writing file: {file}', array('file' => $targetFile));
202			$this->folder->writeFile($targetFile, $output);
203	2		}
204
205	2		/**
206	2		* Write the compiled output for a dynamic PageView.
207			*
208	2		* @param DynamicPageView $pageView
209			*
210	2		* @since 0.1.1
211	2		*/
212	2		private function compileDynamicPageViews(&$pageView)
213			{
214	2		$contentItems = $pageView->getContentItems();
215	2		$template = $this->createTwigTemplate($pageView);
216	2
217	2		foreach ($contentItems as &$contentItem)
218			{
219			if ($contentItem->isDraft() && !Service::getParameter(BuildableCommand::USE_DRAFTS))
220			{
221			$this->output->debug('{file}: marked as a draft', array(
222			'file' => $contentItem->getRelativeFilePath()
223			));
224
225			continue;
226			}
227
228			$targetFile = $contentItem->getTargetFile();
229			$output = $this->renderDynamicPageView($template, $pageView, $contentItem);
230
231			$this->output->notice('Writing file: {file}', array('file' => $targetFile));
232			$this->folder->writeFile($targetFile, $output);
233			}
234			}
235
236			/**
237			* Write the compiled output for a repeater PageView.
238			*
239			* @param RepeaterPageView $pageView
240			*
241			* @since 0.1.1
242			*/
243		View Code Duplication	private function compileRepeaterPageViews(&$pageView)
			0 ignored issues – show Duplication introduced 2017-03-17 07:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
244			{
245			$pageView->rewindPermalink();
246
247			$template = $this->createTwigTemplate($pageView);
248			$permalinks = $pageView->getRepeaterPermalinks();
			0 ignored issues – show Bug introduced 2017-03-25 04:29 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `allejo\stakx\Document\PageView` as the method `getRepeaterPermalinks()` does only exist in the following sub-classes of `allejo\stakx\Document\PageView`: `allejo\stakx\Document\RepeaterPageView`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
249
250			foreach ($permalinks as $permalink)
251	12		{
252			$pageView->bumpPermalink();
			0 ignored issues – show Bug introduced 2017-03-25 04:29 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `allejo\stakx\Document\PageView` as the method `bumpPermalink()` does only exist in the following sub-classes of `allejo\stakx\Document\PageView`: `allejo\stakx\Document\RepeaterPageView`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
253	12		$targetFile = $pageView->getTargetFile();
254			$output = $this->renderRepeaterPageView($template, $pageView, $permalink);
255	12
256			$this->output->notice('Writing repeater file: {file}', array('file' => $targetFile));
257	4		$this->folder->writeFile($targetFile, $output);
258	4		}
259	4		}
260	4
261	4		/**
262			* @deprecated
263	4		*
264	12		* @todo This function needs to be rewritten or removed. Something
265	12		*
266			* @param ContentItem $contentItem
267			*/
268		View Code Duplication	public function compileContentItem(&$contentItem)
			0 ignored issues – show Duplication introduced 2017-03-24 08:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
269			{
270			$pageView = $contentItem->getPageView();
271			$template = $this->createTwigTemplate($pageView);
272
273			$contentItem->evaluateFrontMatter($pageView->getFrontMatter(false));
274	2
275			$targetFile = $contentItem->getTargetFile();
276	2		$output = $this->renderDynamicPageView($template, $pageView, $contentItem);
277
278			$this->output->notice('Writing file: {file}', array('file' => $targetFile));
279	2		$this->folder->writeFile($targetFile, $output);
280			}
281
282			///
283			// Redirect handling
284			///
285
286			/**
287			* Write redirects for standard redirects.
288			*
289			* @param PageView $pageView
290			*
291			* @since 0.1.1
292			*/
293			private function compileStandardRedirects(&$pageView)
294	2		{
295	2		$redirects = $pageView->getRedirects();
296
297			foreach ($redirects as $redirect)
			0 ignored issues – show Bug introduced 2017-03-21 01:32 UTC by Report Bug Copy Issue Report The expression `$redirects` of type `null\|array<integer,string>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
298			{
299			$redirectPageView = PageView::createRedirect(
300			$redirect,
301			$pageView->getPermalink(),
302			$this->redirectTemplate
303			);
304
305			$this->compileStaticPageView($redirectPageView);
306			}
307			}
308
309			/**
310			* Write redirects for expanded redirects.
311			*
312	2		* @param RepeaterPageView $pageView
313			*
314	2		* @since 0.1.1
315			*/
316	2		private function compileExpandedRedirects(&$pageView)
317	2		{
318	2		$permalinks = $pageView->getRepeaterPermalinks();
319	2
320			/** @var ExpandedValue[] $repeaterRedirect */
321			foreach ($pageView->getRepeaterRedirects() as $repeaterRedirect)
322	2		{
323	2		/**
324	2		* @var int $index
325			* @var ExpandedValue $redirect
326			*/
327			foreach ($repeaterRedirect as $index => $redirect)
328			{
329			$redirectPageView = PageView::createRedirect(
330			$redirect->getEvaluated(),
331			$permalinks[$index]->getEvaluated(),
332			$this->redirectTemplate
333			);
334			$this->compilePageView($redirectPageView);
335			}
336			}
337			}
338	2
339			///
340	2		// Twig Functionality
341			///
342
343	2		/**
344	2		* Get the compiled HTML for a specific iteration of a repeater PageView.
345	2		*
346			* @param Twig_Template $template
347			* @param PageView $pageView
348			* @param ExpandedValue $expandedValue
349			*
350			* @since 0.1.1
351			*
352			* @return string
353			*/
354			private function renderRepeaterPageView(&$template, &$pageView, &$expandedValue)
355			{
356			$this->twig->addGlobal('__currentTemplate', $pageView->getFilePath());
357
358			$pageView->setFrontMatter(array(
359			'permalink' => $expandedValue->getEvaluated(),
360			'iterators' => $expandedValue->getIterators(),
361	10		));
362
363	10		return $template
364			->render(array(
365	10		'this' => $pageView->createJail(),
366	10		));
367	10		}
368	10
369	10		/**
370			* Get the compiled HTML for a specific ContentItem.
371			*
372			* @param Twig_Template $template
373			* @param PageView $pageView
374			* @param ContentItem $contentItem
375			*
376			* @since 0.1.1
377			*
378			* @return string
379			*/
380			private function renderDynamicPageView(&$template, &$pageView, &$contentItem)
381			{
382			$this->twig->addGlobal('__currentTemplate', $pageView->getFilePath());
383
384			return $template
385	14		->render(array(
386			'this' => $contentItem->createJail(),
387			));
388			}
389	14
390			/**
391			* Get the compiled HTML for a static PageView.
392			*
393			* @param PageView $pageView
394			*
395			* @since 0.1.1
396			*
397			* @throws \Exception
398			* @throws \Throwable
399			* @throws Twig_Error_Syntax
400			*
401			* @return string
402			*/
403			private function renderStaticPageView(&$pageView)
404			{
405			$this->twig->addGlobal('__currentTemplate', $pageView->getFilePath());
406
407			return $this
408			->createTwigTemplate($pageView)
409			->render(array(
410			'this' => $pageView->createJail(),
411			));
412			}
413
414			/**
415			* Create a Twig template that just needs an array to render.
416			*
417			* @param PageView $pageView The PageView whose body will be used for Twig compilation
418			*
419			* @since 0.1.1
420			*
421			* @throws \Exception
422			* @throws \Throwable
423			* @throws Twig_Error_Syntax
424			*
425			* @return Twig_Template
426			*/
427			private function createTwigTemplate(&$pageView)
428			{
429			try
430			{
431			$template = $this->twig->createTemplate($pageView->getContent());
432
433			if (Service::getParameter(BuildableCommand::WATCHING))
434			{
435			$parent = $template->getParent(array());
436
437			while (false !== $parent)
438			{
439			$path = str_replace('@theme', $this->fs->appendPath(ThemeManager::THEME_FOLDER, $this->theme), $parent->getTemplateName());
440			$this->templateDependencies[$path][$pageView->getName()] = &$pageView;
441
442			$parent = $parent->getParent(array());
443			}
444			}
445
446			return $template;
447			}
448			catch (Twig_Error_Syntax $e)
449			{
450			$e->setTemplateLine($e->getTemplateLine() + $pageView->getLineOffset());
451			$e->setSourceContext(new Twig_Source(
452			$pageView->getContent(),
453			$pageView->getName(),
454			$pageView->getRelativeFilePath()
455			));
456
457			throw $e;
458			}
459			}
460			}
461

stakx-io / stakx

Pull Request — master (#46)

Compiler B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

20 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like