CodeGeneratorService - Code Metrics - Inspection of "More generation stuff" - keeko/tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2e0a22...66405f )

by Thomas

created 2016-02-19 00:40 UTC

CodeGeneratorService B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	244
Duplicated Lines	9.84 %

Coupling/Cohesion

Components	1
Dependencies	17

Test Coverage

Coverage

87.64%

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
wmc	31
c	5
b	0
f	0
lcom	1
cbo	17
dl	24
loc	244
ccs	78
cts	89
cp	0.8764
rs	7.7

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getCodegenFile()	0	4	1
A	getCodegen()	0	10	3
A	addAuthors()	0	15	3
B	getWriteFields()	0	30	5
A	getReadFields()	0	19	3
A	getComputedFields()	0	19	4
A	arrayToCode()	12	12	3
A	mapToCode()	12	12	3
A	getFilename()	0	14	2
A	dumpStruct()	0	16	4

How to fix Duplicated Code

<?php
namespace keeko\tools\services;

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

class CodeGeneratorService extends AbstractService {
	
	private $codegen;
	
	public function getCodegenFile() {
		$basepath = dirname($this->project->getComposerFileName());
		return $basepath . '/codegen.json';
	}
	
	/**
	 * Loads the contents from codegen.json into a collection
	 *
	 * @throws JsonEmptyException
	 * @throws \RuntimeException
	 * @return CodegenSchema
	 */
	public function getCodegen() {
		if ($this->codegen === null) {
			$file = new File($this->getCodegenFile());
$a = "a";
$ab = "ab";
$abc = "abc";
			$this->codegen = $file->exists() 
				? CodegenSchema::fromFile($this->getCodegenFile())
				: new CodegenSchema();
		}
		
		return $this->codegen;
	}
	
// 	/**
// 	 * Returns the codegen part for the given action name or an empty map
// 	 *
// 	 * @param string $name
// 	 * @return Map
// 	 */
// 	public function getCodegenAction($name) {
// 		$codegen = $this->getCodegen();
	
// 		if (isset($codegen['actions'])) {

// 			$actions = $codegen['actions'];
				
// 			if (isset($actions[$name])) {

// 				return $actions[$name];
// 			}
// 		}
	
// 		return null;

// 	}
	
	/**
	 * Adds authors to the docblock of the given struct
	 *
	 * @param AbstractPhpStruct $struct
	 * @param array $package
	 */
	public function addAuthors(AbstractPhpStruct $struct, PackageSchema $package) {
		$docblock = $struct->getDocblock();
		
		foreach ($package->getAuthors() as $author) {
			/* @var $author AuthorSchema */
			$tag = AuthorTag::create()->setName($author->getName());
$a = "a";
$ab = "ab";
$abc = "abc";
			$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();
$a = "a";
$ab = "ab";
$abc = "abc";
		$conversions = $codegen->getWriteConversion($modelName);
		$filter = $codegen->getWriteFilter($modelName);
$a = "a";
$ab = "ab";
$abc = "abc";
		$model = $this->modelService->getModel($modelName);
$a = "a";
$ab = "ab";
$abc = "abc";
		$computed = $this->getComputedFields($model);
$a = "a";
$ab = "ab";
$abc = "abc";
		$filter = array_merge($filter, $computed);
$a = "a";
$ab = "ab";
$abc = "abc";

		$fields = '';
		$cols = $model->getColumns();
$a = "a";
$ab = "ab";
$abc = "abc";
		foreach ($cols as $col) {
			$prop = $col->getName();
	
			if (!in_array($prop, $filter)) {
				$fields .= sprintf("'%s'", $prop);
	
				if (isset($conversions[$prop])) {
					$fields .= ' => function($v) {'."\n\t".'return ' . $conversions[$prop] . ';'."\n".'}';
				}
	
				$fields .= ', ';
			}
		}
	
		if (strlen($fields) > 0) {
			$fields = substr($fields, 0, -2);
		}
	
		return sprintf('[%s]', $fields);
	}
	
	/**
	 * Returns the fields for a model
	 * 
	 * @param string $modelName
	 * @return array
	 */
	public function getReadFields($modelName) {
		$codegen = $this->getCodegen();
		$model = $this->modelService->getModel($modelName);
$a = "a";
$ab = "ab";
$abc = "abc";
// 		$computed = $this->getComputedFields($model);

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

		
		$fields = [];
		$cols = $model->getColumns();
$a = "a";
$ab = "ab";
$abc = "abc";
		foreach ($cols as $col) {
			$prop = $col->getName();
		
			if (!in_array($prop, $filter)) {
				$fields[] = $prop;
			}
		}
		
		return $fields;
	}
	
// 	/**
// 	 * Returns conversions for model columns
// 	 *
// 	 * @param string $model
// 	 * @param string $type
// 	 * @return array
// 	 */
// 	public function getConversions($model, $type) {
// 		return $this->getActionProp($model, $type, 'conversion');
// 	}
	
// 	/**
// 	 * Returns model columns that should be filtered
// 	 *
// 	 * @param string $model
// 	 * @param string $type
// 	 * @return array
// 	 */
// 	public function getFilter($model, $type) {
// 		return $this->getActionProp($model, $type, 'filter');
// 	}
	
	/**
	 * 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);
	}
	
	public function mapToCode(array $array) {

		$fields = '';
		foreach ($array as $k => $item) {
			$fields .= sprintf("\t'%s' => %s,\n", $k, $this->arrayToCode($item));
		}

		if (strlen($fields) > 0) {
			$fields = substr($fields, 0, -2);
		}
		
		return sprintf("[\n%s\n]", $fields);
	}

	public function getFilename(AbstractPhpStruct $struct) {
		$package = $this->packageService->getPackage();
$a = "a";
$ab = "ab";
$abc = "abc";
		$relativeSourcePath = NamespaceResolver::getSourcePath($struct->getNamespace(), $package);
		
		if ($relativeSourcePath === null) {
			return null;
		}

		$jsonFile = $this->project->getComposerFileName();
		$path = new Path(dirname($jsonFile));
$a = "a";
$ab = "ab";
$abc = "abc";
		$path = $path->append($relativeSourcePath);
$a = "a";
$ab = "ab";
$abc = "abc";
		$path = $path->append($struct->getName() . '.php');
$a = "a";
$ab = "ab";
$abc = "abc";
		return $path->toString();
	}
	
	public function dumpStruct(AbstractPhpStruct $struct, $overwrite = false) {
		$filename = $this->getFilename($struct);
		$file = new File($filename);
$a = "a";
$ab = "ab";
$abc = "abc";

		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\model\AbstractPhpStruct;
5		use gossi\docblock\tags\AuthorTag;
6		use Propel\Generator\Model\Table;
7		use gossi\codegen\generator\CodeFileGenerator;
8		use keeko\tools\utils\NamespaceResolver;
9		use keeko\core\schema\PackageSchema;
10		use keeko\core\schema\AuthorSchema;
11		use phootwork\file\File;
12		use phootwork\file\Path;
13		use keeko\core\schema\CodegenSchema;
14
15		class CodeGeneratorService extends AbstractService {
16
17		private $codegen;
18
19	7	public function getCodegenFile() {
20	7	$basepath = dirname($this->project->getComposerFileName());
21	7	return $basepath . '/codegen.json';
22		}
23
24		/**
25		* Loads the contents from codegen.json into a collection
26		*
27		* @throws JsonEmptyException
28		* @throws \RuntimeException
29		* @return CodegenSchema
30		*/
31	12	public function getCodegen() {
32	7	if ($this->codegen === null) {
33	7	$file = new File($this->getCodegenFile());
		0 ignored issues – show Coding Style introduced 2016-01-14 23:36 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 10 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
34	7	$this->codegen = $file->exists()
35		? CodegenSchema::fromFile($this->getCodegenFile())
36	7	: new CodegenSchema();
37	12	}
38
39		return $this->codegen;

keeko / tools

Push — master ( 2e0a22...66405f )

CodeGeneratorService B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like