bbcodes - Code Metrics - Inspection of "Update testing for phpBB 3.2 branch" - iMattPro/topicpreview - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ea2170...fb436f )

by Matt

created 2017-01-10 18:54 UTC

bbcodes A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	11
c	0
b	0
f	0
lcom	1
cbo	3
dl	0
loc	91
ccs	28
cts	28
cp	1
rs	10

6 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
A	is_available()	4	1
A	run()	12	2
A	set_data()	10	4
A	process()	9	2
A	s9e_format()	4	1

<?php
/**
 *
 * Topic Preview
 *
 * @copyright (c) 2016 Matt Friedman
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace vse\topicpreview\core\trim\tools;

use phpbb\config\config;
use phpbb\textformatter\s9e\utils;

class bbcodes extends base
{
	/** @var config */
	protected $config;

	/** @var bbcodes_legacy */
	protected $trim_bbcodes_legacy;

	/** @var utils|null */
	protected $text_formatter_utils;

	/** @var array Data array of BBCodes to remove */
	protected $data;

	/**
	 * Constructor
	 *
	 * @param config         $config               Config object
	 * @param bbcodes_legacy $trim_bbcodes_legacy  Legacy BBCodes trim tool
	 * @param utils|null     $text_formatter_utils Text Formatter Utils
	 */
	public function __construct(config $config, bbcodes_legacy $trim_bbcodes_legacy, utils $text_formatter_utils = null)
	{
		$this->config = $config;
		$this->trim_bbcodes_legacy = $trim_bbcodes_legacy;
		$this->text_formatter_utils = $text_formatter_utils;
	}

	/**
	 * @inheritdoc
	 */
	public function is_available()
	{
		return ($this->text_formatter_utils !== null);
	}

	/**
	 * @inheritdoc
	 */
	public function run()
	{
		// If text is not formatted as expected, use legacy bbcode stripper
		if (!$this->s9e_format())
		{
			return $this->trim_bbcodes_legacy
				->set_text($this->text)
				->run();
		}

		return $this->set_data()->process();
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.
    }
}
	}

	/**
	 * @inheritdoc
	 */
	public function set_data()
	{
		if (!isset($this->data) || !is_array($this->data))
		{
			$this->data = (!empty($this->config['topic_preview_strip_bbcodes'])) ? explode('|', $this->config['topic_preview_strip_bbcodes']) : array();
			array_unshift($this->data, 'flash');
		}

		return $this;
	}

	/**
	 * Remove specified BBCodes and their contents
	 *
	 * @return string Stripped message text
	 */
	protected function process()
	{
		foreach ($this->data as $bbcode)
		{
			$this->text = $this->text_formatter_utils->remove_bbcode($this->text, $bbcode);
		}

		return $this->text_formatter_utils->unparse($this->text);
	}

	/**
	 * Is the message s9e formatted
	 *
	 * @return bool True if message is s9e formatted, false otherwise
	 */
	protected function s9e_format()
	{
		return (bool) preg_match('/^<[rt][ >]/s', $this->text);
	}
}


1		<?php
2		/**
3		*
4		* Topic Preview
5		*
6		* @copyright (c) 2016 Matt Friedman
7		* @license GNU General Public License, version 2 (GPL-2.0)
8		*
9		*/
10
11		namespace vse\topicpreview\core\trim\tools;
12
13		use phpbb\config\config;
14		use phpbb\textformatter\s9e\utils;
15
16		class bbcodes extends base
17		{
18		/** @var config */
19		protected $config;
20
21		/** @var bbcodes_legacy */
22		protected $trim_bbcodes_legacy;
23
24		/** @var utils\|null */
25		protected $text_formatter_utils;
26
27		/** @var array Data array of BBCodes to remove */
28		protected $data;
29
30		/**
31		* Constructor
32		*
33		* @param config $config Config object
34		* @param bbcodes_legacy $trim_bbcodes_legacy Legacy BBCodes trim tool
35		* @param utils\|null $text_formatter_utils Text Formatter Utils
36		*/
37	38	public function __construct(config $config, bbcodes_legacy $trim_bbcodes_legacy, utils $text_formatter_utils = null)
38		{
39	38	$this->config = $config;
40	38	$this->trim_bbcodes_legacy = $trim_bbcodes_legacy;
41	38	$this->text_formatter_utils = $text_formatter_utils;
42	38	}
43
44		/**
45		* @inheritdoc
46		*/
47	38	public function is_available()
48		{
49	38	return ($this->text_formatter_utils !== null);
50		}
51
52		/**
53		* @inheritdoc
54		*/
55	12	public function run()
56		{
57		// If text is not formatted as expected, use legacy bbcode stripper
58	12	if (!$this->s9e_format())
59	12	{
60	12	return $this->trim_bbcodes_legacy
61	12	->set_text($this->text)
62	12	->run();
63		}
64
65	12	return $this->set_data()->process();
		0 ignored issues – show Bug introduced 2016-07-24 05:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `vse\topicpreview\core\trim\tools\tool_interface` as the method `process()` does only exist in the following implementations of said interface: `vse\topicpreview\core\trim\tools\bbcodes`, `vse\topicpreview\core\trim\tools\bbcodes_legacy`, `vse\topicpreview\core\trim\tools\markup`. 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...
66		}
67
68		/**
69		* @inheritdoc
70		*/
71	12	public function set_data()
72		{
73	12	if (!isset($this->data) \|\| !is_array($this->data))
74	12	{
75	12	$this->data = (!empty($this->config['topic_preview_strip_bbcodes'])) ? explode('\|', $this->config['topic_preview_strip_bbcodes']) : array();
76	12	array_unshift($this->data, 'flash');
77	12	}
78
79	12	return $this;
80		}
81
82		/**
83		* Remove specified BBCodes and their contents
84		*
85		* @return string Stripped message text
86		*/
87	12	protected function process()
88		{
89	12	foreach ($this->data as $bbcode)
90		{
91	12	$this->text = $this->text_formatter_utils->remove_bbcode($this->text, $bbcode);
92	12	}
93
94	12	return $this->text_formatter_utils->unparse($this->text);
95		}
96
97		/**
98		* Is the message s9e formatted
99		*
100		* @return bool True if message is s9e formatted, false otherwise
101		*/
102	12	protected function s9e_format()
103		{
104	12	return (bool) preg_match('/^<[rt][ >]/s', $this->text);
105		}
106		}
107

iMattPro / topicpreview

Push — master ( ea2170...fb436f )

bbcodes A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like