ExampleFinder::getExampleDirectories() - Code Metrics - Inspection of "install php71-xdebug and package-coverage-file" - arunfung/laravel-package-develop - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 72a6c5...9329b7 )

by Arun

created 2017-05-21 15:57 UTC

ExampleFinder::getExampleDirectories() A

↳ Parent: ExampleFinder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @copyright 2010-2015 Mike van Riel<[email protected]>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Reflection;

use phpDocumentor\Reflection\DocBlock\Tags\Example;

/**
 * Class used to find an example file's location based on a given ExampleDescriptor.
 */
class ExampleFinder
{
    /** @var string */
    private $sourceDirectory = '';

    /** @var string[] */
    private $exampleDirectories = array();

    /**
     * Attempts to find the example contents for the given descriptor.
     *
     * @param Example $example
     *
     * @return string
     */
    public function find(Example $example)
    {
        $filename = $example->getFilePath();

        $file = $this->getExampleFileContents($filename);
        if (!$file) {
            return "** File not found : {$filename} **";
        }

        return implode('', array_slice($file, $example->getStartingLine() - 1, $example->getLineCount()));

    }

    /**
     * Registers the project's root directory where an 'examples' folder can be expected.
     *
     * @param string $directory
     *
     * @return void
     */
    public function setSourceDirectory($directory = '')
    {
        $this->sourceDirectory = $directory;
    }

    /**
     * Returns the project's root directory where an 'examples' folder can be expected.
     *
     * @return string
     */
    public function getSourceDirectory()
    {
        return $this->sourceDirectory;
    }

    /**
     * Registers a series of directories that may contain examples.
     *
     * @param string[] $directories
     */
    public function setExampleDirectories(array $directories)
    {
        $this->exampleDirectories = $directories;
    }

    /**
     * Returns a series of directories that may contain examples.
     *
     * @return string[]
     */
    public function getExampleDirectories()
    {
        return $this->exampleDirectories;
    }

    /**
     * Attempts to find the requested example file and returns its contents or null if no file was found.
     *
     * This method will try several methods in search of the given example file, the first one it encounters is
     * returned:
     *
     * 1. Iterates through all examples folders for the given filename
     * 2. Checks the source folder for the given filename
     * 3. Checks the 'examples' folder in the current working directory for examples
     * 4. Checks the path relative to the current working directory for the given filename
     *
     * @param string $filename
     *
     * @return string|null
     */
    private function getExampleFileContents($filename)
    {
        $normalizedPath = null;

        foreach ($this->exampleDirectories as $directory) {
            $exampleFileFromConfig = $this->constructExamplePath($directory, $filename);
            if (is_readable($exampleFileFromConfig)) {
                $normalizedPath = $exampleFileFromConfig;
                break;
            }
        }

        if (!$normalizedPath) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            if (is_readable($this->getExamplePathFromSource($filename))) {
                $normalizedPath = $this->getExamplePathFromSource($filename);
            } elseif (is_readable($this->getExamplePathFromExampleDirectory($filename))) {
                $normalizedPath = $this->getExamplePathFromExampleDirectory($filename);
            } elseif (is_readable($filename)) {
                $normalizedPath = $filename;
            }
        }

        return $normalizedPath && is_readable($normalizedPath) ? file($normalizedPath) : null;
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
    }

    /**
     * Get example filepath based on the example directory inside your project.
     *
     * @param string $file
     *
     * @return string
     */
    private function getExamplePathFromExampleDirectory($file)
    {
        return getcwd() . DIRECTORY_SEPARATOR . 'examples' . DIRECTORY_SEPARATOR . $file;
    }

    /**
     * Returns a path to the example file in the given directory..
     *
     * @param string $directory
     * @param string $file
     *
     * @return string
     */
    private function constructExamplePath($directory, $file)
    {
        return rtrim($directory, '\\/') . DIRECTORY_SEPARATOR . $file;
    }

    /**
     * Get example filepath based on sourcecode.
     *
     * @param string $file
     *
     * @return string
     */
    private function getExamplePathFromSource($file)
    {
        return sprintf(
            '%s%s%s',
            trim($this->getSourceDirectory(), '\\/'),
            DIRECTORY_SEPARATOR,
            trim($file, '"')
        );
    }
}


1			<?php
2			/**
3			* This file is part of phpDocumentor.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*
8			* @copyright 2010-2015 Mike van Riel<[email protected]>
9			* @license http://www.opensource.org/licenses/mit-license.php MIT
10			* @link http://phpdoc.org
11			*/
12
13			namespace phpDocumentor\Reflection;
14
15			use phpDocumentor\Reflection\DocBlock\Tags\Example;
16
17			/**
18			* Class used to find an example file's location based on a given ExampleDescriptor.
19			*/
20			class ExampleFinder
21			{
22			/** @var string */
23			private $sourceDirectory = '';
24
25			/** @var string[] */
26			private $exampleDirectories = array();
27
28			/**
29			* Attempts to find the example contents for the given descriptor.
30			*
31			* @param Example $example
32			*
33			* @return string
34			*/
35			public function find(Example $example)
36			{
37			$filename = $example->getFilePath();
38
39			$file = $this->getExampleFileContents($filename);
40			if (!$file) {
41			return " File not found : {$filename} ";
42			}
43
44			return implode('', array_slice($file, $example->getStartingLine() - 1, $example->getLineCount()));
			0 ignored issues – show Bug introduced 2017-05-21 16:00 UTC by Report Bug Copy Issue Report The method `getStartingLine()` does not seem to exist on `object<phpDocumentor\Ref...\DocBlock\Tags\Example>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history... Bug introduced 2017-05-21 16:00 UTC by Report Bug Copy Issue Report The method `getLineCount()` does not seem to exist on `object<phpDocumentor\Ref...\DocBlock\Tags\Example>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
45			}
46
47			/**
48			* Registers the project's root directory where an 'examples' folder can be expected.
49			*
50			* @param string $directory
51			*
52			* @return void
53			*/
54			public function setSourceDirectory($directory = '')
55			{
56			$this->sourceDirectory = $directory;
57			}
58
59			/**
60			* Returns the project's root directory where an 'examples' folder can be expected.
61			*
62			* @return string
63			*/
64			public function getSourceDirectory()
65			{
66			return $this->sourceDirectory;
67			}
68
69			/**
70			* Registers a series of directories that may contain examples.
71			*
72			* @param string[] $directories
73			*/
74			public function setExampleDirectories(array $directories)
75			{
76			$this->exampleDirectories = $directories;
77			}
78
79			/**
80			* Returns a series of directories that may contain examples.
81			*
82			* @return string[]
83			*/
84			public function getExampleDirectories()
85			{
86			return $this->exampleDirectories;
87			}
88
89			/**
90			* Attempts to find the requested example file and returns its contents or null if no file was found.
91			*
92			* This method will try several methods in search of the given example file, the first one it encounters is
93			* returned:
94			*
95			* 1. Iterates through all examples folders for the given filename
96			* 2. Checks the source folder for the given filename
97			* 3. Checks the 'examples' folder in the current working directory for examples
98			* 4. Checks the path relative to the current working directory for the given filename
99			*
100			* @param string $filename
101			*
102			* @return string\|null
103			*/
104			private function getExampleFileContents($filename)
105			{
106			$normalizedPath = null;
107
108			foreach ($this->exampleDirectories as $directory) {
109			$exampleFileFromConfig = $this->constructExamplePath($directory, $filename);
110			if (is_readable($exampleFileFromConfig)) {
111			$normalizedPath = $exampleFileFromConfig;
112			break;
113			}
114			}
115
116			if (!$normalizedPath) {
			0 ignored issues – show Bug Best Practice introduced 2017-05-21 16:00 UTC by Report Bug Copy Issue Report The expression `$normalizedPath` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
117			if (is_readable($this->getExamplePathFromSource($filename))) {
118			$normalizedPath = $this->getExamplePathFromSource($filename);
119			} elseif (is_readable($this->getExamplePathFromExampleDirectory($filename))) {
120			$normalizedPath = $this->getExamplePathFromExampleDirectory($filename);
121			} elseif (is_readable($filename)) {
122			$normalizedPath = $filename;
123			}
124			}
125
126			return $normalizedPath && is_readable($normalizedPath) ? file($normalizedPath) : null;
			0 ignored issues – show Bug Best Practice introduced 2017-05-21 16:00 UTC by Report Bug Copy Issue Report The expression `$normalizedPath` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
127			}
128
129			/**
130			* Get example filepath based on the example directory inside your project.
131			*
132			* @param string $file
133			*
134			* @return string
135			*/
136			private function getExamplePathFromExampleDirectory($file)
137			{
138			return getcwd() . DIRECTORY_SEPARATOR . 'examples' . DIRECTORY_SEPARATOR . $file;
139			}
140
141			/**
142			* Returns a path to the example file in the given directory..
143			*
144			* @param string $directory
145			* @param string $file
146			*
147			* @return string
148			*/
149			private function constructExamplePath($directory, $file)
150			{
151			return rtrim($directory, '\\/') . DIRECTORY_SEPARATOR . $file;
152			}
153
154			/**
155			* Get example filepath based on sourcecode.
156			*
157			* @param string $file
158			*
159			* @return string
160			*/
161			private function getExamplePathFromSource($file)
162			{
163			return sprintf(
164			'%s%s%s',
165			trim($this->getSourceDirectory(), '\\/'),
166			DIRECTORY_SEPARATOR,
167			trim($file, '"')
168			);
169			}
170			}
171

arunfung / laravel-package-develop

Push — master ( 72a6c5...9329b7 )

ExampleFinder::getExampleDirectories() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like