Generator::hash() - Code Metrics - Inspection of "Increased code coverage" - samsonframework/view - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7179be...d0f261 )

by Vitaly

created 2016-02-21 14:42 UTC

Generator::hash() A

↳ Parent: Generator

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
ccs	6
cts	6
cp	1
rs	9.6666
cc	2
eloc	5
nc	2
nop	0
crap	2

<?php
/**
 * Created by Vitaly Iegorov <[email protected]>.
 * on 18.02.16 at 14:17
 */
namespace samsonframework\view;

use samsonframework\view\exception\GeneratedViewPathHasReservedWord;

/**
 * Views generator, this class scans resource for view files and creates
 * appropriate View class ancestors with namespace as relative view location
 * and file name as View class name ending with "View".
 *
 * Generator also analyzes view files content and creates protected class field
 * members for every variable used inside with chainable setter for this field,
 * to help IDE and developer in creating awesome code.
 *
 * TODO: Check for reserved keywords(like list) in namespaces
 * TODO: Somehow know view variable type(typehint??) and add comments and type-hints to generated classes.
 * TODO: Clever analysis for foreach, if, and so on language structures, we do not need to create variables for loop iterator.
 * TODO: If a variable is used in foreach - this is an array or Iteratable ancestor - we can add typehint automatically
 * TODO: Analyze view file php doc comments to get variable types
 * TODO: If a token variable is not $this and has "->" - this is object, maybe type-hint needs to be added.
 * TODO: Add caching logic to avoid duplicate file reading
 *
 * @package samsonframework\view
 */
class Generator
{
    /** string All generated view classes will end with this suffix */
    const VIEW_CLASSNAME_SUFFIX = 'View';

    /** @var array Collection of PHP reserved words */
    protected static $reservedWords = array('list');

    /** @var Metadata[] Collection of view metadata */
    protected $metadata = array();

    /** @var \samsonphp\generator\Generator */
    protected $generator;

    /** @var string Generated classes namespace prefix */
    protected $namespacePrefix;

    /** @var string Collection of namespace parts to be ignored in generated namespaces */
    protected $ignoreNamespace = array();

    /** @var array Collection of view files */
    protected $files;

    /** @var string Scanning entry path */
    protected $entryPath;

    /**
     * Generator constructor.
     *
     * @param \samsonphp\generator\Generator $generator
     * @param string                         $namespacePrefix
     * @param array                          $ignoreNamespace
     */
    public function __construct(\samsonphp\generator\Generator $generator, $namespacePrefix, array $ignoreNamespace = array())
    {
        $this->generator = $generator;
        $this->ignoreNamespace = $ignoreNamespace;

        $this->namespacePrefix = rtrim(ltrim($namespacePrefix, '\\'), '\\').'\\';
    }

    /**
     * Change variable name to camel caps format.
     *
     * @param string $variable
     *
     * @return string Changed variable name
     */
    public function changeName($variable)
    {
        return lcfirst(
            implode(
                '',
                array_map(
                    function ($element) { return ucfirst($element);},

                    explode('_', $variable)
                )
            )
        );
    }

    /**
     * Recursively scan path for files with specified extensions.
     *
     * @param string $source     Entry point path
     * @param string $path       Entry path for scanning
     * @param array  $extensions Collection of file extensions without dot
     */
    public function scan($source, array $extensions = array(View::DEFAULT_EXT), $path = null)
    {
        $this->entryPath = $source;

        $path = isset($path) ? $path : $source;

        // Recursively go deeper into inner folders for scanning
        $folders  = glob($path.'/*', GLOB_ONLYDIR);
        foreach ($folders as $folder) {
            $this->scan($source, $extensions, $folder);
        }

        // Iterate file extensions
        foreach ($extensions as $extension) {
            foreach (glob(rtrim($path, '/') . '/*.'.$extension) as $file) {
                $this->files[str_replace($source, '', $file)] = $file;
            }
        }
    }

    /**
     * Analyze view file and create its metadata.
     *
     * @param string $file Path to view file
     *
     * @return Metadata View file metadata
     */
    public function analyze($file)
    {
        $metadata = new Metadata();
        // Use PHP tokenizer to find variables
        foreach ($tokens = token_get_all(file_get_contents($file)) as $idx => $token) {
            if (!is_string($token) && $token[0] === T_VARIABLE) {
                // Store variable
                $variableText = $token[1];
                // Store variable name
                $variableName = ltrim($token[1], '$');
                // If next token is object operator
                if ($tokens[$idx + 1][0] === T_OBJECT_OPERATOR) {
                    $variableName = $tokens[$idx + 2][1];
                    // And two more tokens
                    $variableText .= $tokens[$idx + 1][1] . $variableName;
                }
                // Store view variable key - actual object name => full varaible usage
                $metadata->variables[$this->changeName($variableName)] = $variableText;
            }
        }

        return $metadata;
    }

    /**
     * Generic class name and its name space generator.
     *
     * @param string $file      Full path to view file
     * @param string $entryPath Entry path
     *
     * @return array Class name[0] and namespace[1]
     * @throws GeneratedViewPathHasReservedWord
     */
    protected function generateClassName($file, $entryPath)
    {
        // Get only file name as a class name with suffix
        $className = ucfirst(pathinfo($file, PATHINFO_FILENAME) . self::VIEW_CLASSNAME_SUFFIX);

        // Get namespace as part of file path relatively to entry path
        $nameSpace = rtrim(ltrim(
            str_replace(
                '/',
                '\\',
                str_replace($entryPath, '', pathinfo($file, PATHINFO_DIRNAME))
            ),
            '\\'
        ), '\\');

        // Remove ignored parts from namespaces
        $nameSpace = str_replace($this->ignoreNamespace, '', $nameSpace);

        // Check generated namespaces
        foreach (static::$reservedWords as $reservedWord) {
            if (strpos($nameSpace, '\\' . $reservedWord) !== false) {
                throw new GeneratedViewPathHasReservedWord($file.'('.$reservedWord.')');
            }
        }

        // Return collection for further usage
        return array($className, rtrim($this->namespacePrefix . $nameSpace, '\\'));
    }

    /**
     * Generate view classes.
     *
     * @param string $path Entry path for generated classes and folders
     */
    public function generate($path = __DIR__)
    {
        foreach ($this->files as $relativePath => $absolutePath) {
            $this->metadata[$absolutePath] = $this->analyze($absolutePath);
            $this->metadata[$absolutePath]->path = $relativePath;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            list($this->metadata[$absolutePath]->className,
                $this->metadata[$absolutePath]->namespace) = $this->generateClassName($absolutePath, $this->entryPath);
        }

        foreach ($this->metadata as $metadata) {
            $this->generateViewClass($metadata, $path);
        }
    }

    /** @return string Hash representing generator state */
    public function hash()
    {
        $hash = '';
        foreach ($this->files as $relativePath => $absolutePath) {
            $hash .= $relativePath.filemtime($absolutePath);
        }

        return md5($hash);
    }

    /**
     * Create View class ancestor.
     *
     * @param Metadata $metadata View file metadata
     * @param string   $path Entry path for generated classes and folders
     */
    protected function generateViewClass(Metadata $metadata, $path)
    {
        $this->generator

            ->defNamespace($metadata->namespace)
            ->multiComment(array('Class for view "'.$metadata->path.'" rendering'))
            ->defClass($metadata->className, '\\' . View::class)
            ->commentVar('string', 'Path to view file')
            ->defClassVar('$path', 'protected', $metadata->path)
            ->commentVar('array', 'Collection of view variables')
            ->defClassVar('$variables', 'public static', array_keys($metadata->variables));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        // Iterate all view variables
        foreach (array_keys($metadata->variables) as $name) {
            $this->generator
                ->commentVar('mixed', 'View variable')
                ->defClassVar('$'.$name, 'public')
                ->text($this->generateViewVariableSetter($name));
        }

        // Iterate namespace and create folder structure
        $path .= '/'.str_replace('\\', '/', $metadata->namespace);
        if (!is_dir($path)) {
            mkdir($path, 0775, true);
        }

        file_put_contents(
            $path.'/'.$metadata->className.'.php',
            '<?php'.$this->generator->endClass()->flush()
        );
    }

    /**
     * Generate constructor for application class.
     *
     * @param string $variable View variable name
     *
     * @return string View variable setter method
     */
    protected function generateViewVariableSetter($variable)
    {
        $class = "\n\t" . '/**';
        $class .= "\n\t" . ' * Setter for ' . $variable . ' view variable';
        $class .= "\n\t" . ' *';
        $class .= "\n\t" . ' * @param mixed $value View variable value';
        $class .= "\n\t" . ' * @return $this Chaining';
        $class .= "\n\t" . ' */';
        $class .= "\n\t" . 'public function ' . $variable . '($value)';
        $class .= "\n\t" . '{';
        $class .= "\n\t\t" . 'return parent::set($value, \'' . $variable . '\');';
        $class .= "\n\t" . '}' . "\n";

        return $class;
    }
}


1		<?php
2		/**
3		* Created by Vitaly Iegorov <[email protected]>.
4		* on 18.02.16 at 14:17
5		*/
6		namespace samsonframework\view;
7
8		use samsonframework\view\exception\GeneratedViewPathHasReservedWord;
9
10		/**
11		* Views generator, this class scans resource for view files and creates
12		* appropriate View class ancestors with namespace as relative view location
13		* and file name as View class name ending with "View".
14		*
15		* Generator also analyzes view files content and creates protected class field
16		* members for every variable used inside with chainable setter for this field,
17		* to help IDE and developer in creating awesome code.
18		*
19		* TODO: Check for reserved keywords(like list) in namespaces
20		* TODO: Somehow know view variable type(typehint??) and add comments and type-hints to generated classes.
21		* TODO: Clever analysis for foreach, if, and so on language structures, we do not need to create variables for loop iterator.
22		* TODO: If a variable is used in foreach - this is an array or Iteratable ancestor - we can add typehint automatically
23		* TODO: Analyze view file php doc comments to get variable types
24		* TODO: If a token variable is not $this and has "->" - this is object, maybe type-hint needs to be added.
25		* TODO: Add caching logic to avoid duplicate file reading
26		*
27		* @package samsonframework\view
28		*/
29		class Generator
30		{
31		/** string All generated view classes will end with this suffix */
32		const VIEW_CLASSNAME_SUFFIX = 'View';
33
34		/** @var array Collection of PHP reserved words */
35		protected static $reservedWords = array('list');
36
37		/** @var Metadata[] Collection of view metadata */
38		protected $metadata = array();
39
40		/** @var \samsonphp\generator\Generator */
41		protected $generator;
42
43		/** @var string Generated classes namespace prefix */
44		protected $namespacePrefix;
45
46		/** @var string Collection of namespace parts to be ignored in generated namespaces */
47		protected $ignoreNamespace = array();
48
49		/** @var array Collection of view files */
50		protected $files;
51
52		/** @var string Scanning entry path */
53		protected $entryPath;
54
55		/**
56		* Generator constructor.
57		*
58		* @param \samsonphp\generator\Generator $generator
59		* @param string $namespacePrefix
60		* @param array $ignoreNamespace
61		*/
62	3	public function __construct(\samsonphp\generator\Generator $generator, $namespacePrefix, array $ignoreNamespace = array())
63		{
64	3	$this->generator = $generator;
65	3	$this->ignoreNamespace = $ignoreNamespace;
		0 ignored issues – show Documentation Bug introduced 2016-02-21 14:18 UTC by Report Bug Copy Issue Report It seems like `$ignoreNamespace` of type `array` is incompatible with the declared type `string` of property `$ignoreNamespace`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
66	3	$this->namespacePrefix = rtrim(ltrim($namespacePrefix, '\\'), '\\').'\\';
67	3	}
68
69		/**
70		* Change variable name to camel caps format.
71		*
72		* @param string $variable
73		*
74		* @return string Changed variable name
75		*/
76	1	public function changeName($variable)
77		{
78	1	return lcfirst(
79	1	implode(
80	1	'',
81	1	array_map(
82		function ($element) { return ucfirst($element);},
		0 ignored issues – show Coding Style introduced 2016-02-21 14:14 UTC by Report Bug Copy Issue Report Opening brace must be the last content on the line Loading history...
83	1	explode('_', $variable)
84	1	)
85	1	)
86	1	);
87		}
88
89		/**
90		* Recursively scan path for files with specified extensions.
91		*
92		* @param string $source Entry point path
93		* @param string $path Entry path for scanning
94		* @param array $extensions Collection of file extensions without dot
95		*/
96	3	public function scan($source, array $extensions = array(View::DEFAULT_EXT), $path = null)
97		{
98	3	$this->entryPath = $source;
99
100	3	$path = isset($path) ? $path : $source;
101
102		// Recursively go deeper into inner folders for scanning
103	3	$folders = glob($path.'/*', GLOB_ONLYDIR);
104	3	foreach ($folders as $folder) {
105	3	$this->scan($source, $extensions, $folder);
106	3	}
107
108		// Iterate file extensions
109	3	foreach ($extensions as $extension) {
110	3	foreach (glob(rtrim($path, '/') . '/*.'.$extension) as $file) {
111	3	$this->files[str_replace($source, '', $file)] = $file;
112	3	}
113	3	}
114	3	}
115
116		/**
117		* Analyze view file and create its metadata.
118		*
119		* @param string $file Path to view file
120		*
121		* @return Metadata View file metadata
122		*/
123	2	public function analyze($file)
124		{
125	2	$metadata = new Metadata();
126		// Use PHP tokenizer to find variables
127	2	foreach ($tokens = token_get_all(file_get_contents($file)) as $idx => $token) {
128	2	if (!is_string($token) && $token[0] === T_VARIABLE) {
129		// Store variable
130	1	$variableText = $token[1];
131		// Store variable name
132	1	$variableName = ltrim($token[1], '$');
133		// If next token is object operator
134	1	if ($tokens[$idx + 1][0] === T_OBJECT_OPERATOR) {
135	1	$variableName = $tokens[$idx + 2][1];
136		// And two more tokens
137	1	$variableText .= $tokens[$idx + 1][1] . $variableName;
138	1	}
139		// Store view variable key - actual object name => full varaible usage
140	1	$metadata->variables[$this->changeName($variableName)] = $variableText;
141	1	}
142	2	}
143
144	2	return $metadata;
145		}
146
147		/**
148		* Generic class name and its name space generator.
149		*
150		* @param string $file Full path to view file
151		* @param string $entryPath Entry path
152		*
153		* @return array Class name[0] and namespace[1]
154		* @throws GeneratedViewPathHasReservedWord
155		*/
156	2	protected function generateClassName($file, $entryPath)
157		{
158		// Get only file name as a class name with suffix
159	2	$className = ucfirst(pathinfo($file, PATHINFO_FILENAME) . self::VIEW_CLASSNAME_SUFFIX);
160
161		// Get namespace as part of file path relatively to entry path
162	2	$nameSpace = rtrim(ltrim(
163	2	str_replace(
164	2	'/',
165	2	'\\',
166	2	str_replace($entryPath, '', pathinfo($file, PATHINFO_DIRNAME))
167	2	),
168		'\\'
169	2	), '\\');
170
171		// Remove ignored parts from namespaces
172	2	$nameSpace = str_replace($this->ignoreNamespace, '', $nameSpace);
173
174		// Check generated namespaces
175	2	foreach (static::$reservedWords as $reservedWord) {
176	2	if (strpos($nameSpace, '\\' . $reservedWord) !== false) {
177	1	throw new GeneratedViewPathHasReservedWord($file.'('.$reservedWord.')');
178		}
179	1	}
180
181		// Return collection for further usage
182	1	return array($className, rtrim($this->namespacePrefix . $nameSpace, '\\'));
183		}
184
185		/**
186		* Generate view classes.
187		*
188		* @param string $path Entry path for generated classes and folders
189		*/
190	2	public function generate($path = __DIR__)
191		{
192	2	foreach ($this->files as $relativePath => $absolutePath) {
193	2	$this->metadata[$absolutePath] = $this->analyze($absolutePath);
194	2	$this->metadata[$absolutePath]->path = $relativePath;
		0 ignored issues – show Documentation Bug introduced 2016-02-21 14:44 UTC by Report Bug Copy Issue Report It seems like `$relativePath` can also be of type `integer`. However, the property `$path` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
195	1	list($this->metadata[$absolutePath]->className,
196	2	$this->metadata[$absolutePath]->namespace) = $this->generateClassName($absolutePath, $this->entryPath);
197	1	}
198
199	1	foreach ($this->metadata as $metadata) {
200	1	$this->generateViewClass($metadata, $path);
201	1	}
202	1	}
203
204		/** @return string Hash representing generator state */
205	1	public function hash()
206		{
207	1	$hash = '';
208	1	foreach ($this->files as $relativePath => $absolutePath) {
209	1	$hash .= $relativePath.filemtime($absolutePath);
210	1	}
211
212	1	return md5($hash);
213		}
214
215		/**
216		* Create View class ancestor.
217		*
218		* @param Metadata $metadata View file metadata
219		* @param string $path Entry path for generated classes and folders
220		*/
221	1	protected function generateViewClass(Metadata $metadata, $path)
222		{
223	1	$this->generator
		0 ignored issues – show Bug introduced 2016-02-20 15:05 UTC by Report Bug Copy Issue Report The method `defnamespace()` cannot be called from this context as it is declared private in class `samsonphp\generator\Generator`. This check looks for access to methods that are not accessible from the current context. If you need to make a method accessible to another context you can raise its visibility level in the defining class. Loading history...
224	1	->defNamespace($metadata->namespace)
225	1	->multiComment(array('Class for view "'.$metadata->path.'" rendering'))
226	1	->defClass($metadata->className, '\\' . View::class)
227	1	->commentVar('string', 'Path to view file')
228	1	->defClassVar('$path', 'protected', $metadata->path)
229	1	->commentVar('array', 'Collection of view variables')
230	1	->defClassVar('$variables', 'public static', array_keys($metadata->variables));
		0 ignored issues – show Documentation introduced 2016-02-20 15:05 UTC by Report Bug Copy Issue Report `array_keys($metadata->variables)` is of type `array<integer,integer\|string>`, but the function expects a `string\|null`. 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...
231
232		// Iterate all view variables
233	1	foreach (array_keys($metadata->variables) as $name) {
234	1	$this->generator
235	1	->commentVar('mixed', 'View variable')
236	1	->defClassVar('$'.$name, 'public')
237	1	->text($this->generateViewVariableSetter($name));
238	1	}
239
240		// Iterate namespace and create folder structure
241	1	$path .= '/'.str_replace('\\', '/', $metadata->namespace);
242	1	if (!is_dir($path)) {
243	1	mkdir($path, 0775, true);
244	1	}
245
246	1	file_put_contents(
247	1	$path.'/'.$metadata->className.'.php',
248	1	'<?php'.$this->generator->endClass()->flush()
249	1	);
250	1	}
251
252		/**
253		* Generate constructor for application class.
254		*
255		* @param string $variable View variable name
256		*
257		* @return string View variable setter method
258		*/
259	1	protected function generateViewVariableSetter($variable)
260		{
261	1	$class = "\n\t" . '/**';
262	1	$class .= "\n\t" . ' * Setter for ' . $variable . ' view variable';
263	1	$class .= "\n\t" . ' *';
264	1	$class .= "\n\t" . ' * @param mixed $value View variable value';
265	1	$class .= "\n\t" . ' * @return $this Chaining';
266	1	$class .= "\n\t" . ' */';
267	1	$class .= "\n\t" . 'public function ' . $variable . '($value)';
268	1	$class .= "\n\t" . '{';
269	1	$class .= "\n\t\t" . 'return parent::set($value, \'' . $variable . '\');';
270	1	$class .= "\n\t" . '}' . "\n";
271
272	1	return $class;
273		}
274		}
275

samsonframework / view

Push — master ( 7179be...d0f261 )

Generator::hash() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like