Indexer::on_enter_entity() - Code Metrics - Inspection of "backlog maintenance." - lechimp-p/dicto.php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9971b9...3d6cb8 )

by Richard

created 2016-09-03 19:38 UTC

Indexer::on_enter_entity() A

↳ Parent: Indexer::index_content()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	3
nc	1
nop	2
crap	1

<?php
/******************************************************************************
 * An implementation of dicto (scg.unibe.ch/dicto) in and for PHP.
 *
 * Copyright (c) 2016, 2015 Richard Klees <[email protected]>
 *
 * This software is licensed under The MIT License. You should have received
 * a copy of the license along with the code.
 */

namespace Lechimp\Dicto\Indexer;

use Lechimp\Dicto\Variables\Variable;
use PhpParser\Node as N;
use Psr\Log\LoggerInterface as Log;
use League\Flysystem\Adapter\Local;
use League\Flysystem\Filesystem;
use Lechimp\Flightcontrol\Flightcontrol;
use Lechimp\Flightcontrol\File;
use Lechimp\Flightcontrol\FSObject;

/**
 * Creates an index of source files.
 */
class Indexer implements Location, ListenerRegistry, \PhpParser\NodeVisitor {
    /**
     * @var Log
     */
    protected $log;

    /**
     * @var Insert
     */
    protected $insert;

    /**
     * @var \PhpParser\Parser
     */
    protected $parser;

    /**
     * @var array   string => array()
     */
    protected $listeners_enter_definition;

    /**
     * @var array   string => array()
     */
    protected $listeners_leave_definition;

    /**
     * @var array   string => array()
     */
    protected $listeners_enter_misc;

    /**
     * @var array   string => array()
     */
    protected $listeners_leave_misc;

    // state for parsing a file

    /**
     * @var string|null
     */
    protected $file_path = null;

    /**
     * @var string|null
     */
    protected $file_content = null;

    /**
     * This contains the stack of ids were currently in, i.e. the nesting of
     * known code blocks we are in.
     *
     * @var array|null  contain ($definition_type, $definition_id)
     */
    protected $definition_stack = null;

    public function __construct(Log $log, \PhpParser\Parser $parser, Insert $insert) {
        $this->log = $log;
        $this->parser = $parser;
        $this->insert = $insert;
        $this->listeners_enter_definition = array
            ( 0 => array()
            );
        $this->listeners_leave_definition = array
            ( 0 => array()
            );
        $this->listeners_enter_misc = array
            ( 0 => array()
            );
        $this->listeners_leave_misc = array
            ( 0 => array()
            );
    }

    /**
     * Index a directory.
     *
     * @param   string  $path
     * @param   array   $ignore_paths
     * @return  null
     */
    public function index_directory($path, array $ignore_paths) {
        $fc = $this->init_flightcontrol($path);
        $fc->directory("/")
            ->recurseOn()
            ->filter(function(FSObject $obj) use (&$ignore_paths) {
                foreach ($ignore_paths as $pattern) {
                    if (preg_match("%$pattern%", $obj->path()) !== 0) {
                        return false;
                    }
                }
                return true;
            })
            ->foldFiles(null, function($_, File $file) use ($path) {
                try {
                    $this->index_file($path, $file->path());
                }
                catch (\PhpParser\Error $e) {
                    $this->log->error("in ".$file->path().": ".$e->getMessage());
                }
            });

    }

    /**
     * Initialize the filesystem abstraction.
     *
     * @return  Flightcontrol
     */
    public function init_flightcontrol($path) {
        $adapter = new Local($path, LOCK_EX, Local::SKIP_LINKS);
        $flysystem = new Filesystem($adapter);
        return new Flightcontrol($flysystem);
    }

    /**
     * @param   string  $base_dir
     * @param   string  $path
     * @return  null
     */
    public function index_file($base_dir, $path) {
        assert('is_string($base_dir)');
        assert('is_string($path)');
        $this->log->info("indexing: ".$path);
        $full_path = "$base_dir/$path";
        $content = file_get_contents($full_path);
        if ($content === false) {
            throw \InvalidArgumentException("Can't read file $path.");
        }
        $this->index_content($path, $content);
    }

    /**
     * @param   string  $path
     * @param   string  $content
     * @return  null
     */
    public function index_content($path, $content) {
        assert('is_string($path)');
        assert('is_string($content)');

        $stmts = $this->parser->parse($content);
        if ($stmts === null) {
            throw new \RuntimeException("Can't parse file $path.");
        }

        $traverser = new \PhpParser\NodeTraverser;
        $traverser->addVisitor($this);

        $this->definition_stack = array();
        $this->file_path = $path;
        $this->file_content = $content;
        $traverser->traverse($stmts);
    }

   // from ListenerRegistry 

    /**
     * @inheritdoc
     */
    public function on_enter_definition($types, \Closure $listener) {
        $this->on_enter_or_leave_something("listeners_enter_definition", $types, $listener);
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function on_leave_definition($types, \Closure $listener) {
        $this->on_enter_or_leave_something("listeners_leave_definition", $types, $listener);
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function on_enter_misc($classes, \Closure $listener) {
        $this->on_enter_or_leave_something("listeners_enter_misc", $classes, $listener);
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function on_leave_misc($classes, \Closure $listener) {
        $this->on_enter_or_leave_something("listeners_leave_misc", $classes, $listener);
        return $this;
    }

    // generalizes over over on_enter/leave_xx

    /**
     * @param   string      $what
     * @param   array|null  $things
     */
    protected function on_enter_or_leave_something($what, $things, \Closure $listener) {
        $loc = &$this->$what;
        if ($things === null) {
            $loc[0][] = $listener;
        }
        else {
            foreach ($things as $thing) {
                assert('is_string($thing)');
                if (!array_key_exists($thing, $loc)) {
                    $loc[$thing] = array();
                }
                $loc[$thing][] = $listener;
            }
        }
    }

    // generalizes over calls to misc listeners

    /**
     * @param   string          $which
     * @param   \PhpParser\Node $node
     */
    protected function call_misc_listener($which, \PhpParser\Node $node) {

        $listeners = &$this->$which;
        foreach ($listeners[0] as $listener) {
            $listener($this->insert, $this, $node);
        }
        $cls = get_class($node);
        if (array_key_exists($cls, $listeners)) {
            foreach ($listeners[$cls] as $listener) {
                $listener($this->insert, $this, $node);
            }
        }
    }

    /**
     * @param   string                  $which
     * @param   string                  $type
     * @param   int                     $type
     * @param   \PhpParser\Node|null    $node
     */
    protected function call_definition_listener($which, $type, $id, \PhpParser\Node $node = null) {

        $listeners = &$this->$which;
        foreach ($listeners[0] as $listener) {
            $listener($this->insert, $this, $type, $id, $node);
        }
        if (array_key_exists($type, $listeners)) {
            foreach ($listeners[$type] as $listener) {
                $listener($this->insert, $this, $type, $id, $node);
            }
        }
    }

   // from Location

    /**
     * @inheritdoc
     */
    public function file_path() {
        return $this->file_path;
    }

    /**
     * @inheritdoc
     */
    public function in_entities() {
        return $this->definition_stack;
    }

    // from \PhpParser\NodeVisitor

    /**
     * @inheritdoc
     */
    public function beforeTraverse(array $nodes) {
        $id = $this->insert->source($this->file_path, $this->file_content);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        return null;
    }

    /**
     * @inheritdoc
     */
    public function afterTraverse(array $nodes) {
        list($type, $id) = array_pop($this->definition_stack);
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

        return null;
    }

    /**
     * @inheritdoc
     */
    public function enterNode(\PhpParser\Node $node) {
        $start_line = $node->getAttribute("startLine");
        $end_line = $node->getAttribute("endLine");

        if ($this->is_definition($node)) {
            $type = $this->get_type_of($node);
            $id = $this->insert->definition
                ( $node->name
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                , $type
                , $this->file_path
                , $start_line
                , $end_line
                );
            $this->call_definition_listener("listeners_enter_definition",  $type, $id, $node);
            $this->definition_stack[] = array($type, $id);
        }
        else {
            $this->call_misc_listener("listeners_enter_misc", $node);
        }
    }

    protected function get_type_of(\PhpParser\Node $node) {
        // Class
        if ($node instanceof N\Stmt\Class_) {
            return Variable::CLASS_TYPE;
        }
        // Method or Function
        elseif ($node instanceof N\Stmt\ClassMethod) {
            return Variable::METHOD_TYPE;
        }
        elseif ($node instanceof N\Stmt\Function_) {
            return Variable::FUNCTION_TYPE;
        }
        throw \InvalidArgumentException("'".get_class($node)."' has no type.");
    }

    protected function is_definition(\PhpParser\Node $node) {
        return     $node instanceof N\Stmt\Class_
                || $node instanceof N\Stmt\ClassMethod
                || $node instanceof N\Stmt\Function_;
    }

    /**
     * @inheritdoc
     */
    public function leaveNode(\PhpParser\Node $node) {
        // Class

/*        if($this->is_definition($node)) {
            list($type, $id) = array_pop($this->definition_stack);
            $this->call_definition_listener("listeners_leave_definition", $type, $id, $node);
        }
        else {
            $this->call_misc_listener("listeners_leave_misc", $node);
        }*/
    }
}


1			<?php
2			/******************************************************************************
3			* An implementation of dicto (scg.unibe.ch/dicto) in and for PHP.
4			*
5			* Copyright (c) 2016, 2015 Richard Klees <[email protected]>
6			*
7			* This software is licensed under The MIT License. You should have received
8			* a copy of the license along with the code.
9			*/
10
11			namespace Lechimp\Dicto\Indexer;
12
13			use Lechimp\Dicto\Variables\Variable;
14			use PhpParser\Node as N;
15			use Psr\Log\LoggerInterface as Log;
16			use League\Flysystem\Adapter\Local;
17			use League\Flysystem\Filesystem;
18			use Lechimp\Flightcontrol\Flightcontrol;
19			use Lechimp\Flightcontrol\File;
20			use Lechimp\Flightcontrol\FSObject;
21
22			/**
23			* Creates an index of source files.
24			*/
25			class Indexer implements Location, ListenerRegistry, \PhpParser\NodeVisitor {
26			/**
27			* @var Log
28			*/
29			protected $log;
30
31			/**
32			* @var Insert
33			*/
34			protected $insert;
35
36			/**
37			* @var \PhpParser\Parser
38			*/
39			protected $parser;
40
41			/**
42			* @var array string => array()
43			*/
44			protected $listeners_enter_definition;
45
46			/**
47			* @var array string => array()
48			*/
49			protected $listeners_leave_definition;
50
51			/**
52			* @var array string => array()
53			*/
54			protected $listeners_enter_misc;
55
56			/**
57			* @var array string => array()
58			*/
59			protected $listeners_leave_misc;
60
61			// state for parsing a file
62
63			/**
64			* @var string\|null
65			*/
66			protected $file_path = null;
67
68			/**
69			* @var string\|null
70			*/
71			protected $file_content = null;
72
73			/**
74			* This contains the stack of ids were currently in, i.e. the nesting of
75			* known code blocks we are in.
76			*
77			* @var array\|null contain ($definition_type, $definition_id)
78			*/
79			protected $definition_stack = null;
80
81	10		public function __construct(Log $log, \PhpParser\Parser $parser, Insert $insert) {
82	10		$this->log = $log;
83	10		$this->parser = $parser;
84	10		$this->insert = $insert;
85	10		$this->listeners_enter_definition = array
86	10		( 0 => array()
87	10		);
88	10		$this->listeners_leave_definition = array
89	10		( 0 => array()
90	10		);
91	10		$this->listeners_enter_misc = array
92	10		( 0 => array()
93	10		);
94	10		$this->listeners_leave_misc = array
95	10		( 0 => array()
96	10		);
97	10		}
98
99			/**
100			* Index a directory.
101			*
102			* @param string $path
103			* @param array $ignore_paths
104			* @return null
105			*/
106	3		public function index_directory($path, array $ignore_paths) {
107	3		$fc = $this->init_flightcontrol($path);
108	3		$fc->directory("/")
109	3		->recurseOn()
110			->filter(function(FSObject $obj) use (&$ignore_paths) {
111	3		foreach ($ignore_paths as $pattern) {
112	3		if (preg_match("%$pattern%", $obj->path()) !== 0) {
113	3		return false;
114			}
115	3		}
116	3		return true;
117	3		})
118	3		->foldFiles(null, function($_, File $file) use ($path) {
119			try {
120	3		$this->index_file($path, $file->path());
121			}
122	3		catch (\PhpParser\Error $e) {
123			$this->log->error("in ".$file->path().": ".$e->getMessage());
124			}
125	3		});
126
127	3		}
128
129			/**
130			* Initialize the filesystem abstraction.
131			*
132			* @return Flightcontrol
133			*/
134	3		public function init_flightcontrol($path) {
135	3		$adapter = new Local($path, LOCK_EX, Local::SKIP_LINKS);
136	3		$flysystem = new Filesystem($adapter);
137	3		return new Flightcontrol($flysystem);
138			}
139
140			/**
141			* @param string $base_dir
142			* @param string $path
143			* @return null
144			*/
145			public function index_file($base_dir, $path) {
146			assert('is_string($base_dir)');
147			assert('is_string($path)');
148			$this->log->info("indexing: ".$path);
149			$full_path = "$base_dir/$path";
150			$content = file_get_contents($full_path);
151			if ($content === false) {
152			throw \InvalidArgumentException("Can't read file $path.");
153			}
154			$this->index_content($path, $content);
155			}
156
157			/**
158			* @param string $path
159			* @param string $content
160			* @return null
161			*/
162	10		public function index_content($path, $content) {
163	10		assert('is_string($path)');
164	10		assert('is_string($content)');
165
166	10		$stmts = $this->parser->parse($content);
167	10		if ($stmts === null) {
168			throw new \RuntimeException("Can't parse file $path.");
169			}
170
171	10		$traverser = new \PhpParser\NodeTraverser;
172	10		$traverser->addVisitor($this);
173
174	10		$this->definition_stack = array();
175	10		$this->file_path = $path;
176	10		$this->file_content = $content;
177	10		$traverser->traverse($stmts);
178	10		}
179
180			// from ListenerRegistry
181
182			/**
183			* @inheritdoc
184			*/
185			public function on_enter_definition($types, \Closure $listener) {
186			$this->on_enter_or_leave_something("listeners_enter_definition", $types, $listener);
187			return $this;
188			}
189
190			/**
191			* @inheritdoc
192			*/
193			public function on_leave_definition($types, \Closure $listener) {
194			$this->on_enter_or_leave_something("listeners_leave_definition", $types, $listener);
195			return $this;
196			}
197
198			/**
199			* @inheritdoc
200			*/
201	10		public function on_enter_misc($classes, \Closure $listener) {
202	10		$this->on_enter_or_leave_something("listeners_enter_misc", $classes, $listener);
203	10		return $this;
204			}
205
206			/**
207			* @inheritdoc
208			*/
209			public function on_leave_misc($classes, \Closure $listener) {
210			$this->on_enter_or_leave_something("listeners_leave_misc", $classes, $listener);
211			return $this;
212			}
213
214			// generalizes over over on_enter/leave_xx
215
216			/**
217			* @param string $what
218			* @param array\|null $things
219			*/
220	10		protected function on_enter_or_leave_something($what, $things, \Closure $listener) {
221	10		$loc = &$this->$what;
222	10		if ($things === null) {
223			$loc[0][] = $listener;
224			}
225			else {
226	10		foreach ($things as $thing) {
227	10		assert('is_string($thing)');
228	10		if (!array_key_exists($thing, $loc)) {
229	10		$loc[$thing] = array();
230	10		}
231	10		$loc[$thing][] = $listener;
232	10		}
233			}
234	10		}
235
236			// generalizes over calls to misc listeners
237
238			/**
239			* @param string $which
240			* @param \PhpParser\Node $node
241			*/
242	7	View Code Duplication	protected function call_misc_listener($which, \PhpParser\Node $node) {
			0 ignored issues – show Duplication introduced 2016-05-28 18:08 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...
243	7		$listeners = &$this->$which;
244	7		foreach ($listeners[0] as $listener) {
245			$listener($this->insert, $this, $node);
246	7		}
247	7		$cls = get_class($node);
248	7		if (array_key_exists($cls, $listeners)) {
249	6		foreach ($listeners[$cls] as $listener) {
250	6		$listener($this->insert, $this, $node);
251	6		}
252	6		}
253	7		}
254
255			/**
256			* @param string $which
257			* @param string $type
258			* @param int $type
259			* @param \PhpParser\Node\|null $node
260			*/
261	9	View Code Duplication	protected function call_definition_listener($which, $type, $id, \PhpParser\Node $node = null) {
			0 ignored issues – show Duplication introduced 2016-05-28 18:08 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...
262	9		$listeners = &$this->$which;
263	9		foreach ($listeners[0] as $listener) {
264			$listener($this->insert, $this, $type, $id, $node);
265	9		}
266	9		if (array_key_exists($type, $listeners)) {
267			foreach ($listeners[$type] as $listener) {
268			$listener($this->insert, $this, $type, $id, $node);
269			}
270			}
271	9		}
272
273			// from Location
274
275			/**
276			* @inheritdoc
277			*/
278	6		public function file_path() {
279	6		return $this->file_path;
280			}
281
282			/**
283			* @inheritdoc
284			*/
285	6		public function in_entities() {
286	6		return $this->definition_stack;
287			}
288
289			// from \PhpParser\NodeVisitor
290
291			/**
292			* @inheritdoc
293			*/
294	10		public function beforeTraverse(array $nodes) {
295	10		$id = $this->insert->source($this->file_path, $this->file_content);
			0 ignored issues – show Unused Code introduced 2016-09-03 19:44 UTC by Report Bug Copy Issue Report `$id` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
296
297	10		return null;
298			}
299
300			/**
301			* @inheritdoc
302			*/
303	10		public function afterTraverse(array $nodes) {
304	10		list($type, $id) = array_pop($this->definition_stack);
			0 ignored issues – show Unused Code introduced 2016-09-03 19:44 UTC by Report Bug Copy Issue Report The assignment to `$type` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history... Unused Code introduced 2016-09-03 19:44 UTC by Report Bug Copy Issue Report The assignment to `$id` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
305
306	10		return null;
307			}
308
309			/**
310			* @inheritdoc
311			*/
312	10		public function enterNode(\PhpParser\Node $node) {
313	10		$start_line = $node->getAttribute("startLine");
314	10		$end_line = $node->getAttribute("endLine");
315
316	10		if ($this->is_definition($node)) {
317	9		$type = $this->get_type_of($node);
318	9		$id = $this->insert->definition
319	9		( $node->name
			0 ignored issues – show Bug introduced 2016-05-28 18:53 UTC by Report Bug Copy Issue Report Accessing `name` on the interface `PhpParser\Node` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
320	9		, $type
321	9		, $this->file_path
322	9		, $start_line
323	9		, $end_line
324	9		);
325	9		$this->call_definition_listener("listeners_enter_definition", $type, $id, $node);
326	9		$this->definition_stack[] = array($type, $id);
327	9		}
328			else {
329	7		$this->call_misc_listener("listeners_enter_misc", $node);
330			}
331	10		}
332
333	9		protected function get_type_of(\PhpParser\Node $node) {
334			// Class
335	9		if ($node instanceof N\Stmt\Class_) {
336	3		return Variable::CLASS_TYPE;
337			}
338			// Method or Function
339	8		elseif ($node instanceof N\Stmt\ClassMethod) {
340	2		return Variable::METHOD_TYPE;
341			}
342	6		elseif ($node instanceof N\Stmt\Function_) {
343	6		return Variable::FUNCTION_TYPE;
344			}
345			throw \InvalidArgumentException("'".get_class($node)."' has no type.");
346			}
347
348	10		protected function is_definition(\PhpParser\Node $node) {
349			return $node instanceof N\Stmt\Class_
350	10		\|\| $node instanceof N\Stmt\ClassMethod
351	10		\|\| $node instanceof N\Stmt\Function_;
352			}
353
354			/**
355			* @inheritdoc
356			*/
357	10		public function leaveNode(\PhpParser\Node $node) {
358			// Class
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-09-03 19:44 UTC by Report Bug Copy Issue Report `66%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
359			/* if($this->is_definition($node)) {
360			list($type, $id) = array_pop($this->definition_stack);
361			$this->call_definition_listener("listeners_leave_definition", $type, $id, $node);
362			}
363			else {
364			$this->call_misc_listener("listeners_leave_misc", $node);
365			}*/
366	10		}
367			}
368

lechimp-p / dicto.php

Push — master ( 9971b9...3d6cb8 )

Indexer::on_enter_entity() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like