Generator::scan() - Code Metrics - Inspection of "Added prent view class" - samsonframework/view - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f6eaa5...68d2b0 )

by Vitaly

created 2016-02-22 12:09 UTC

Generator::scan() B

↳ Parent: Generator

Complexity

Conditions	5
Paths	12

Size

Total Lines	19
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	5

Importance

Changes	6
Bugs	1	Features	1

Metric	Value
c	6
b	1
f	1
dl	0
loc	19
ccs	13
cts	13
cp	1
rs	8.8571
cc	5
eloc	9
nc	12
nop	3
crap	5

<?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
 * TODO: Do not generate class fields with empty values
 * TODO: Generate constants with field names
 *
 * @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 = array();

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

    /** @var string Parent view class name */
    protected $parentViewClass;

    /**
     * Generator constructor.
     *
     * @param \samsonphp\generator\Generator $generator PHP code generator instance
     * @param string                         $namespacePrefix Generated classes namespace will have it
     * @param array                          $ignoreNamespace Namespace parts that needs to ignored
     * @param string                         $parentViewClass Generated classes will extend it
     */
    public function __construct(
        \samsonphp\generator\Generator $generator,
        $namespacePrefix,
        array $ignoreNamespace = array(),
        $parentViewClass = \samsonframework\view\View::class
    )

    {
        $this->generator = $generator;
        $this->parentViewClass = $parentViewClass;
        $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], '$');

                // Ignore static variables
                if (isset($tokens[$idx-1]) && $tokens[$idx-1][0] === T_DOUBLE_COLON) {
                    $metadata->static[$variableName] = $variableText;
                }

                // If next token is object operator
                if ($tokens[$idx + 1][0] === T_OBJECT_OPERATOR) {
                    // Ignore $this
                    if ($variableName === 'this') {
                        continue;
                    }

                    // And two more tokens
                    $variableText .= $tokens[$idx + 1][1] . $tokens[$idx + 2][1];

                    // Store object variable
                    $metadata->variables[$this->changeName($variableName)] = $variableText;
                    // Store view variable key - actual object name => full variable usage
                    $metadata->originalVariables[$this->changeName($variableName)] = $variableName;
                } else {
                    // Store original variable name
                    $metadata->originalVariables[$this->changeName($variableName)] = $variableName;
                    // Store view variable key - actual object name => full variable usage
                    $metadata->variables[$this->changeName($variableName)] = $variableText;
                }
            } elseif ($token[0] === T_DOC_COMMENT) { // Match doc block comments
                // Parse variable type and name
                if (preg_match('/@var\s+(?<type>[^ ]+)\s+(?<variable>[^*]+)/', $token[1], $matches)) {
                    $metadata->types[substr(trim($matches['variable']), 1)] = $matches['type'];
                }
            }
        }

        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 = $absolutePath;
            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 .= md5($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, '\\' . $this->parentViewClass)
            ->commentVar('string', 'Path to view file')
            ->defClassVar('$file', 'protected', $metadata->path)
            //->commentVar('array', 'Collection of view variables')
            //->defClassVar('$variables', 'public static', array_keys($metadata->variables))
            //->commentVar('array', 'Collection of view variable types')
            //->defClassVar('$types', 'public static', $metadata->types)
        ;

        // Iterate all view variables
        foreach (array_keys($metadata->variables) as $name) {
            $type = array_key_exists($name, $metadata->types) ? $metadata->types[$name] : 'mixed';
            $static = array_key_exists($name, $metadata->static) ? ' static' : '';
            $this->generator
                ->commentVar($type, 'View variable')
                ->defClassVar('$'.$name, 'public'.$static);

            // Do not generate setters for static variables
            if ($static !== ' static') {
                $this->generator->text($this->generateViewVariableSetter(
                    $name,
                    $metadata->originalVariables[$name],
                    $type
                ));
            }
        }

        // 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
     * @param string $original Original view variable name
     * @param string $type Variable type
     *
     * @return string View variable setter method
     */
    protected function generateViewVariableSetter($variable, $original, $type = 'mixed')
    {
        // Define type hint
        $typeHint = $type !== 'mixed' && $type !== 'string' ? $type.' ' : '';

        $class = "\n\t" . '/**';
        $class .= "\n\t" . ' * Setter for ' . $variable . ' view variable';
        $class .= "\n\t" . ' *';
        $class .= "\n\t" . ' * @param '.$type.' $value View variable value';
        $class .= "\n\t" . ' * @return $this Chaining';
        $class .= "\n\t" . ' */';
        $class .= "\n\t" . 'public function ' . $variable . '('.$typeHint.'$value)';
        $class .= "\n\t" . '{';
        $class .= "\n\t\t" . 'return parent::set($value, \'' . $original . '\');';
        $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		* TODO: Do not generate class fields with empty values
27		* TODO: Generate constants with field names
28		*
29		* @package samsonframework\view
30		*/
31		class Generator
32		{
33		/** string All generated view classes will end with this suffix */
34		const VIEW_CLASSNAME_SUFFIX = 'View';
35
36		/** @var array Collection of PHP reserved words */
37		protected static $reservedWords = array('list');
38
39		/** @var Metadata[] Collection of view metadata */
40		protected $metadata = array();
41
42		/** @var \samsonphp\generator\Generator */
43		protected $generator;
44
45		/** @var string Generated classes namespace prefix */
46		protected $namespacePrefix;
47
48		/** @var string Collection of namespace parts to be ignored in generated namespaces */
49		protected $ignoreNamespace = array();
50
51		/** @var array Collection of view files */
52		protected $files = array();
53
54		/** @var string Scanning entry path */
55		protected $entryPath;
56
57		/** @var string Parent view class name */
58		protected $parentViewClass;
59
60		/**
61		* Generator constructor.
62		*
63		* @param \samsonphp\generator\Generator $generator PHP code generator instance
64		* @param string $namespacePrefix Generated classes namespace will have it
65		* @param array $ignoreNamespace Namespace parts that needs to ignored
66		* @param string $parentViewClass Generated classes will extend it
67		*/
68	3	public function __construct(
69		\samsonphp\generator\Generator $generator,
70		$namespacePrefix,
71		array $ignoreNamespace = array(),
72		$parentViewClass = \samsonframework\view\View::class
73		)
		0 ignored issues – show Coding Style introduced 2016-02-22 12:11 UTC by Report Bug Copy Issue Report There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found newline Loading history...
74		{
75	3	$this->generator = $generator;
76	3	$this->parentViewClass = $parentViewClass;
77	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...
78	3	$this->namespacePrefix = rtrim(ltrim($namespacePrefix, '\\'), '\\').'\\';
79	3	}
80
81		/**
82		* Change variable name to camel caps format.
83		*
84		* @param string $variable
85		*
86		* @return string Changed variable name
87		*/
88	1	public function changeName($variable)
89		{
90	1	return lcfirst(
91	1	implode(
92	1	'',
93	1	array_map(
94		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...
95	1	explode('_', $variable)
96	1	)
97	1	)
98	1	);
99		}
100
101		/**
102		* Recursively scan path for files with specified extensions.
103		*
104		* @param string $source Entry point path
105		* @param string $path Entry path for scanning
106		* @param array $extensions Collection of file extensions without dot
107		*/
108	3	public function scan($source, array $extensions = array(View::DEFAULT_EXT), $path = null)
109		{
110	3	$this->entryPath = $source;
111
112	3	$path = isset($path) ? $path : $source;
113
114		// Recursively go deeper into inner folders for scanning
115	3	$folders = glob($path.'/*', GLOB_ONLYDIR);
116	3	foreach ($folders as $folder) {
117	3	$this->scan($source, $extensions, $folder);
118	3	}
119
120		// Iterate file extensions
121	3	foreach ($extensions as $extension) {
122	3	foreach (glob(rtrim($path, '/') . '/*.'.$extension) as $file) {
123	3	$this->files[str_replace($source, '', $file)] = $file;
124	3	}
125	3	}
126	3	}
127
128		/**
129		* Analyze view file and create its metadata.
130		*
131		* @param string $file Path to view file
132		*
133		* @return Metadata View file metadata
134		*/
135	2	public function analyze($file)
136		{
137	2	$metadata = new Metadata();
138		// Use PHP tokenizer to find variables
139	2	foreach ($tokens = token_get_all(file_get_contents($file)) as $idx => $token) {
140	2	if (!is_string($token) && $token[0] === T_VARIABLE) {
141		// Store variable
142	1	$variableText = $token[1];
143		// Store variable name
144	1	$variableName = ltrim($token[1], '$');
145
146		// Ignore static variables
147	1	if (isset($tokens[$idx-1]) && $tokens[$idx-1][0] === T_DOUBLE_COLON) {
148		$metadata->static[$variableName] = $variableText;
149		}
150
151		// If next token is object operator
152	1	if ($tokens[$idx + 1][0] === T_OBJECT_OPERATOR) {
153		// Ignore $this
154	1	if ($variableName === 'this') {
155	1	continue;
156		}
157
158		// And two more tokens
159	1	$variableText .= $tokens[$idx + 1][1] . $tokens[$idx + 2][1];
160
161		// Store object variable
162	1	$metadata->variables[$this->changeName($variableName)] = $variableText;
163		// Store view variable key - actual object name => full variable usage
164	1	$metadata->originalVariables[$this->changeName($variableName)] = $variableName;
165	1	} else {
166		// Store original variable name
167	1	$metadata->originalVariables[$this->changeName($variableName)] = $variableName;
168		// Store view variable key - actual object name => full variable usage
169	1	$metadata->variables[$this->changeName($variableName)] = $variableText;
170		}
171	2	} elseif ($token[0] === T_DOC_COMMENT) { // Match doc block comments
172		// Parse variable type and name
173	2	if (preg_match('/@var\s+(?<type>[^ ]+)\s+(?<variable>[^*]+)/', $token[1], $matches)) {
174	1	$metadata->types[substr(trim($matches['variable']), 1)] = $matches['type'];
175	1	}
176	2	}
177	2	}
178
179	2	return $metadata;
180		}
181
182		/**
183		* Generic class name and its name space generator.
184		*
185		* @param string $file Full path to view file
186		* @param string $entryPath Entry path
187		*
188		* @return array Class name[0] and namespace[1]
189		* @throws GeneratedViewPathHasReservedWord
190		*/
191	2	protected function generateClassName($file, $entryPath)
192		{
193		// Get only file name as a class name with suffix
194	2	$className = ucfirst(pathinfo($file, PATHINFO_FILENAME) . self::VIEW_CLASSNAME_SUFFIX);
195
196		// Get namespace as part of file path relatively to entry path
197	2	$nameSpace = rtrim(ltrim(
198	2	str_replace(
199	2	'/',
200	2	'\\',
201	2	str_replace($entryPath, '', pathinfo($file, PATHINFO_DIRNAME))
202	2	),
203		'\\'
204	2	), '\\');
205
206		// Remove ignored parts from namespaces
207	2	$nameSpace = str_replace($this->ignoreNamespace, '', $nameSpace);
208
209		// Check generated namespaces
210	2	foreach (static::$reservedWords as $reservedWord) {
211	2	if (strpos($nameSpace, '\\' . $reservedWord) !== false) {
212	1	throw new GeneratedViewPathHasReservedWord($file.'('.$reservedWord.')');
213		}
214	1	}
215
216		// Return collection for further usage
217	1	return array($className, rtrim($this->namespacePrefix . $nameSpace, '\\'));
218		}
219
220		/**
221		* Generate view classes.
222		*
223		* @param string $path Entry path for generated classes and folders
224		*/
225	2	public function generate($path = __DIR__)
226		{
227	2	foreach ($this->files as $relativePath => $absolutePath) {
228	2	$this->metadata[$absolutePath] = $this->analyze($absolutePath);
229	2	$this->metadata[$absolutePath]->path = $absolutePath;
230	1	list($this->metadata[$absolutePath]->className,
231	2	$this->metadata[$absolutePath]->namespace) = $this->generateClassName($absolutePath, $this->entryPath);
232	1	}
233
234	1	foreach ($this->metadata as $metadata) {
235	1	$this->generateViewClass($metadata, $path);
236	1	}
237	1	}
238
239		/** @return string Hash representing generator state */
240	1	public function hash()
241		{
242	1	$hash = '';
243	1	foreach ($this->files as $relativePath => $absolutePath) {
244	1	$hash .= md5($relativePath.filemtime($absolutePath));
245	1	}
246
247	1	return md5($hash);
248		}
249
250		/**
251		* Create View class ancestor.
252		*
253		* @param Metadata $metadata View file metadata
254		* @param string $path Entry path for generated classes and folders
255		*/
256	1	protected function generateViewClass(Metadata $metadata, $path)
257		{
258	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...
259	1	->defNamespace($metadata->namespace)
260	1	->multiComment(array('Class for view "'.$metadata->path.'" rendering'))
261	1	->defClass($metadata->className, '\\' . $this->parentViewClass)
262	1	->commentVar('string', 'Path to view file')
263	1	->defClassVar('$file', 'protected', $metadata->path)
264		//->commentVar('array', 'Collection of view variables')
265		//->defClassVar('$variables', 'public static', array_keys($metadata->variables))
266		//->commentVar('array', 'Collection of view variable types')
267		//->defClassVar('$types', 'public static', $metadata->types)
268		;
269
270		// Iterate all view variables
271	1	foreach (array_keys($metadata->variables) as $name) {
272	1	$type = array_key_exists($name, $metadata->types) ? $metadata->types[$name] : 'mixed';
273	1	$static = array_key_exists($name, $metadata->static) ? ' static' : '';
274	1	$this->generator
275	1	->commentVar($type, 'View variable')
276	1	->defClassVar('$'.$name, 'public'.$static);
277
278		// Do not generate setters for static variables
279	1	if ($static !== ' static') {
280	1	$this->generator->text($this->generateViewVariableSetter(
281	1	$name,
282	1	$metadata->originalVariables[$name],
283		$type
284	1	));
285	1	}
286	1	}
287
288		// Iterate namespace and create folder structure
289	1	$path .= '/'.str_replace('\\', '/', $metadata->namespace);
290	1	if (!is_dir($path)) {
291	1	mkdir($path, 0775, true);
292	1	}
293
294	1	file_put_contents(
295	1	$path.'/'.$metadata->className.'.php',
296	1	'<?php'.$this->generator->endClass()->flush()
297	1	);
298	1	}
299
300		/**
301		* Generate constructor for application class.
302		*
303		* @param string $variable View variable name
304		* @param string $original Original view variable name
305		* @param string $type Variable type
306		*
307		* @return string View variable setter method
308		*/
309	1	protected function generateViewVariableSetter($variable, $original, $type = 'mixed')
310		{
311		// Define type hint
312	1	$typeHint = $type !== 'mixed' && $type !== 'string' ? $type.' ' : '';
313
314	1	$class = "\n\t" . '/**';
315	1	$class .= "\n\t" . ' * Setter for ' . $variable . ' view variable';
316	1	$class .= "\n\t" . ' *';
317	1	$class .= "\n\t" . ' * @param '.$type.' $value View variable value';
318	1	$class .= "\n\t" . ' * @return $this Chaining';
319	1	$class .= "\n\t" . ' */';
320	1	$class .= "\n\t" . 'public function ' . $variable . '('.$typeHint.'$value)';
321	1	$class .= "\n\t" . '{';
322	1	$class .= "\n\t\t" . 'return parent::set($value, \'' . $original . '\');';
323	1	$class .= "\n\t" . '}' . "\n";
324
325	1	return $class;
326		}
327		}
328

samsonframework / view

Push — master ( f6eaa5...68d2b0 )

Generator::scan() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like