CheckmoduleTask - Code Metrics - Inspection of "Rename controller to dispatcher and action to cont..." - horros/agavi2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

by Markus

created 2016-11-28 22:05 UTC

CheckmoduleTask A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	59
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
dl	59
loc	59
rs	10
c	0
b	0
f	0
wmc	7
lcom	1
cbo	5

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setProperty()	4	4	1
A	setPath()	4	4	1
A	setValue()	4	4	1
A	main()	19	19	4

How to fix Duplicated Code

<?php


// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+

require_once(__DIR__ . '/AgaviTask.php');

/**
 * Validates that a given directory is a module directory for a project.
 *
 * @package    agavi
 * @subpackage build
 *
 * @author     Noah Fontes <[email protected]>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      1.0.0
 *
 * @version    $Id$
 */
class CheckmoduleTask extends AgaviTask
namespace YourVendor;

class YourClass { }
{
	protected $property = null;
	protected $path = null;
	protected $value = true;
	
	/**
	 * Sets the property that this task will modify.
	 *
	 * @param      string The property to modify.
	 */
	public function setProperty($property)
	{
		$this->property = $property;
	}
	
	/**
	 * Sets the path to use to validate the module.
	 *
	 * @param      string The path to use.
	 */
	public function setPath(PhingFile $path)
	{
		$this->path = $path;
	}
	
	/**
	 * Sets the value that the property will contain if the module is valid.
	 *
	 * @param      string The value to which the property will be set.
	 */
	public function setValue($value)
	{
		$this->value = $value;
	}

	/**
	 * Executes this target.
	 */
	public function main()
	{
		if($this->property === null) {
			throw new BuildException('The property attribute must be specified');
		}
		if($this->path === null) {
			throw new BuildException('The path attribute must be specified');
		}
		
		$check = new \Agavi\Build\Check\ModuleFilesystemCheck();
		$check->setConfigDirectory($this->project->getProperty('module.config.directory'));
		
		$check->setPath($this->path->getAbsolutePath());
		if($check->check()) {
			$this->project->setUserProperty($this->property, $this->value);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		} else {
			$this->project->setUserProperty($this->property, null);
		}
	}
}

?>


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-11-28 22:11 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 32 and the first side effect is on line 16. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3		// +---------------------------------------------------------------------------+
4		// \| This file is part of the Agavi package. \|
5		// \| Copyright (c) 2005-2011 the Agavi Project. \|
6		// \| \|
7		// \| For the full copyright and license information, please view the LICENSE \|
8		// \| file that was distributed with this source code. You can also view the \|
9		// \| LICENSE file online at http://www.agavi.org/LICENSE.txt \|
10		// \| vi: set noexpandtab: \|
11		// \| Local Variables: \|
12		// \| indent-tabs-mode: t \|
13		// \| End: \|
14		// +---------------------------------------------------------------------------+
15
16		require_once(__DIR__ . '/AgaviTask.php');
17
18		/**
19		* Validates that a given directory is a module directory for a project.
20		*
21		* @package agavi
22		* @subpackage build
23		*
24		* @author Noah Fontes <[email protected]>
25		* @copyright Authors
26		* @copyright The Agavi Project
27		*
28		* @since 1.0.0
29		*
30		* @version $Id$
31		*/
32	View Code Duplication	class CheckmoduleTask extends AgaviTask
		0 ignored issues – show Duplication introduced 2016-11-27 20:51 UTC by Report Bug Copy Issue Report This class 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... Coding Style Compatibility introduced 2016-11-27 20:51 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
33		{
34		protected $property = null;
35		protected $path = null;
36		protected $value = true;
37
38		/**
39		* Sets the property that this task will modify.
40		*
41		* @param string The property to modify.
42		*/
43		public function setProperty($property)
44		{
45		$this->property = $property;
46		}
47
48		/**
49		* Sets the path to use to validate the module.
50		*
51		* @param string The path to use.
52		*/
53		public function setPath(PhingFile $path)
54		{
55		$this->path = $path;
56		}
57
58		/**
59		* Sets the value that the property will contain if the module is valid.
60		*
61		* @param string The value to which the property will be set.
62		*/
63		public function setValue($value)
64		{
65		$this->value = $value;
66		}
67
68		/**
69		* Executes this target.
70		*/
71		public function main()
72		{
73		if($this->property === null) {
74		throw new BuildException('The property attribute must be specified');
75		}
76		if($this->path === null) {
77		throw new BuildException('The path attribute must be specified');
78		}
79
80		$check = new \Agavi\Build\Check\ModuleFilesystemCheck();
81		$check->setConfigDirectory($this->project->getProperty('module.config.directory'));
82
83		$check->setPath($this->path->getAbsolutePath());
84		if($check->check()) {
85		$this->project->setUserProperty($this->property, $this->value);
		0 ignored issues – show Documentation introduced 2016-11-27 20:51 UTC by Report Bug Copy Issue Report `$this->value` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
86		} else {
87		$this->project->setUserProperty($this->property, null);
88		}
89		}
90		}
91
92		?>
		0 ignored issues – show Best Practice introduced 2016-11-28 22:11 UTC by Report Bug Copy Issue Report It is not recommended to use PHP's closing tag `?>` in files other than templates. Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore. A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever. Loading history...

horros / agavi2

Pull Request — master (#7)

CheckmoduleTask A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like