Tidy::update() - Code Metrics - frqnck/apix - Measure and Improve Code Quality continuously with Scrutinizer

Tidy::update() C
last analyzed 2017-05-17 20:31 UTC

↳ Parent: Tidy

Complexity

Conditions	7
Paths	6

Size

Total Lines	36
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
dl	0
loc	36
ccs	0
cts	21
cp	0
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	19
nc	6
nop	1
crap	56

<?php

/**
 *
 * This file is part of the Apix Project.
 *
 * (c) Franck Cassedanne <franck at ouarz.net>
 *
 * @license     http://opensource.org/licenses/BSD-3-Clause  New BSD License
 *
 */

namespace Apix\Plugin;

use Apix\Service;

class Tidy extends PluginAbstract
{

    public static $hook = array('response', 'late');

    /**
     * @var array Options for tidy.
     * @see http://tidy.sourceforge.net/docs/quickref.html
     */
    protected $options = array(
        'enable'    => true,        // wether to enable or not
        'generic'   => array(
            // PHP Bug: commenting out 'indent' (with true or false)
            // for some weird reason does chnage the Transfer-Encoding!
            'indent'        => true,
            'indent-spaces' => 4,
            'wrap'          => 80,
            'clean'         => true
        ),
        'html'      => array(
            'tidy-mark'     => true,
        ),
        'xml'       => array(
            'input-xml'     => true,
            'output-xml'    => true,
        )
    );

    public function update(\SplSubject $response)
    {
        if (false === $this->options['enable']) {
            return false;
        }

        // @codeCoverageIgnoreStart
        if (!extension_loaded('tidy')) {

            $logger = Service::get('logger')
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                        ->debug('Tidy: PHP extension not installed');

            return false;
        }
        // @codeCoverageIgnoreEnd

        $format = $response->getFormat();
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.
    }
}

        switch ($format) {

            case 'lst':
            case 'html':
            case 'xml':
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

                $response->setOutput(
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.
    }
}
                    $this->tidy(
                        $response->getOutput(),
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.
    }
}
                        isset($this->options[$format])
                            ? $this->options[$format]
                            : array()
                    )
                );

            default:
        }
    }

    /**
     * Tidy, sanitize the response output.
     *
     * @param  string $string
     * @param  array  $options
     * @return string
     */
    protected function tidy($string, array $options)

    {
        $tidy = new \tidy();
        $tidy->parseString($string, $options+$this->options['generic']);
        $tidy->cleanRepair();

        return $tidy->value;

    }

}


1			<?php
2
3			/**
4			*
5			* This file is part of the Apix Project.
6			*
7			* (c) Franck Cassedanne <franck at ouarz.net>
8			*
9			* @license http://opensource.org/licenses/BSD-3-Clause New BSD License
10			*
11			*/
12
13			namespace Apix\Plugin;
14
15			use Apix\Service;
16
17			class Tidy extends PluginAbstract
18			{
19
20			public static $hook = array('response', 'late');
21
22			/**
23			* @var array Options for tidy.
24			* @see http://tidy.sourceforge.net/docs/quickref.html
25			*/
26			protected $options = array(
27			'enable' => true, // wether to enable or not
28			'generic' => array(
29			// PHP Bug: commenting out 'indent' (with true or false)
30			// for some weird reason does chnage the Transfer-Encoding!
31			'indent' => true,
32			'indent-spaces' => 4,
33			'wrap' => 80,
34			'clean' => true
35			),
36			'html' => array(
37			'tidy-mark' => true,
38			),
39			'xml' => array(
40			'input-xml' => true,
41			'output-xml' => true,
42			)
43			);
44
45			public function update(\SplSubject $response)
46			{
47			if (false === $this->options['enable']) {
48			return false;
49			}
50
51			// @codeCoverageIgnoreStart
52			if (!extension_loaded('tidy')) {
53
54			$logger = Service::get('logger')
			0 ignored issues – show Unused Code introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report `$logger` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
55			->debug('Tidy: PHP extension not installed');
56
57			return false;
58			}
59			// @codeCoverageIgnoreEnd
60
61			$format = $response->getFormat();
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SplSubject` as the method `getFormat()` does only exist in the following implementations of said interface: `Apix\Response`. 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...
62
63			switch ($format) {
64
65			case 'lst':
66			case 'html':
67			case 'xml':
			0 ignored issues – show Coding Style introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report There must be a comment when fall-through is intentional in a non-empty case body Loading history...
68
69			$response->setOutput(
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SplSubject` as the method `setOutput()` does only exist in the following implementations of said interface: `Apix\Response`. 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...
70			$this->tidy(
71			$response->getOutput(),
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SplSubject` as the method `getOutput()` does only exist in the following implementations of said interface: `Apix\Response`. 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...
72			isset($this->options[$format])
73			? $this->options[$format]
74			: array()
75			)
76			);
77
78			default:
79			}
80			}
81
82			/**
83			* Tidy, sanitize the response output.
84			*
85			* @param string $string
86			* @param array $options
87			* @return string
88			*/
89			protected function tidy($string, array $options)
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report Please use `__construct()` instead of a PHP4-style constructor that is named after the class. Loading history...
90			{
91			$tidy = new \tidy();
92			$tidy->parseString($string, $options+$this->options['generic']);
93			$tidy->cleanRepair();
94
95			return $tidy->value;
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report The property `value` does not seem to exist in `tidy`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
96			}
97
98			}
99

frqnck / apix

Tidy::update() C last analyzed 2017-05-17 20:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

Tidy::update() C
last analyzed 2017-05-17 20:31 UTC