MarkupValidator::initializeMarkupValidator() - Code Metrics - Inspection of "Refactor module" - Kolyunya/codeception-markup-validator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.x (#65)

by Nikolay

created 2017-04-26 23:14 UTC

MarkupValidator::initializeMarkupValidator() A

↳ Parent: MarkupValidator

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	0

<?php

namespace Kolyunya\Codeception\Module;

use Exception;
use ReflectionClass;
use Codeception\Lib\ModuleContainer;
use Codeception\Module;
use Kolyunya\Codeception\Lib\Base\ComponentInterface;
use Kolyunya\Codeception\Lib\MarkupValidator\MarkupProviderInterface;
use Kolyunya\Codeception\Lib\MarkupValidator\MarkupValidatorInterface;
use Kolyunya\Codeception\Lib\MarkupValidator\MessageFilterInterface;
use Kolyunya\Codeception\Lib\MarkupValidator\MessagePrinterInterface;

/**
 * A module which validates page markup via a markup validator.
 */
class MarkupValidator extends Module
{

    const COMPONENT_CLASS_CONFIG_KEY = 'class';

    const COMPONENT_CONFIG_CONFIG_KEY = 'config';

    const PROVIDER_INTERFACE = 'Kolyunya\Codeception\Lib\MarkupValidator\MarkupProviderInterface';
    const PROVIDER_CONFIG_KEY = 'provider';

    const VALIDATOR_INTERFACE = 'Kolyunya\Codeception\Lib\MarkupValidator\MarkupValidatorInterface';
    const VALIDATOR_CONFIG_KEY = 'validator';

    const FILTER_INTERFACE = 'Kolyunya\Codeception\Lib\MarkupValidator\MessageFilterInterface';
    const FILTER_CONFIG_KEY = 'filter';

    const PRINTER_INTERFACE = 'Kolyunya\Codeception\Lib\MarkupValidator\MessagePrinterInterface';
    const PRINTER_CONFIG_KEY = 'printer';

    /**
     * {@inheritDoc}
     */
    protected $config = array(
        self::PROVIDER_CONFIG_KEY => array(
            self::COMPONENT_CLASS_CONFIG_KEY => 'Kolyunya\Codeception\Lib\MarkupValidator\DefaultMarkupProvider',
        ),
        self::VALIDATOR_CONFIG_KEY => array(
            self::COMPONENT_CLASS_CONFIG_KEY => 'Kolyunya\Codeception\Lib\MarkupValidator\W3CMarkupValidator',
        ),
        self::FILTER_CONFIG_KEY => array(
            self::COMPONENT_CLASS_CONFIG_KEY => 'Kolyunya\Codeception\Lib\MarkupValidator\DefaultMessageFilter',
        ),
        self::PRINTER_CONFIG_KEY => array(
            self::COMPONENT_CLASS_CONFIG_KEY => 'Kolyunya\Codeception\Lib\MarkupValidator\DefaultMessagePrinter',
        ),
    );

    /**
     * Markup provider.
     *
     * @var MarkupProviderInterface
     */
    private $markupProvider;

    /**
     * Markup validator.
     *
     * @var MarkupValidatorInterface
     */
    private $markupValidator;

    /**
     * Message filter.
     *
     * @var MessageFilterInterface
     */
    private $messageFilter;

    /**
     * Message printer.
     *
     * @var MessagePrinterInterface
     */
    private $messagePrinter;

    /**
     * {@inheritDoc}
     */
    public function __construct(ModuleContainer $moduleContainer, $config = null)
    {
        parent::__construct($moduleContainer, $config);

        $this->initializeMarkupProvider();
        $this->initializeMarkupValidator();
        $this->initializeMessageFilter();
        $this->initializeMessagePrinter();
    }

    /**
     * Validates page markup via a markup validator.
     * Allows to recongigure message filter component.
     *
     * @param array $messageFilterConfiguration Message filter configuration.
     */
    public function validateMarkup(array $messageFilterConfiguration = array())
    {
        $markup = $this->markupProvider->getMarkup();
        $messages = $this->markupValidator->validate($markup);

        $this->messageFilter->setConfiguration($messageFilterConfiguration);
        $filteredMessages = $this->messageFilter->filterMessages($messages);

        if (empty($filteredMessages) === false) {
            $messagesString = $this->messagePrinter->getMessagesString($filteredMessages);
            $this->fail($messagesString);
        }

        // Validation succeeded.
        $this->assertTrue(true);
    }

    /**
     * Initializes markup provider.
     */
    private function initializeMarkupProvider()
    {
        $this->markupProvider = $this->instantiateComponent(
            self::PROVIDER_CONFIG_KEY,
            self::PROVIDER_INTERFACE,
            array(
                $this->moduleContainer,
            )
        );
    }

    /**
     * Initializes markup validator.
     */
    private function initializeMarkupValidator()
    {
        $this->markupValidator = $this->instantiateComponent(
            self::VALIDATOR_CONFIG_KEY,
            self::VALIDATOR_INTERFACE
        );
    }

    /**
     * Initializes message filter.
     */
    private function initializeMessageFilter()
    {
        $this->messageFilter = $this->instantiateComponent(
            self::FILTER_CONFIG_KEY,
            self::FILTER_INTERFACE
        );
    }

    /**
     * Initializes message printer.
     */
    private function initializeMessagePrinter()
    {
        $this->messagePrinter = $this->instantiateComponent(

            self::PRINTER_CONFIG_KEY,
            self::PRINTER_INTERFACE
        );
    }

    /**
     * Instantiates and returns a module component.
     *
     * @param string $componentName Component name.
     * @param string $interface An interface component must implement.
     * @param array $arguments Component's constructor arguments.
     *
     * @throws Exception When component does not implement expected interface.
     *
     * @return ComponentInterface Instance of a module component.
     */
    private function instantiateComponent($componentName, $interface, array $arguments = array())
    {
        $componentClass = $this->getComponentClass($componentName);
        $componentReflectionClass = new ReflectionClass($componentClass);
        if ($componentReflectionClass->implementsInterface($interface) === false) {
            $errorMessageTemplate = 'Invalid class «%s» provided for component «%s». It must implement «%s».';
            $errorMessage = sprintf($errorMessageTemplate, $componentClass, $componentName, $interface);
            throw new Exception($errorMessage);
        }

        /* @var $component ComponentInterface */
        $component = $componentReflectionClass->newInstanceArgs($arguments);
        $componentConfiguration = $this->getComponentConfiguration($componentName);
        $component->setConfiguration($componentConfiguration);

        return $component;
    }

    /**
     * Returns component class name.
     *
     * @param string $componentName Component name.
     *
     * @return string Component class name.
     */
    private function getComponentClass($componentName)

    {
        $componentClassKey = self::COMPONENT_CLASS_CONFIG_KEY;
        if (isset($this->config[$componentName][$componentClassKey]) === false ||
            is_string($this->config[$componentName][$componentClassKey]) === false
        ) {
            $errorMessage = sprintf('Invalid class configuration of component «%s».', $componentName);
            throw new Exception($errorMessage);
        }

        $componentClass = $this->config[$componentName][$componentClassKey];

        return $componentClass;
    }

    /**
     * Returns component configuration parameters.
     *
     * @param string $componentName Component name.
     *
     * @return array Component configuration parameters.
     */
    private function getComponentConfiguration($componentName)

    {
        $componentConfig = array();

        $componentConfigKey = self::COMPONENT_CONFIG_CONFIG_KEY;
        if (isset($this->config[$componentName][$componentConfigKey]) === true) {
            if (is_array($this->config[$componentName][$componentConfigKey]) === true) {
                $componentConfig = $this->config[$componentName][$componentConfigKey];
            } else {
                $errorMessage = sprintf('Invalid configuration of component «%s».', $componentName);
                throw new Exception($errorMessage);
            }
        }

        return $componentConfig;
    }
}


1		<?php
2
3		namespace Kolyunya\Codeception\Module;
4
5		use Exception;
6		use ReflectionClass;
7		use Codeception\Lib\ModuleContainer;
8		use Codeception\Module;
9		use Kolyunya\Codeception\Lib\Base\ComponentInterface;
10		use Kolyunya\Codeception\Lib\MarkupValidator\MarkupProviderInterface;
11		use Kolyunya\Codeception\Lib\MarkupValidator\MarkupValidatorInterface;
12		use Kolyunya\Codeception\Lib\MarkupValidator\MessageFilterInterface;
13		use Kolyunya\Codeception\Lib\MarkupValidator\MessagePrinterInterface;
14
15		/**
16		* A module which validates page markup via a markup validator.
17		*/
18		class MarkupValidator extends Module
19		{
20
21		const COMPONENT_CLASS_CONFIG_KEY = 'class';
22
23		const COMPONENT_CONFIG_CONFIG_KEY = 'config';
24
25		const PROVIDER_INTERFACE = 'Kolyunya\Codeception\Lib\MarkupValidator\MarkupProviderInterface';
26		const PROVIDER_CONFIG_KEY = 'provider';
27
28		const VALIDATOR_INTERFACE = 'Kolyunya\Codeception\Lib\MarkupValidator\MarkupValidatorInterface';
29		const VALIDATOR_CONFIG_KEY = 'validator';
30
31		const FILTER_INTERFACE = 'Kolyunya\Codeception\Lib\MarkupValidator\MessageFilterInterface';
32		const FILTER_CONFIG_KEY = 'filter';
33
34		const PRINTER_INTERFACE = 'Kolyunya\Codeception\Lib\MarkupValidator\MessagePrinterInterface';
35		const PRINTER_CONFIG_KEY = 'printer';
36
37		/**
38		* {@inheritDoc}
39		*/
40		protected $config = array(
41		self::PROVIDER_CONFIG_KEY => array(
42		self::COMPONENT_CLASS_CONFIG_KEY => 'Kolyunya\Codeception\Lib\MarkupValidator\DefaultMarkupProvider',
43		),
44		self::VALIDATOR_CONFIG_KEY => array(
45		self::COMPONENT_CLASS_CONFIG_KEY => 'Kolyunya\Codeception\Lib\MarkupValidator\W3CMarkupValidator',
46		),
47		self::FILTER_CONFIG_KEY => array(
48		self::COMPONENT_CLASS_CONFIG_KEY => 'Kolyunya\Codeception\Lib\MarkupValidator\DefaultMessageFilter',
49		),
50		self::PRINTER_CONFIG_KEY => array(
51		self::COMPONENT_CLASS_CONFIG_KEY => 'Kolyunya\Codeception\Lib\MarkupValidator\DefaultMessagePrinter',
52		),
53		);
54
55		/**
56		* Markup provider.
57		*
58		* @var MarkupProviderInterface
59		*/
60		private $markupProvider;
61
62		/**
63		* Markup validator.
64		*
65		* @var MarkupValidatorInterface
66		*/
67		private $markupValidator;
68
69		/**
70		* Message filter.
71		*
72		* @var MessageFilterInterface
73		*/
74		private $messageFilter;
75
76		/**
77		* Message printer.
78		*
79		* @var MessagePrinterInterface
80		*/
81		private $messagePrinter;
82
83		/**
84		* {@inheritDoc}
85		*/
86		public function __construct(ModuleContainer $moduleContainer, $config = null)
87		{
88		parent::__construct($moduleContainer, $config);
89
90		$this->initializeMarkupProvider();
91		$this->initializeMarkupValidator();
92		$this->initializeMessageFilter();
93		$this->initializeMessagePrinter();
94		}
95
96		/**
97		* Validates page markup via a markup validator.
98		* Allows to recongigure message filter component.
99		*
100		* @param array $messageFilterConfiguration Message filter configuration.
101		*/
102		public function validateMarkup(array $messageFilterConfiguration = array())
103		{
104		$markup = $this->markupProvider->getMarkup();
105		$messages = $this->markupValidator->validate($markup);
106
107		$this->messageFilter->setConfiguration($messageFilterConfiguration);
108		$filteredMessages = $this->messageFilter->filterMessages($messages);
109
110		if (empty($filteredMessages) === false) {
111		$messagesString = $this->messagePrinter->getMessagesString($filteredMessages);
112		$this->fail($messagesString);
113		}
114
115		// Validation succeeded.
116		$this->assertTrue(true);
117		}
118
119		/**
120		* Initializes markup provider.
121		*/
122		private function initializeMarkupProvider()
123		{
124		$this->markupProvider = $this->instantiateComponent(
125		self::PROVIDER_CONFIG_KEY,
126		self::PROVIDER_INTERFACE,
127		array(
128		$this->moduleContainer,
129		)
130		);
131		}
132
133		/**
134		* Initializes markup validator.
135		*/
136		private function initializeMarkupValidator()
137		{
138		$this->markupValidator = $this->instantiateComponent(
139		self::VALIDATOR_CONFIG_KEY,
140		self::VALIDATOR_INTERFACE
141		);
142		}
143
144		/**
145		* Initializes message filter.
146		*/
147		private function initializeMessageFilter()
148		{
149		$this->messageFilter = $this->instantiateComponent(
150		self::FILTER_CONFIG_KEY,
151		self::FILTER_INTERFACE
152		);
153		}
154
155		/**
156		* Initializes message printer.
157		*/
158		private function initializeMessagePrinter()
159		{
160		$this->messagePrinter = $this->instantiateComponent(
		0 ignored issues – show Documentation Bug introduced 2017-04-26 23:07 UTC by Report Bug Copy Issue Report It seems like `$this->instantiateCompon...elf::PRINTER_INTERFACE)` of type `object<Kolyunya\Codecept...ase\ComponentInterface>` is incompatible with the declared type `object<Kolyunya\Codecept...essagePrinterInterface>` of property `$messagePrinter`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
161		self::PRINTER_CONFIG_KEY,
162		self::PRINTER_INTERFACE
163		);
164		}
165
166		/**
167		* Instantiates and returns a module component.
168		*
169		* @param string $componentName Component name.
170		* @param string $interface An interface component must implement.
171		* @param array $arguments Component's constructor arguments.
172		*
173		* @throws Exception When component does not implement expected interface.
174		*
175		* @return ComponentInterface Instance of a module component.
176		*/
177		private function instantiateComponent($componentName, $interface, array $arguments = array())
178		{
179		$componentClass = $this->getComponentClass($componentName);
180		$componentReflectionClass = new ReflectionClass($componentClass);
181		if ($componentReflectionClass->implementsInterface($interface) === false) {
182		$errorMessageTemplate = 'Invalid class «%s» provided for component «%s». It must implement «%s».';
183		$errorMessage = sprintf($errorMessageTemplate, $componentClass, $componentName, $interface);
184		throw new Exception($errorMessage);
185		}
186
187		/* @var $component ComponentInterface */
188		$component = $componentReflectionClass->newInstanceArgs($arguments);
189		$componentConfiguration = $this->getComponentConfiguration($componentName);
190		$component->setConfiguration($componentConfiguration);
191
192		return $component;
193		}
194
195		/**
196		* Returns component class name.
197		*
198		* @param string $componentName Component name.
199		*
200		* @return string Component class name.
201		*/
202	View Code Duplication	private function getComponentClass($componentName)
		0 ignored issues – show Duplication introduced 2017-04-24 14:04 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...
203		{
204		$componentClassKey = self::COMPONENT_CLASS_CONFIG_KEY;
205		if (isset($this->config[$componentName][$componentClassKey]) === false \|\|
206		is_string($this->config[$componentName][$componentClassKey]) === false
207		) {
208		$errorMessage = sprintf('Invalid class configuration of component «%s».', $componentName);
209		throw new Exception($errorMessage);
210		}
211
212		$componentClass = $this->config[$componentName][$componentClassKey];
213
214		return $componentClass;
215		}
216
217		/**
218		* Returns component configuration parameters.
219		*
220		* @param string $componentName Component name.
221		*
222		* @return array Component configuration parameters.
223		*/
224	View Code Duplication	private function getComponentConfiguration($componentName)
		0 ignored issues – show Duplication introduced 2017-04-24 14:04 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...
225		{
226		$componentConfig = array();
227
228		$componentConfigKey = self::COMPONENT_CONFIG_CONFIG_KEY;
229		if (isset($this->config[$componentName][$componentConfigKey]) === true) {
230		if (is_array($this->config[$componentName][$componentConfigKey]) === true) {
231		$componentConfig = $this->config[$componentName][$componentConfigKey];
232		} else {
233		$errorMessage = sprintf('Invalid configuration of component «%s».', $componentName);
234		throw new Exception($errorMessage);
235		}
236		}
237
238		return $componentConfig;
239		}
240		}
241

Kolyunya / codeception-markup-validator

GitHub Access Token became invalid

Pull Request — 2.x (#65)

MarkupValidator::initializeMarkupValidator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like