CodeGeneratorService::getReadFields() - Code Metrics - Inspection of "Using NameGenerators now." - keeko/tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d6c5c0...118f52 )

by Thomas

created 2016-05-27 21:10 UTC

CodeGeneratorService::getReadFields() B

↳ Parent: CodeGeneratorService

Complexity

Conditions	5
Paths	3

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	5.0073

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	19
ccs	14
cts	15
cp	0.9333
rs	8.8571
cc	5
eloc	11
nc	3
nop	1
crap	5.0073

<?php
namespace keeko\tools\services;

use gossi\codegen\generator\CodeFileGenerator;
use gossi\codegen\model\AbstractPhpStruct;
use gossi\docblock\tags\AuthorTag;
use keeko\framework\schema\CodegenSchema;
use keeko\framework\schema\PackageSchema;
use keeko\tools\utils\NamespaceResolver;
use phootwork\file\File;
use phootwork\file\Path;
use Propel\Generator\Model\Table;

class CodeGeneratorService extends AbstractService {
	
	private $codegen;

	
	public function getCodegenFile() {
		return $this->project->getCodegenFileName();
	}
	
	/**
	 * Returns codegen from project
	 *
	 * @throws JsonEmptyException
	 * @throws \RuntimeException
	 * @return CodegenSchema
	 */
	public function getCodegen() {
		return $this->project->getCodegen();
	}
	
	/**
	 * Adds authors to the docblock of the given struct
	 *
	 * @param AbstractPhpStruct $struct
	 * @param PackageSchema $package
	 */
	public function addAuthors(AbstractPhpStruct $struct, PackageSchema $package = null) {
		if ($package === null) {
			$package = $this->packageService->getPackage();
		}
		$docblock = $struct->getDocblock();
		
		foreach ($package->getAuthors() as $author) {
			/* @var $author AuthorSchema */
			$tag = AuthorTag::create()->setName($author->getName());
			$mail = $author->getEmail();

			if (!empty($mail)) {
				$tag->setEmail($mail);
			}

			$docblock->appendTag($tag);
		}
	}

	/**
	 * Returns code for hydrating a propel model
	 *
	 * @param string $modelName
	 * @return string
	 */
	public function getWriteFields($modelName) {
		$codegen = $this->getCodegen();
		$filter = $codegen->getWriteFilter($modelName);
		$model = $this->modelService->getModel($modelName);
		$computed = $this->getComputedFields($model);
		$filter = array_merge($filter, $computed);

		$fields = [];
		$cols = $model->getColumns();
		foreach ($cols as $col) {
			$prop = $col->getName();
	
			if (!in_array($prop, $filter)) {
				$fields[] = $prop;
			}
		}
	
		return $fields;
	}
	
	/**
	 * Returns the fields for a model
	 * 
	 * @param string $modelName
	 * @return array
	 */
	public function getReadFields($modelName) {
		$codegen = $this->getCodegen();
		$model = $this->modelService->getModel($modelName);
// 		$computed = $this->getComputedFields($model);

		$filter = $codegen->getReadFilter($modelName);
// 		$filter = array_merge($filter, $computed);

		
		$fields = [];
		$cols = $model->getColumns();
		foreach ($cols as $col) {
			$prop = $col->getName();
		
			if (!in_array($prop, $filter) && !$col->isForeignKey() && !$col->isPrimaryKey()) {
				$fields[] = $prop;
			}
		}
		
		return $fields;
	}
	
	/**
	 * Returns computed model fields
	 *
	 * @param Table $table
	 * @return array<string>
	 */
	public function getComputedFields(Table $table) {
		$fields = [];
	
		// iterate over behaviors to get their respective columns
		foreach ($table->getBehaviors() as $behavior) {
			switch ($behavior->getName()) {
				case 'timestampable':
					$fields[] = $behavior->getParameter('create_column');
					$fields[] = $behavior->getParameter('update_column');
					break;
	
				case 'aggregate_column':
					$fields[] = $behavior->getParameter('name');
					break;
			}
		}
	
		return $fields;
	}
	
	/**
	 * Helper to represent an array as php code
	 *
	 * @param array $array
	 * @return string
	 */
	public function arrayToCode(array $array) {
		$fields = '';
		foreach ($array as $item) {
			$fields .= sprintf("'%s', ", $item);
		}
	
		if (strlen($fields) > 0) {
			$fields = substr($fields, 0, -2);
		}
	
		return sprintf('[%s]', $fields);
	}

	/**
	 * Returns the filename for a given struct
	 * 
	 * @param AbstractPhpStruct $struct
	 * @return string
	 */
	public function getFilename(AbstractPhpStruct $struct) {
		$package = $this->packageService->getPackage();
		$relativeSourcePath = NamespaceResolver::getSourcePath($struct->getNamespace(), $package);
		
		if ($relativeSourcePath === null) {
			return null;
		}

		$jsonFile = $this->project->getComposerFileName();
		$path = new Path(dirname($jsonFile));
		$path = $path->append($relativeSourcePath);
		$path = $path->append($struct->getName() . '.php');
		return $path->toString();
	}
	
	/**
	 * Returns a file object for a given struct
	 * 
	 * @param AbstractPhpStruct $struct
	 * @return File
	 */
	public function getFile(AbstractPhpStruct $struct) {
		return new File($this->getFilename($struct));
	}
	
	public function dumpStruct(AbstractPhpStruct $struct, $overwrite = false) {
		$filename = $this->getFilename($struct);
		$file = new File($filename);

		if ($filename !== null && ($file->exists() ? $overwrite : true)) {
			// generate code
			$generator = new CodeFileGenerator();
			$code = $generator->generate($struct);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

			// write code to file
			$file->write($code);
			
			// tell user about
			$this->io->writeln(sprintf('Class <info>%s</info> written at <info>%s</info>', $struct->getQualifiedName(), $filename));
		}
	}
}


1		<?php
2		namespace keeko\tools\services;
3
4		use gossi\codegen\generator\CodeFileGenerator;
5		use gossi\codegen\model\AbstractPhpStruct;
6		use gossi\docblock\tags\AuthorTag;
7		use keeko\framework\schema\CodegenSchema;
8		use keeko\framework\schema\PackageSchema;
9		use keeko\tools\utils\NamespaceResolver;
10		use phootwork\file\File;
11		use phootwork\file\Path;
12		use Propel\Generator\Model\Table;
13
14		class CodeGeneratorService extends AbstractService {
15
16		private $codegen;
		0 ignored issues – show Unused Code introduced 2016-05-19 15:23 UTC by Report Bug Copy Issue Report The property `$codegen` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
17
18		public function getCodegenFile() {
19	7	return $this->project->getCodegenFileName();
20	7	}
21	7
22		/**
23		* Returns codegen from project
24		*
25		* @throws JsonEmptyException
26		* @throws \RuntimeException
27		* @return CodegenSchema
28		*/
29		public function getCodegen() {
30		return $this->project->getCodegen();
31	12	}
32	7
33	7	/**
34	7	* Adds authors to the docblock of the given struct
35		*
36	7	* @param AbstractPhpStruct $struct
37	12	* @param PackageSchema $package
38		*/
39		public function addAuthors(AbstractPhpStruct $struct, PackageSchema $package = null) {
40		if ($package === null) {
41		$package = $this->packageService->getPackage();
42		}
43		$docblock = $struct->getDocblock();
44
45		foreach ($package->getAuthors() as $author) {
46		/* @var $author AuthorSchema */
47		$tag = AuthorTag::create()->setName($author->getName());
48		$mail = $author->getEmail();
49
50		if (!empty($mail)) {
51		$tag->setEmail($mail);
52		}
53
54		$docblock->appendTag($tag);
55		}
56		}
57
58		/**
59		* Returns code for hydrating a propel model
60		*
61		* @param string $modelName
62		* @return string
63		*/
64		public function getWriteFields($modelName) {
65	15	$codegen = $this->getCodegen();
66	15	$filter = $codegen->getWriteFilter($modelName);
67		$model = $this->modelService->getModel($modelName);
68	15	$computed = $this->getComputedFields($model);
69		$filter = array_merge($filter, $computed);
70
71	15	$fields = [];
72	15	$cols = $model->getColumns();
73	15	foreach ($cols as $col) {
74		$prop = $col->getName();
75	15
76		if (!in_array($prop, $filter)) {
77	15	$fields[] = $prop;
78		}
79		}
80
81	15	return $fields;
82	15	}
83	15
84		/**
85		* Returns the fields for a model
86		*
87		* @param string $modelName
88		* @return array
89		*/
90		public function getReadFields($modelName) {
91	5	$codegen = $this->getCodegen();
92	5	$model = $this->modelService->getModel($modelName);
93	5	// $computed = $this->getComputedFields($model);
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-19 00:45 UTC by Report Bug Copy Issue Report `59%` 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...
94	5	$filter = $codegen->getReadFilter($modelName);
95	5	// $filter = array_merge($filter, $computed);
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-19 00:45 UTC by Report Bug Copy Issue Report `54%` 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...
96	5
97	5	$fields = [];
98		$cols = $model->getColumns();
99	5	foreach ($cols as $col) {
100	5	$prop = $col->getName();
101	5
102	5	if (!in_array($prop, $filter) && !$col->isForeignKey() && !$col->isPrimaryKey()) {
103		$fields[] = $prop;
104	5	}
105	5	}
106
107	5	return $fields;
108		}
109
110		/**
111	5	* Returns computed model fields
112	5	*
113	5	* @param Table $table
114		* @return array<string>
115	5	*/
116	5	public function getComputedFields(Table $table) {
117	5	$fields = [];
118
119	5	// iterate over behaviors to get their respective columns
120		foreach ($table->getBehaviors() as $behavior) {
121		switch ($behavior->getName()) {
122		case 'timestampable':
123		$fields[] = $behavior->getParameter('create_column');
124		$fields[] = $behavior->getParameter('update_column');
125		break;
126
127		case 'aggregate_column':
128		$fields[] = $behavior->getParameter('name');
129		break;
130		}
131		}
132
133		return $fields;
134		}
135
136		/**
137		* Helper to represent an array as php code
138		*
139		* @param array $array
140		* @return string
141		*/
142		public function arrayToCode(array $array) {
143		$fields = '';
144		foreach ($array as $item) {
145		$fields .= sprintf("'%s', ", $item);
146		}
147
148		if (strlen($fields) > 0) {
149		$fields = substr($fields, 0, -2);
150	5	}
151	5
152		return sprintf('[%s]', $fields);
153		}
154	5
155	5	/**
156	5	* Returns the filename for a given struct
157	5	*
158	5	* @param AbstractPhpStruct $struct
159	5	* @return string
160		*/
161	5	public function getFilename(AbstractPhpStruct $struct) {
162		$package = $this->packageService->getPackage();
163		$relativeSourcePath = NamespaceResolver::getSourcePath($struct->getNamespace(), $package);
164	5
165	5	if ($relativeSourcePath === null) {
166		return null;
167	5	}
168
169		$jsonFile = $this->project->getComposerFileName();
170		$path = new Path(dirname($jsonFile));
171		$path = $path->append($relativeSourcePath);
172		$path = $path->append($struct->getName() . '.php');
173		return $path->toString();
174		}
175
176	2	/**
177	2	* Returns a file object for a given struct
178	2	*
179		* @param AbstractPhpStruct $struct
180	2	* @return File
181		*/
182	2	public function getFile(AbstractPhpStruct $struct) {
183		return new File($this->getFilename($struct));
184		}
185
186	2	public function dumpStruct(AbstractPhpStruct $struct, $overwrite = false) {
187		$filename = $this->getFilename($struct);
188		$file = new File($filename);
189	15
190	15	if ($filename !== null && ($file->exists() ? $overwrite : true)) {
191	15	// generate code
192		$generator = new CodeFileGenerator();
193	15	$code = $generator->generate($struct);
		0 ignored issues – show Documentation introduced 2015-11-25 17:44 UTC by Report Bug Copy Issue Report `$struct` is of type `object<gossi\codegen\model\AbstractPhpStruct>`, but the function expects a `object<gossi\codegen\model\GenerateableInterface>`. 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...
194
195		// write code to file
196		$file->write($code);
197	15
198	15	// tell user about
199	15	$this->io->writeln(sprintf('Class <info>%s</info> written at <info>%s</info>', $struct->getQualifiedName(), $filename));
200	15	}
201	15	}
202		}
203

keeko / tools

Push — master ( d6c5c0...118f52 )

CodeGeneratorService::getReadFields() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like