GenericWriter - Code Metrics - samsoncms/api - Measure and Improve Code Quality continuously with Scrutinizer

GenericWriter A
last analyzed 2016-10-05 09:42 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	91
Duplicated Lines	20.88 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	10
lcom	1
cbo	2
dl	19
loc	91
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	27	5
B	write()	19	31	5

How to fix Duplicated Code

<?php
//[PHPCOMPRESSOR(remove,start)]
/**
 * Created by Vitaly Iegorov <[email protected]>.
 * on 25.03.16 at 12:04
 */
namespace samsoncms\api\generator;

use samsonframework\orm\DatabaseInterface;
use samsonphp\generator\Generator;

/**
 * Generator classes file writer.
 *
 * @package samsoncms\api\generator
 */
class GenericWriter
{
    /** @var \samsoncms\api\generator\analyzer\GenericAnalyzer[string] Collection of entity analyzers */
    protected $analyzers = [];

    /** @var \samsoncms\api\generator\Generic[string] Collection of entity generators */
    protected $generators = [];

    /** @var array Analyzers metadata */
    protected $metadata = [];

    /** @var Generator Code generator */
    protected $codeGenerator;

    /** @var string Path to generated entities */
    protected $path;

    /**
     * Writer constructor.
     *
     * @param DatabaseInterface $db
     * @param Generator         $codeGenerator
     * @param string            $namespace
     * @param array             $analyzers Collection of analyzer class names
     * @param string            $path Path to generated entities
     *
     * @throws \Exception
     */
    public function __construct(DatabaseInterface $db, Generator $codeGenerator, $namespace, array $analyzers, $path)
    {
        $this->codeGenerator = $codeGenerator;
        $this->path = $path;
        $this->namespace = $namespace;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        // Create analyzer instances
        foreach ($analyzers as $analyzerClass => $generators) {
            if (class_exists($analyzerClass)) {
                $this->analyzers[$analyzerClass] = new $analyzerClass($db);

                // Analyze to get metadata
                $this->metadata[$analyzerClass] = $this->analyzers[$analyzerClass]->analyze();

                // Validate generator classes
                foreach ($generators as $generator) {
                    if (class_exists($generator)) {
                        $this->generators[$analyzerClass][] = $generator;
                    } else {
                        throw new \Exception('Entity generator class[' . $generator . '] not found');
                    }
                }
            } else {
                throw new \Exception('Entity analyzer class['.$analyzerClass.'] not found');
            }
        }
    }

    /**
     * Analyze, generate and write class files.
     */
    public function write()
    {
        // Create module cache folder if not exists
        if (!file_exists($this->path)) {
            @mkdir($this->path, 0777, true);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }

        foreach ($this->analyzers as $analyzerClass => $analyzer) {

            // Analyze database structure and get entities metadata
            foreach ($this->metadata[$analyzerClass] as $metadata) {
                // Iterate all generators for analyzer
                foreach ($this->generators[$analyzerClass] as $generator) {
                    // TODO: Optimize generators creation by searching for existing files
                    /** @var Generic $generator Create class generator */
                    $generator = new $generator($this->codeGenerator->defNamespace($this->namespace), $metadata);

                    // Create entity generated class names
                    $file = $this->path . $generator->className . '.php';

                    // Do not generate file if its already there
                    //if (!file_exists($file)) {
                        // Create entity query class files
                        file_put_contents($file, '<?php' . $generator->generate());
                    //}

                    // Require files
                    require($file);
                }
            }
        }
    }
}
//[PHPCOMPRESSOR(remove,end)]


1		<?php
2		//[PHPCOMPRESSOR(remove,start)]
3		/**
4		* Created by Vitaly Iegorov <[email protected]>.
5		* on 25.03.16 at 12:04
6		*/
7		namespace samsoncms\api\generator;
8
9		use samsonframework\orm\DatabaseInterface;
10		use samsonphp\generator\Generator;
11
12		/**
13		* Generator classes file writer.
14		*
15		* @package samsoncms\api\generator
16		*/
17		class GenericWriter
18		{
19		/** @var \samsoncms\api\generator\analyzer\GenericAnalyzer[string] Collection of entity analyzers */
20		protected $analyzers = [];
21
22		/** @var \samsoncms\api\generator\Generic[string] Collection of entity generators */
23		protected $generators = [];
24
25		/** @var array Analyzers metadata */
26		protected $metadata = [];
27
28		/** @var Generator Code generator */
29		protected $codeGenerator;
30
31		/** @var string Path to generated entities */
32		protected $path;
33
34		/**
35		* Writer constructor.
36		*
37		* @param DatabaseInterface $db
38		* @param Generator $codeGenerator
39		* @param string $namespace
40		* @param array $analyzers Collection of analyzer class names
41		* @param string $path Path to generated entities
42		*
43		* @throws \Exception
44		*/
45		public function __construct(DatabaseInterface $db, Generator $codeGenerator, $namespace, array $analyzers, $path)
46		{
47		$this->codeGenerator = $codeGenerator;
48		$this->path = $path;
49		$this->namespace = $namespace;
		0 ignored issues – show Bug introduced 2016-03-25 15:00 UTC by Report Bug Copy Issue Report The property `namespace` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
50
51		// Create analyzer instances
52		foreach ($analyzers as $analyzerClass => $generators) {
53		if (class_exists($analyzerClass)) {
54		$this->analyzers[$analyzerClass] = new $analyzerClass($db);
55
56		// Analyze to get metadata
57		$this->metadata[$analyzerClass] = $this->analyzers[$analyzerClass]->analyze();
58
59		// Validate generator classes
60		foreach ($generators as $generator) {
61		if (class_exists($generator)) {
62		$this->generators[$analyzerClass][] = $generator;
63		} else {
64		throw new \Exception('Entity generator class[' . $generator . '] not found');
65		}
66		}
67		} else {
68		throw new \Exception('Entity analyzer class['.$analyzerClass.'] not found');
69		}
70		}
71		}
72
73		/**
74		* Analyze, generate and write class files.
75		*/
76		public function write()
77		{
78		// Create module cache folder if not exists
79		if (!file_exists($this->path)) {
80		@mkdir($this->path, 0777, true);
		0 ignored issues – show Security Best Practice introduced 2016-03-25 15:05 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
81		}
82
83	View Code Duplication	foreach ($this->analyzers as $analyzerClass => $analyzer) {
		0 ignored issues – show Duplication introduced 2016-03-31 12:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
84		// Analyze database structure and get entities metadata
85		foreach ($this->metadata[$analyzerClass] as $metadata) {
86		// Iterate all generators for analyzer
87		foreach ($this->generators[$analyzerClass] as $generator) {
88		// TODO: Optimize generators creation by searching for existing files
89		/** @var Generic $generator Create class generator */
90		$generator = new $generator($this->codeGenerator->defNamespace($this->namespace), $metadata);
91
92		// Create entity generated class names
93		$file = $this->path . $generator->className . '.php';
94
95		// Do not generate file if its already there
96		//if (!file_exists($file)) {
97		// Create entity query class files
98		file_put_contents($file, '<?php' . $generator->generate());
99		//}
100
101		// Require files
102		require($file);
103		}
104		}
105		}
106		}
107		}
108		//[PHPCOMPRESSOR(remove,end)]
109

samsoncms / api

GenericWriter A last analyzed 2016-10-05 09:42 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

GenericWriter A
last analyzed 2016-10-05 09:42 UTC