ProcedureCompiler - Code Metrics - Inspection of "Updating readme" - jonnnnyw/php-phantomjs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cf8d9a...01d377 )

by Jonny

created 2016-06-28 16:51 UTC

ProcedureCompiler A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

75%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	10
c	1
b	0
f	0
lcom	2
cbo	5
dl	0
loc	142
ccs	27
cts	36
cp	0.75
rs	10

6 Methods

Rating	Name	Size	Complexity
A	load()	4	1
A	__construct()	9	1
B	compile()	27	5
A	enableCache()	4	1
A	disableCache()	4	1
A	clearCache()	4	1

<?php

/*
 * This file is part of the php-phantomjs.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace JonnyW\PhantomJs\Procedure;

use JonnyW\PhantomJs\Cache\CacheInterface;
use JonnyW\PhantomJs\Template\TemplateRendererInterface;

/**
 * PHP PhantomJs
 *
 * @author Jon Wenmoth <[email protected]>
 */
class ProcedureCompiler implements ProcedureCompilerInterface
{
    /**
     * Procedure loader
     *
     * @var \JonnyW\PhantomJs\Procedure\ProcedureLoaderInterface
     * @access protected
     */
    protected $procedureLoader;

    /**
     * Procedure validator
     *
     * @var \JonnyW\PhantomJs\Procedure\ProcedureValidatorInterface
     * @access protected
     */
    protected $procedureValidator;

    /**
     * Cache handler
     *
     * @var \JonnyW\PhantomJs\Cache\CacheInterface
     * @access protected
     */
    protected $cacheHandler;

    /**
     * Renderer
     *
     * @var \JonnyW\PhantomJs\Template\TemplateRendererInterface
     * @access protected
     */
    protected $renderer;

    /**
     * Cache enabled
     *
     * @var boolean
     * @access protected
     */
    protected $cacheEnabled;

    /**
     * Internal constructor
     *
     * @access public
     * @param \JonnyW\PhantomJs\Procedure\ProcedureLoaderInterface    $procedureLoader
     * @param \JonnyW\PhantomJs\Procedure\ProcedureValidatorInterface $procedureValidator
     * @param \JonnyW\PhantomJs\Cache\CacheInterface                  $cacheHandler
     * @param \JonnyW\PhantomJs\Template\TemplateRendererInterface    $renderer
     */
    public function __construct(ProcedureLoaderInterface $procedureLoader, ProcedureValidatorInterface $procedureValidator,
        CacheInterface $cacheHandler, TemplateRendererInterface $renderer)
    {
        $this->procedureLoader    = $procedureLoader;
        $this->procedureValidator = $procedureValidator;
        $this->cacheHandler       = $cacheHandler;
        $this->renderer           = $renderer;
        $this->cacheEnabled       = true;
    }

    /**
     * Compile partials into procedure.
     *
     * @access public
     * @param  \JonnyW\PhantomJs\Procedure\ProcedureInterface $procedure
     * @param  \JonnyW\PhantomJs\Procedure\InputInterface     $input
     * @return void
     */
    public function compile(ProcedureInterface $procedure, InputInterface $input)
    {
        $cacheKey = sprintf('phantomjs_%s_%s', $input->getType(), md5($procedure->getTemplate()));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}

        if ($this->cacheEnabled && $this->cacheHandler->exists($cacheKey)) {
            $template = $this->cacheHandler->fetch($cacheKey);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        }

        if (empty($template)) {

            $template  = $this->renderer
                ->render($procedure->getTemplate(), array('engine' => $this, 'procedure_type' => $input->getType()));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}

            $test = clone $procedure;
            $test->setTemplate($template);

            $compiled = $test->compile($input);

            $this->procedureValidator->validate($compiled);

            if ($this->cacheEnabled) {
                $this->cacheHandler->save($cacheKey, $template);
            }
        }

        $procedure->setTemplate($template);
    }

    /**
     * Load partial template.
     *
     * @access public
     * @param  string $name
     * @return string
     */
    public function load($name)
    {
        return $this->procedureLoader->loadTemplate($name, 'partial');
    }

    /**
     * Enable cache.
     *
     * @access public
     * @return void
     */
    public function enableCache()
    {
        $this->cacheEnabled = true;
    }

    /**
     * Disable cache.
     *
     * @access public
     * @return void
     */
    public function disableCache()
    {
        $this->cacheEnabled = false;
    }

    /**
     * Clear cache.
     *
     * @access public
     * @return void
     */
    public function clearCache()
    {
        $this->cacheHandler->delete('phantomjs_*');
    }
}


1		<?php
2
3		/*
4		* This file is part of the php-phantomjs.
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*/
9
10		namespace JonnyW\PhantomJs\Procedure;
11
12		use JonnyW\PhantomJs\Cache\CacheInterface;
13		use JonnyW\PhantomJs\Template\TemplateRendererInterface;
14
15		/**
16		* PHP PhantomJs
17		*
18		* @author Jon Wenmoth <[email protected]>
19		*/
20		class ProcedureCompiler implements ProcedureCompilerInterface
21		{
22		/**
23		* Procedure loader
24		*
25		* @var \JonnyW\PhantomJs\Procedure\ProcedureLoaderInterface
26		* @access protected
27		*/
28		protected $procedureLoader;
29
30		/**
31		* Procedure validator
32		*
33		* @var \JonnyW\PhantomJs\Procedure\ProcedureValidatorInterface
34		* @access protected
35		*/
36		protected $procedureValidator;
37
38		/**
39		* Cache handler
40		*
41		* @var \JonnyW\PhantomJs\Cache\CacheInterface
42		* @access protected
43		*/
44		protected $cacheHandler;
45
46		/**
47		* Renderer
48		*
49		* @var \JonnyW\PhantomJs\Template\TemplateRendererInterface
50		* @access protected
51		*/
52		protected $renderer;
53
54		/**
55		* Cache enabled
56		*
57		* @var boolean
58		* @access protected
59		*/
60		protected $cacheEnabled;
61
62		/**
63		* Internal constructor
64		*
65		* @access public
66		* @param \JonnyW\PhantomJs\Procedure\ProcedureLoaderInterface $procedureLoader
67		* @param \JonnyW\PhantomJs\Procedure\ProcedureValidatorInterface $procedureValidator
68		* @param \JonnyW\PhantomJs\Cache\CacheInterface $cacheHandler
69		* @param \JonnyW\PhantomJs\Template\TemplateRendererInterface $renderer
70		*/
71	1	public function __construct(ProcedureLoaderInterface $procedureLoader, ProcedureValidatorInterface $procedureValidator,
72		CacheInterface $cacheHandler, TemplateRendererInterface $renderer)
73		{
74	1	$this->procedureLoader = $procedureLoader;
75	1	$this->procedureValidator = $procedureValidator;
76	1	$this->cacheHandler = $cacheHandler;
77	1	$this->renderer = $renderer;
78	1	$this->cacheEnabled = true;
79	1	}
80
81		/**
82		* Compile partials into procedure.
83		*
84		* @access public
85		* @param \JonnyW\PhantomJs\Procedure\ProcedureInterface $procedure
86		* @param \JonnyW\PhantomJs\Procedure\InputInterface $input
87		* @return void
88		*/
89	27	public function compile(ProcedureInterface $procedure, InputInterface $input)
90		{
91	27	$cacheKey = sprintf('phantomjs_%s_%s', $input->getType(), md5($procedure->getTemplate()));
		0 ignored issues – show Bug introduced 2015-12-17 10:52 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `JonnyW\PhantomJs\Procedure\InputInterface` as the method `getType()` does only exist in the following implementations of said interface: `JonnyW\PhantomJs\Http\AbstractRequest`, `JonnyW\PhantomJs\Http\CaptureRequest`, `JonnyW\PhantomJs\Http\PdfRequest`, `JonnyW\PhantomJs\Http\Request`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
92
93	27	if ($this->cacheEnabled && $this->cacheHandler->exists($cacheKey)) {
94	21	$template = $this->cacheHandler->fetch($cacheKey);
		0 ignored issues – show Bug introduced 2015-12-17 10:52 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$template` is correct as `$this->cacheHandler->fetch($cacheKey)` (which targets `JonnyW\PhantomJs\Cache\CacheInterface::fetch()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
95	21	}
96
97	27	if (empty($template)) {
98
99	6	$template = $this->renderer
100	6	->render($procedure->getTemplate(), array('engine' => $this, 'procedure_type' => $input->getType()));
		0 ignored issues – show Bug introduced 2015-12-17 10:52 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `JonnyW\PhantomJs\Procedure\InputInterface` as the method `getType()` does only exist in the following implementations of said interface: `JonnyW\PhantomJs\Http\AbstractRequest`, `JonnyW\PhantomJs\Http\CaptureRequest`, `JonnyW\PhantomJs\Http\PdfRequest`, `JonnyW\PhantomJs\Http\Request`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
101
102	6	$test = clone $procedure;
103	6	$test->setTemplate($template);
104
105	6	$compiled = $test->compile($input);
106
107	6	$this->procedureValidator->validate($compiled);
108
109	5	if ($this->cacheEnabled) {
110	5	$this->cacheHandler->save($cacheKey, $template);
111	5	}
112	5	}
113
114	26	$procedure->setTemplate($template);
115	26	}
116
117		/**
118		* Load partial template.
119		*
120		* @access public
121		* @param string $name
122		* @return string
123		*/
124	3	public function load($name)
125		{
126	3	return $this->procedureLoader->loadTemplate($name, 'partial');
127		}
128
129		/**
130		* Enable cache.
131		*
132		* @access public
133		* @return void
134		*/
135		public function enableCache()
136		{
137		$this->cacheEnabled = true;
138		}
139
140		/**
141		* Disable cache.
142		*
143		* @access public
144		* @return void
145		*/
146		public function disableCache()
147		{
148		$this->cacheEnabled = false;
149		}
150
151		/**
152		* Clear cache.
153		*
154		* @access public
155		* @return void
156		*/
157		public function clearCache()
158		{
159		$this->cacheHandler->delete('phantomjs_*');
160		}
161		}
162

jonnnnyw / php-phantomjs

GitHub Access Token became invalid

Push — master ( cf8d9a...01d377 )

ProcedureCompiler A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like