ValidRule - Code Metrics - Inspection of "Strict or NonStrict" - phmLabs/Smoke - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#92)

unknown

created 2016-10-07 09:53 UTC

ValidRule A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	77
Duplicated Lines	15.58 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
wmc	12
c	2
b	0
f	1
lcom	1
cbo	3
dl	12
loc	77
rs	10

5 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	4	1
A	getSchema()	0	12	3
A	validateBody()	12	12	2
A	getLocations()	0	17	3
A	doValidation()	0	13	3

How to fix Duplicated Code

<?php

namespace whm\Smoke\Rules\Xml\Sitemap;

use whm\Smoke\Http\Response;
use whm\Smoke\Rules\StandardRule;
use whm\Smoke\Rules\ValidationFailedException;

/**
 * This rule checks if a sitemap.xml file is valid.
 */
class ValidRule extends StandardRule
{
    const SCHEMA = 'schema.xsd';
    const NON_STRICT_SCHEMA = 'nonStrictSchema.xsd';
    const INDEX = 'siteindex.xsd';

    private $strictMode;

    protected $contentTypes = array('text/xml', 'application/xml');

    public function init($strictMode = true)
    {
        $this->strictMode = $strictMode;
    }

    private function getSchema($isIndex)
    {
        if ($isIndex) {
            return __DIR__ . '/' . self::INDEX;
        }

        if ($this->strictMode) {
            return __DIR__ . '/' . self::SCHEMA;
        } else {
            return __DIR__ . '/' . self::NON_STRICT_SCHEMA;
        }
    }

    private function validateBody($body, $filename, $isIndex = TRUE)

    {
        $dom = new \DOMDocument();
        @$dom->loadXML($body);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        $valid = @$dom->schemaValidate($this->getSchema($isIndex));
        if (!$valid) {
            $lastError = libxml_get_last_error();
            throw new ValidationFailedException(
                'The given sitemap file (' . $filename . ') did not validate against the sitemap schema (last error: ' . str_replace("\n", '', $lastError->message) . ').');
        }
    }

    /**
     * @param string
     * @return array
     */
    private function getLocations($body)

    {
        $locations = array();
        $xml = simplexml_load_string($body);
        $json = json_encode($xml);
        $xmlValues = json_decode($json, true);

        if (isset($xmlValues['sitemap']['loc'])) {
            $locations[] = $xmlValues['sitemap']['loc'];
        } else {
            foreach ($xmlValues['sitemap'] as $sitemap) {
                $locations[] = $sitemap['loc'];
            }
        }

        return $locations;
    }

    protected function doValidation(Response $response)
    {
        $body = $response->getBody();

        // sitemapindex or urlset
        if (preg_match('/<sitemapindex/', $body)) {

            $this->validateBody($body, (string)$response->getUri());

        } elseif (preg_match('/<urlset/', $body)) {
            $this->validateBody($body, (string)$response->getUri(), FALSE);
        }
    }
}


1		<?php
2
3		namespace whm\Smoke\Rules\Xml\Sitemap;
4
5		use whm\Smoke\Http\Response;
6		use whm\Smoke\Rules\StandardRule;
7		use whm\Smoke\Rules\ValidationFailedException;
8
9		/**
10		* This rule checks if a sitemap.xml file is valid.
11		*/
12		class ValidRule extends StandardRule
13		{
14		const SCHEMA = 'schema.xsd';
15		const NON_STRICT_SCHEMA = 'nonStrictSchema.xsd';
16		const INDEX = 'siteindex.xsd';
17
18		private $strictMode;
19
20		protected $contentTypes = array('text/xml', 'application/xml');
21
22		public function init($strictMode = true)
23		{
24		$this->strictMode = $strictMode;
25		}
26
27		private function getSchema($isIndex)
28		{
29		if ($isIndex) {
30		return __DIR__ . '/' . self::INDEX;
31		}
32
33		if ($this->strictMode) {
34		return __DIR__ . '/' . self::SCHEMA;
35		} else {
36		return __DIR__ . '/' . self::NON_STRICT_SCHEMA;
37		}
38		}
39
40	View Code Duplication	private function validateBody($body, $filename, $isIndex = TRUE)
		0 ignored issues – show Duplication introduced 2016-10-05 15:15 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...
41		{
42		$dom = new \DOMDocument();
43		@$dom->loadXML($body);
		0 ignored issues – show Security Best Practice introduced 2016-08-04 14:41 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
44
45		$valid = @$dom->schemaValidate($this->getSchema($isIndex));
46		if (!$valid) {
47		$lastError = libxml_get_last_error();
48		throw new ValidationFailedException(
49		'The given sitemap file (' . $filename . ') did not validate against the sitemap schema (last error: ' . str_replace("\n", '', $lastError->message) . ').');
50		}
51		}
52
53		/**
54		* @param string
55		* @return array
56		*/
57		private function getLocations($body)
		0 ignored issues – show Unused Code introduced 2016-10-05 15:15 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
58		{
59		$locations = array();
60		$xml = simplexml_load_string($body);
61		$json = json_encode($xml);
62		$xmlValues = json_decode($json, true);
63
64		if (isset($xmlValues['sitemap']['loc'])) {
65		$locations[] = $xmlValues['sitemap']['loc'];
66		} else {
67		foreach ($xmlValues['sitemap'] as $sitemap) {
68		$locations[] = $sitemap['loc'];
69		}
70		}
71
72		return $locations;
73		}
74
75		protected function doValidation(Response $response)
76		{
77		$body = $response->getBody();
78
79		// sitemapindex or urlset
80		if (preg_match('/<sitemapindex/', $body)) {
81
82		$this->validateBody($body, (string)$response->getUri());
83
84		} elseif (preg_match('/<urlset/', $body)) {
85		$this->validateBody($body, (string)$response->getUri(), FALSE);
86		}
87		}
88		}
89

phmLabs / Smoke

Pull Request — master (#92)

ValidRule A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like