Shortcode - Code Metrics - Inspection of "Update changelog." - brightnucleus/shortcodes - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 671e42...a49b57 )

by Alain

created 2016-02-18 10:33 UTC

Shortcode A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	143
Duplicated Lines	18.88 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
wmc	9
c	3
b	0
f	0
lcom	1
cbo	4
dl	27
loc	143
ccs	0
cts	31
cp	0
rs	10

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	15	15	1
A	register()	0	6	2
A	is_needed()	12	12	3
A	get_tag()	0	3	1
A	render()	0	17	2

How to fix Duplicated Code

<?php
/**
 * Shortcode Base Implementation.
 *
 * @package   BrightNucleus\Shortcode
 * @author    Alain Schlesser <[email protected]>
 * @license   GPL-2.0+
 * @link      http://www.brightnucleus.com/
 * @copyright 2015-2016 Alain Schlesser, Bright Nucleus
 */

namespace BrightNucleus\Shortcode;

use Assert;
use BrightNucleus\Config\ConfigInterface;
use BrightNucleus\Config\ConfigTrait;
use BrightNucleus\Dependency\DependencyManagerInterface;
use BrightNucleus\Exception\DomainException;
use BrightNucleus\Exception\RuntimeException;

/**
 * Base Implementation of the Shortcode Interface.
 *
 * This is a basic implementation of the Shortcode Interface that registers one
 * view and passes all attributes unfiltered to that view.
 *
 * @since   0.1.0
 *
 * @package BrightNucleus\Shortcode
 * @author  Alain Schlesser <[email protected]>
 */
class Shortcode implements ShortcodeInterface {

	use ConfigTrait;

	/**
	 * Name of the shortcode handler.
	 *
	 * @since 0.1.0
	 *
	 * @var string
	 */
	protected $shortcode_tag;

	/**
	 * Parser to parse and validate the shortcode's attributes.
	 *
	 * @since 0.1.0
	 *
	 * @var ShortcodeAttsParserInterface
	 */
	protected $atts_parser;

	/**
	 * Dependencies of the shortcode.
	 *
	 * @since 0.1.0
	 *
	 * @var DependencyManagerInterface
	 */
	protected $dependencies;

	/**
	 * Instantiate Basic Shortcode.
	 *
	 * @since 0.1.0
	 *
	 * @param string                       $shortcode_tag Tag that identifies
	 *                                                    the shortcode.
	 * @param ConfigInterface              $config        Configuration
	 *                                                    settings.
	 * @param ShortcodeAttsParserInterface $atts_parser   Attributes parser and
	 *                                                    validator.
	 * @param DependencyManagerInterface   $dependencies  Dependencies of the
	 *                                                    shortcode.
	 * @throws RuntimeException If the config could not be processed.
	 */
	public function __construct(

		$shortcode_tag,
		ConfigInterface $config,
		ShortcodeAttsParserInterface $atts_parser,
		DependencyManagerInterface $dependencies
	) {

		Assert\that( $shortcode_tag )->string()->notEmpty();

		$this->processConfig( $config );

		$this->shortcode_tag = $shortcode_tag;
		$this->atts_parser   = $atts_parser;
		$this->dependencies  = $dependencies;
	}

	/**
	 * Register the shortcode handler function with WordPress.
	 *
	 * @since 0.1.0
	 *
	 * @param mixed $args Optional. Arguments to pass on to the Registrable.
	 *                    (Not used with Shortcode class)
	 * @return void
	 */
	public function register( $args = null ) {
		if ( ! $this->is_needed( $args ) ) {
			return;
		}
		\add_shortcode( $this->get_tag(), [ $this, 'render' ] );
	}

	/**
	 * Check whether the shortcode is needed.
	 *
	 * @since 0.2.0
	 *
	 * @param mixed $context Data about the context in which the call is made.
	 * @return boolean Whether the shortcode is needed or not.
	 */
	protected function is_needed( $context = null ) {


		$is_needed = $this->hasConfigKey( 'is_needed' )
			? $this->getConfigKey( 'is_needed' )
			: false;

		if ( is_callable( $is_needed ) ) {
			return $is_needed( $context );
		}

		return (bool) $is_needed;
	}

	/**
	 * Get the shortcode tag.
	 *
	 * @since 0.1.0
	 *
	 * @return string Shortcode tag.
	 */
	public function get_tag() {
		return (string) $this->shortcode_tag;
	}

	/**
	 * Render the shortcode.
	 *
	 * @since 0.1.0
	 *
	 * @throws DomainException
	 *
	 * @param  array       $atts    Attributes to modify the standard behavior
	 *                              of the shortcode.
	 * @param  string|null $content Optional. Content between enclosing
	 *                              shortcodes.
	 * @param string|null  $tag     Optional. The tag of the shortcode to
	 *                              render.
	 * @return string               The shortcode's HTML output.
	 */
	public function render( $atts, $content = null, $tag = null ) {
		$atts = $this->atts_parser->parse_atts( $atts, $this->get_tag() );

		$this->dependencies->enqueue( $atts );

		if ( ! $this->hasConfigKey( 'view' ) ) {
			return '';
		}
		$view = $this->getConfigKey( 'view' );

		Assert\that( $view )->string()->notEmpty()->file();

		ob_start();
		include( $this->config['view'] );

		return ob_get_clean();
	}
}


1		<?php
2		/**
3		* Shortcode Base Implementation.
4		*
5		* @package BrightNucleus\Shortcode
6		* @author Alain Schlesser <[email protected]>
7		* @license GPL-2.0+
8		* @link http://www.brightnucleus.com/
9		* @copyright 2015-2016 Alain Schlesser, Bright Nucleus
10		*/
11
12		namespace BrightNucleus\Shortcode;
13
14		use Assert;
15		use BrightNucleus\Config\ConfigInterface;
16		use BrightNucleus\Config\ConfigTrait;
17		use BrightNucleus\Dependency\DependencyManagerInterface;
18		use BrightNucleus\Exception\DomainException;
19		use BrightNucleus\Exception\RuntimeException;
20
21		/**
22		* Base Implementation of the Shortcode Interface.
23		*
24		* This is a basic implementation of the Shortcode Interface that registers one
25		* view and passes all attributes unfiltered to that view.
26		*
27		* @since 0.1.0
28		*
29		* @package BrightNucleus\Shortcode
30		* @author Alain Schlesser <[email protected]>
31		*/
32		class Shortcode implements ShortcodeInterface {
33
34		use ConfigTrait;
35
36		/**
37		* Name of the shortcode handler.
38		*
39		* @since 0.1.0
40		*
41		* @var string
42		*/
43		protected $shortcode_tag;
44
45		/**
46		* Parser to parse and validate the shortcode's attributes.
47		*
48		* @since 0.1.0
49		*
50		* @var ShortcodeAttsParserInterface
51		*/
52		protected $atts_parser;
53
54		/**
55		* Dependencies of the shortcode.
56		*
57		* @since 0.1.0
58		*
59		* @var DependencyManagerInterface
60		*/
61		protected $dependencies;
62
63		/**
64		* Instantiate Basic Shortcode.
65		*
66		* @since 0.1.0
67		*
68		* @param string $shortcode_tag Tag that identifies
69		* the shortcode.
70		* @param ConfigInterface $config Configuration
71		* settings.
72		* @param ShortcodeAttsParserInterface $atts_parser Attributes parser and
73		* validator.
74		* @param DependencyManagerInterface $dependencies Dependencies of the
75		* shortcode.
76		* @throws RuntimeException If the config could not be processed.
77		*/
78	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2016-02-17 20:01 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...
79		$shortcode_tag,
80		ConfigInterface $config,
81		ShortcodeAttsParserInterface $atts_parser,
82		DependencyManagerInterface $dependencies
83		) {
84
85		Assert\that( $shortcode_tag )->string()->notEmpty();
86
87		$this->processConfig( $config );
88
89		$this->shortcode_tag = $shortcode_tag;
90		$this->atts_parser = $atts_parser;
91		$this->dependencies = $dependencies;
92		}
93
94		/**
95		* Register the shortcode handler function with WordPress.
96		*
97		* @since 0.1.0
98		*
99		* @param mixed $args Optional. Arguments to pass on to the Registrable.
100		* (Not used with Shortcode class)
101		* @return void
102		*/
103		public function register( $args = null ) {
104		if ( ! $this->is_needed( $args ) ) {
105		return;
106		}
107		\add_shortcode( $this->get_tag(), [ $this, 'render' ] );
108		}
109
110		/**
111		* Check whether the shortcode is needed.
112		*
113		* @since 0.2.0
114		*
115		* @param mixed $context Data about the context in which the call is made.
116		* @return boolean Whether the shortcode is needed or not.
117		*/
118	View Code Duplication	protected function is_needed( $context = null ) {
		0 ignored issues – show Duplication introduced 2016-02-18 10:36 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...
119
120		$is_needed = $this->hasConfigKey( 'is_needed' )
121		? $this->getConfigKey( 'is_needed' )
122		: false;
123
124		if ( is_callable( $is_needed ) ) {
125		return $is_needed( $context );
126		}
127
128		return (bool) $is_needed;
129		}
130
131		/**
132		* Get the shortcode tag.
133		*
134		* @since 0.1.0
135		*
136		* @return string Shortcode tag.
137		*/
138		public function get_tag() {
139		return (string) $this->shortcode_tag;
140		}
141
142		/**
143		* Render the shortcode.
144		*
145		* @since 0.1.0
146		*
147		* @throws DomainException
148		*
149		* @param array $atts Attributes to modify the standard behavior
150		* of the shortcode.
151		* @param string\|null $content Optional. Content between enclosing
152		* shortcodes.
153		* @param string\|null $tag Optional. The tag of the shortcode to
154		* render.
155		* @return string The shortcode's HTML output.
156		*/
157		public function render( $atts, $content = null, $tag = null ) {
158		$atts = $this->atts_parser->parse_atts( $atts, $this->get_tag() );
159
160		$this->dependencies->enqueue( $atts );
161
162		if ( ! $this->hasConfigKey( 'view' ) ) {
163		return '';
164		}
165		$view = $this->getConfigKey( 'view' );
166
167		Assert\that( $view )->string()->notEmpty()->file();
168
169		ob_start();
170		include( $this->config['view'] );
171
172		return ob_get_clean();
173		}
174		}
175

brightnucleus / shortcodes

Push — master ( 671e42...a49b57 )

Shortcode A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like