FileLocator - Code Metrics - Inspection of "Daily Inspection: Merge remote-tracking branch 'gi..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-8511-spco-revisit-oversell... (0aad32)

unknown

created 2016-08-09 21:26 UTC

FileLocator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	91
Duplicated Lines	12.09 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

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

5 Methods

Rating	Name	Duplication	Size	Complexity
A	count()	0	3	1
A	getFilePaths()	0	3	1
A	setFileMask()	0	6	2
B	locate()	11	11	5
A	findFilesByPath()	0	9	2

How to fix Duplicated Code

<?php
namespace EventEspresso\core\services\locators;

use  EventEspresso\core\exceptions\InvalidDataTypeException;
use FilesystemIterator;
use GlobIterator;

if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
	exit( 'No direct script access allowed' );
}



/**
 * Class FileLocator
 *
 * finds filepaths from folder paths or FQCNs (Fully Qualified Class Name) from partial FQCNs
 *
 * @package       Event Espresso
 * @author        Brent Christensen
 * @since         4.9.0
 */
class FileLocator extends Locator {

	/**
	 * @var string $file_mask
	 */
	protected $file_mask = '*.php';

	/**
	 * @var array $filepaths
	 */
	protected $filepaths = array();



	/**
	 * @param string $file_mask
	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
	 */
	public function setFileMask( $file_mask ) {
		if ( ! is_string( $file_mask ) ) {
			throw new InvalidDataTypeException( '$file_mask', $file_mask, 'string' );
		}
		$this->file_mask = $file_mask;
	}



	/**
	 * @access public
	 * @return array
	 */
	public function getFilePaths() {
		return $this->filepaths;
	}




	/**
	 * @access public
	 * @return int
	 */
	public function count() {
		return count( $this->filepaths );
	}



	/**
	 * given a path to a valid directory, or an array of valid paths,
	 * will find all files that match the provided mask
	 *
	 * @access public
	 * @param array|string $directory_paths
	 * @return \FilesystemIterator
	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
	 */
	public function locate( $directory_paths ) {

		if ( ! ( is_string( $directory_paths ) || is_array( $directory_paths ) ) ) {
			throw new InvalidDataTypeException( '$directory_paths', $directory_paths, 'string or array' );
		}
		foreach ( (array) $directory_paths as $directory_path ) {
			foreach ( $this->findFilesByPath( $directory_path ) as $key => $file ) {
				$this->filepaths[ $key ] = \EEH_File::standardise_directory_separators( $file );
			}
		}
		return $this->filepaths;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}



	/**
	 * given a path to a valid directory, will find all files that match the provided mask
	 *
	 * @access protected
	 * @param string $directory_path
	 * @return \FilesystemIterator
	 */
	protected function findFilesByPath( $directory_path = '' ) {
		$iterator = new GlobIterator (
			\EEH_File::end_with_directory_separator( $directory_path ) . $this->file_mask
		);
		foreach ( $this->flags as $flag ) {
			$iterator->setFlags( $flag );
		}
		return $iterator;
	}



}
// End of file FileLocator.php
// Location: /FileLocator.php

1		<?php
2		namespace EventEspresso\core\services\locators;
3
4		use EventEspresso\core\exceptions\InvalidDataTypeException;
5		use FilesystemIterator;
6		use GlobIterator;
7
8		if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
9		exit( 'No direct script access allowed' );
10		}
11
12
13
14		/**
15		* Class FileLocator
16		*
17		* finds filepaths from folder paths or FQCNs (Fully Qualified Class Name) from partial FQCNs
18		*
19		* @package Event Espresso
20		* @author Brent Christensen
21		* @since 4.9.0
22		*/
23		class FileLocator extends Locator {
24
25		/**
26		* @var string $file_mask
27		*/
28		protected $file_mask = '*.php';
29
30		/**
31		* @var array $filepaths
32		*/
33		protected $filepaths = array();
34
35
36
37		/**
38		* @param string $file_mask
39		* @throws \EventEspresso\core\exceptions\InvalidDataTypeException
40		*/
41		public function setFileMask( $file_mask ) {
42		if ( ! is_string( $file_mask ) ) {
43		throw new InvalidDataTypeException( '$file_mask', $file_mask, 'string' );
44		}
45		$this->file_mask = $file_mask;
46		}
47
48
49
50		/**
51		* @access public
52		* @return array
53		*/
54		public function getFilePaths() {
55		return $this->filepaths;
56		}
57
58
59
60
61		/**
62		* @access public
63		* @return int
64		*/
65		public function count() {
66		return count( $this->filepaths );
67		}
68
69
70
71		/**
72		* given a path to a valid directory, or an array of valid paths,
73		* will find all files that match the provided mask
74		*
75		* @access public
76		* @param array\|string $directory_paths
77		* @return \FilesystemIterator
78		* @throws \EventEspresso\core\exceptions\InvalidDataTypeException
79		*/
80	View Code Duplication	public function locate( $directory_paths ) {
		0 ignored issues – show Duplication introduced 2016-05-03 21:43 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...
81		if ( ! ( is_string( $directory_paths ) \|\| is_array( $directory_paths ) ) ) {
82		throw new InvalidDataTypeException( '$directory_paths', $directory_paths, 'string or array' );
83		}
84		foreach ( (array) $directory_paths as $directory_path ) {
85		foreach ( $this->findFilesByPath( $directory_path ) as $key => $file ) {
86		$this->filepaths[ $key ] = \EEH_File::standardise_directory_separators( $file );
87		}
88		}
89		return $this->filepaths;
		0 ignored issues – show Bug Best Practice introduced 2016-05-03 21:43 UTC by Report Bug Copy Issue Report The return type of `return $this->filepaths;` (`array`) is incompatible with the return type declared by the interface `EventEspresso\core\servi...ocatorInterface::locate` of type `FilesystemIterator`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
90		}
91
92
93
94		/**
95		* given a path to a valid directory, will find all files that match the provided mask
96		*
97		* @access protected
98		* @param string $directory_path
99		* @return \FilesystemIterator
100		*/
101		protected function findFilesByPath( $directory_path = '' ) {
102		$iterator = new GlobIterator (
103		\EEH_File::end_with_directory_separator( $directory_path ) . $this->file_mask
104		);
105		foreach ( $this->flags as $flag ) {
106		$iterator->setFlags( $flag );
107		}
108		return $iterator;
109		}
110
111
112
113		}
114		// End of file FileLocator.php
115		// Location: /FileLocator.php

eventespresso / event-espresso-core

Branch — BUG-8511-spco-revisit-oversell... (0aad32)

FileLocator A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like