ControllerCompiler::compile() - Code Metrics - Inspection of "Atualização dos arquivos do Scaffolder" - codificar/scaffolder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 63d8d6...28be9d )

by Raphael

created 2017-03-30 19:20 UTC

ControllerCompiler::compile() A

↳ Parent: ControllerCompiler

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	10

Duplication

Lines	17
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	17
loc	17
rs	9.4286
cc	2
eloc	10
nc	2
nop	6

<?php

namespace Scaffolder\Compilers\Core;

use Illuminate\Support\Facades\File;
use Scaffolder\Compilers\AbstractCompiler;
use Scaffolder\Compilers\Support\FileToCompile;
use Scaffolder\Compilers\Support\PathParser;
use Scaffolder\Support\CamelCase;

class ControllerCompiler extends AbstractCompiler
{	

	protected $cachePrefix 	= 'controller_';
	protected $stubFilename = 'Controller/Controller.php' ;
	
	public function __construct($scaffolderConfig, $modelData = null, $stubName = null)

	{
		if ($stubName)
			$this->stubFilename = $stubName;
		$this->stubsDirectory = __DIR__ . '/../../../../stubs/Api/';
		parent::__construct($scaffolderConfig, $modelData);
	}

	/**
	 * Replace and store the Stub.
	 *
	 * @return string
	 */
	public function replaceAndStore()
	{
		
		return $this->replacePrimaryKey()
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
					->replaceEagerCode()
					->replaceUniqueRules()
					->replaceSearchConditions()
					->replaceSimpleFilter()
					->replaceSortConditions()
					->replaceRoutePrefix()
					->replaceReverseRelationships()
					->replaceCheckbox()
					->replaceEnum()
					->replaceRelationshipTables()
					->store(new FileToCompile(false, $this->modelData->modelHash));
		
	}


	/**
	 * Get output filename
	 *
	 *
	 * @return $this
	 */
	protected function getOutputFilename()
	{

		return PathParser::parse($this->scaffolderConfig->generator->paths->controllers) . $this->modelName . 'Controller.php';
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	/**
	 * Replace eager code for each foreing key with eager = true 
	 *
	 * @return $this
	 */
	private function replaceEagerCode()

	{
		$storeCommands = $updateCommands = $ruleCommands = $useCommands = '';
		$eagerConditions = $eagerJoins = '';

		$storeEagerStubOriginal = File::get($this->stubsDirectory . 'StoreEager.php');
		$updateEagerStubOriginal = File::get($this->stubsDirectory . 'UpdateEager.php');
		$rulesEagerStubOriginal = File::get($this->stubsDirectory . 'RulesEager.php');
		$useEagerStubOriginal = File::get($this->stubsDirectory . 'UseEager.php');
		$joinEagerStubOriginal = File::get($this->stubsDirectory . 'SearchConditions/JoinEager.php');

		foreach ($this->modelData->fields as $field)
		{
			
			// Check foreign key
			if ($field->foreignKey && isset($field->foreignKey->eager) && $field->foreignKey->eager)
			{

				$storeCommands 	.= str_replace('{{foreign_model_name}}', CamelCase::convertToCamelCase($field->foreignKey->table), $this->replaceForeingStrings($field, $storeEagerStubOriginal));
				$updateCommands	.= str_replace('{{foreign_model_name}}', CamelCase::convertToCamelCase($field->foreignKey->table), $this->replaceForeingStrings($field, $updateEagerStubOriginal)) ;
				$ruleCommands	.= str_replace('{{foreign_model_name}}', CamelCase::convertToCamelCase($field->foreignKey->table), $this->replaceForeingStrings($field, $rulesEagerStubOriginal)) ;
				$useCommands	.= str_replace('{{foreign_model_name}}', CamelCase::convertToCamelCase($field->foreignKey->table), $this->replaceForeingStrings($field, $useEagerStubOriginal)) ;
				$eagerJoins		.= $this->replaceForeingStrings($field, $joinEagerStubOriginal) ;

				// search eager fields
				$foreignModelData = $this->getModelData($field->foreignKey->table);
				$foreignControllerCompiler = new ControllerCompiler($this->scaffolderConfig, $foreignModelData);
				$foreignControllerCompiler->setEagerTable($this->modelData->tableName);
				$eagerConditions 	.= $foreignControllerCompiler->getSearchConditions();
				$eagerUniqueRules = $foreignControllerCompiler->getEagerUniqueRules();
				$eagerUniqueRules = str_replace("{{class_name_lw}}", strtolower($this->modelName), $eagerUniqueRules);
				$eagerUniqueRules = str_replace("{{field}}", $field->name, $eagerUniqueRules);
				$ruleCommands = str_replace('{{unique_eager_rules}}', $eagerUniqueRules, $ruleCommands) ;
			}

		}

		$this->stub = str_replace('{{store_eager_objects}}', $storeCommands, $this->stub);
		$this->stub = str_replace('{{update_eager_objects}}', $updateCommands, $this->stub);
		$this->stub = str_replace('{{rules_eager}}', $ruleCommands, $this->stub);
		$this->stub = str_replace('{{eager_use_classes}}', $useCommands, $this->stub);
		$this->stub = str_replace('{{eager_joins}}', $eagerJoins, $this->stub);
		$this->stub = str_replace('{{eager_conditions}}', $eagerConditions, $this->stub);
		$this->stub = str_replace('{{eager_table}}', $this->eagerTable, $this->stub);
		


		return $this;
	}


	public function replaceSortConditions()	{

		$joinSorts = '';

		foreach ($this->modelData->fields as $field) {
			if($field->foreignKey){
				$joinSortStub = File::get($this->stubsDirectory . 'SearchConditions/JoinSort.php');
				$joinSortStub = str_replace('{{field}}', $field->name, $joinSortStub);
				$joinSortStub = str_replace('{{foreign_table}}', $field->foreignKey->table, $joinSortStub);
				$joinSortStub = str_replace('{{foreign_key}}', $field->foreignKey->table, $joinSortStub);
				$joinSorts .= $joinSortStub;

			}
			
	
			
		}
		

		$this->stub = str_replace('{{relationship_tables_joins_sort}}', $joinSorts, $this->stub);

		return $this;
	}

	public function replaceUniqueRules() {
		$uniqueRules = '';

		foreach ($this->modelData->fields as $field) {

			if (strpos($field->validations, 'unique')) {
				$rule = sprintf('$rules["%s"] = $rules["%s"] . \',%s,\' . $id;', $field->name, $field->name, $field->name);
				$uniqueRules .= $rule . "\n";
			}
		}

		$this->stub = str_replace('{{unique_rules}}', $uniqueRules, $this->stub);

		return $this;
	}

	public function getEagerUniqueRules() {
		$uniqueRules = '';

		foreach ($this->modelData->fields as $field) {

			if (strpos($field->validations, 'unique')) {
				$rule = sprintf('$rules["%s.%s"] .= \',%s,\' . ${{class_name_lw}}->{{field}};', $this->modelData->tableName, $field->name, $field->name);
				$uniqueRules .= $rule . "\n";
			}
		}

		return $uniqueRules;
	}

	/**
	 * Replace search conditions
	 *
	 * @return $this
	 */
	private function replaceSearchConditions(){

		$searchConditions = $this->getSearchConditions();

		$this->stub = str_replace('{{conditions}}', $searchConditions, $this->stub);

		return $this;
	}

	/**
	 * get search conditions
	 *
	 * @return $this
	 */
	public function getSearchConditions(){


		$fieldConditions = '';

		$searchConditions = File::get($this->stubsDirectory . '/SearchConditions/Conditions.php');

		foreach ($this->modelData->fields as $field)
		{

			$fieldConditions .= $this->replaceFieldStrings($field, $this->getConditionStubByField($field)) ;

		}

		// replace all field conditions
		$searchConditions = str_replace('{{field_conditions}}', $fieldConditions, $searchConditions);

		// replace table name
		$searchConditions = str_replace('{{table_name}}', $this->modelData->tableName, $searchConditions);

		return $searchConditions ;

	}


	/**
	 * Replace simple filter
	 *
	 * @return $this
	 */
	private function replaceSimpleFilter(){

		$i = 0;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		$stubSimpleFilter = '';

		foreach ($this->modelData->fields as $field)
		{
			//var_dump($field->name);

			
			if($field->index == 'primary'){
				$dbType = 'primaryKey' ;
			}
			elseif($field->foreignKey){
				$dbType = 'primary' ;
			}
			elseif($field->type->db == 'enum'){
				$dbType = 'primary' ;
			}
			elseif($field->type->db == 'boolean'){
				$dbType = 'primary' ;
			}
			elseif($field->type->db == 'text'){
				$dbType = 'string' ;
			}
			else {
				$dbType = $field->type->db ;
			}
			
			if($dbType == 'primaryKey')
			{
				$stubSimpleFilter .= '$query->where("'.$this->modelData->tableName.'.'.$field->name.'", "=", $'.$this->modelData->tableName.'Conditions["'.$field->name.'"])'.PHP_EOL;
			}

			if($dbType == 'primary')
			{
				$stubSimpleFilter .= '->orWhere("'.$this->modelData->tableName.'.'.$field->name.'", "=", $'.$this->modelData->tableName.'Conditions["'.$field->name.'"])'.PHP_EOL;
			}

			if($dbType == 'string')
			{
				$stubSimpleFilter .= '->orWhere("'.$this->modelData->tableName.'.'.$field->name.'", "LIKE", "%".$'.$this->modelData->tableName.'Conditions["'.$field->name.'"]."%")'.PHP_EOL;
			}

			if($dbType == 'date' || $dbType == 'datetime' || $dbType == 'float' || $dbType == 'integer' || $dbType == 'number')
			{
				$stubSimpleFilter .= '->orWhere("'.$this->modelData->tableName.'.'.$field->name.'", "=", $'.$this->modelData->tableName.'Conditions["'.$field->name.'"])'.PHP_EOL;
			}

		}
		$stubSimpleFilter .= ';';
		$this->stub = str_replace('{{simple_filter}}', $stubSimpleFilter, $this->stub);

		return $this;
	}


	/**
	 * replace reverse relationships
	 *
	 * @return $this
	 */
	public function replaceReverseRelationships(){


		$functions = '';

		$method = File::get($this->stubsDirectory . '/Controller/ControllerReverseRelationship.php');

		foreach ($this->modelData->reverseRelationships as $relationship)
		{
			$functionName = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			if ($relationship->type == "hasOne")
				$functionName = strtolower($relationship->modelName);
			elseif ($relationship->type == "belongsToMany") 
				$functionName = CamelCase::pluralize(strtolower($relationship->relatedTable));
			else 
				$functionName = CamelCase::pluralize(strtolower($relationship->modelName));

			$replacedMethod = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$replacedMethod = str_replace('{{function_name}}', $functionName, $method);
			$replacedMethod = str_replace('{{class_name_lw}}', $this->modelData->tableName, $replacedMethod);
			$replacedMethod = str_replace('{{class_name}}', ucwords($this->modelData->tableName), $replacedMethod);

			$functions .= $replacedMethod;
		}

		$this->stub = str_replace('{{reverseRelationships}}', $functions, $this->stub);

		return $this;

	}

	/**
	 * replace enum fields
	 *
	 * @return $this
	 */
	public function replaceEnum(){


		$functions = '';

		$method = File::get($this->stubsDirectory . '/Controller/ControllerEnum.php');

		foreach ($this->modelData->fields as $field)
		{
			if ($field->type->db == "enum") {
				$replacedMethod = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
				$replacedMethod = str_replace('{{field_name_uc}}', CamelCase::convertToCamelCase($field->name), $method);	
				$replacedMethod = str_replace('{{field_name}}', $field->name, $replacedMethod);
				$replacedMethod = str_replace('{{model_name}}', $this->modelData->modelName, $replacedMethod);
				
				$functions .= $replacedMethod;
			}
		}

		$this->stub = str_replace('{{enum}}', $functions, $this->stub);

		return $this;

	}

	/**
	 * replace relationship tables
	 *
	 * @return $this
	 */
	public function replaceRelationshipTables() {


		$functions = "";
		$functionsCall = "";
		$removeAll = "";
		$removeAllCall = "";
		$includes = "";
		$joins = "";
		$joinSorts = "";
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		$method = File::get($this->stubsDirectory . '/Controller/ControllerRelationshipTable.php');

		foreach ($this->modelData->reverseRelationships as $relationship) {

			if ($relationship->type == "belongsToMany") {
				$relatedTablePluralized = CamelCase::pluralize($relationship->relatedTable);
				$relatedTablePluralizedUc = CamelCase::pluralize(CamelCase::convertToCamelCase($relationship->relatedTable));

				$replacedMethod = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
				$replacedMethod = str_replace('{{related_table_pl_uc}}', $relatedTablePluralizedUc, $method);
				$replacedMethod = str_replace('{{class_name_lw}}', $this->modelData->tableName, $replacedMethod);
				$replacedMethod = str_replace('{{related_table_pl}}', $relatedTablePluralized, $replacedMethod);
				$replacedMethod = str_replace('{{foreign_key}}', $relationship->foreignKey, $replacedMethod);
				$replacedMethod = str_replace('{{related_field}}', $relationship->relatedField, $replacedMethod);
				$replacedMethod = str_replace('{{foreign_table_lw}}', strtolower($relationship->modelName), $replacedMethod);
				$replacedMethod = str_replace('{{foreign_table}}', $relationship->modelName, $replacedMethod);

				$functions .= $replacedMethod;

				$methodCall = 'if (array_key_exists(\'{{related_table_pl}}\', $vars))';
				$methodCall .= "\n\t\t\t";
				$methodCall .= '$this->save{{related_table_pl_uc}}($vars, ${{class_name_lw}});';
				$methodCall = str_replace('{{related_table_pl_uc}}', $relatedTablePluralizedUc, $methodCall);
				$methodCall = str_replace('{{related_table_pl}}', $relatedTablePluralized, $methodCall);
				$methodCall = str_replace('{{class_name_lw}}', $this->modelData->tableName, $methodCall);

				$functionsCall .= $methodCall . "\n\t\t";
				
				$removeAllMethod = File::get($this->stubsDirectory . '/Controller/ControllerRemoveAll.php');
				$removeAllMethod = str_replace('{{related_table_pl_uc}}', $relatedTablePluralizedUc, $removeAllMethod);
				$removeAllMethod = str_replace('{{foreign_key}}', $relationship->foreignKey, $removeAllMethod);
				$removeAllMethod = str_replace('{{foreign_table}}', $relationship->modelName, $removeAllMethod);
				$removeAllMethod = str_replace('{{foreign_table_lw_pl}}', CamelCase::pluralize(strtolower($relationship->modelName)), $removeAllMethod);
				
				$removeAll .= $removeAllMethod;

				$removeAllCallMethod = '$this->deleteAll{{related_table_pl_uc}}(${{class_name_lw}}[\'id\']);';
				$removeAllCallMethod = str_replace('{{related_table_pl_uc}}', $relatedTablePluralizedUc, $removeAllCallMethod);
				$removeAllCallMethod = str_replace('{{class_name_lw}}', $this->modelData->tableName, $removeAllCallMethod);
				
				$removeAllCall .= $removeAllCallMethod . "\n\t\t";

				$joinRelationshipTableStub = File::get($this->stubsDirectory . 'SearchConditions/joinRelationshipTable.php');
				$joinRelationshipTableStub = str_replace('{{class_name_lw}}', $this->modelData->tableName, $joinRelationshipTableStub);
				$joinRelationshipTableStub = str_replace('{{related_table_pl}}', $relatedTablePluralized, $joinRelationshipTableStub);
				$joinRelationshipTableStub = str_replace('{{related_table}}', CamelCase::convertToCamelCase($relationship->relatedTable), $joinRelationshipTableStub);
				$joinRelationshipTableStub = str_replace('{{foreign_key}}', $relationship->foreignKey, $joinRelationshipTableStub);
				$joinRelationshipTableStub = str_replace('{{related_field}}', $relationship->relatedField, $joinRelationshipTableStub);
				$joinRelationshipTableStub = str_replace('{{foreign_table}}', $relationship->tableName, $joinRelationshipTableStub);

				$joins .= $joinRelationshipTableStub . "\n";

				$use = 'use App\Models\{{foreign_table}};';
				$use = str_replace('{{foreign_table}}', $relationship->modelName, $use);

				$includes .= $use . "\n";
			}
		}

		$this->stub = str_replace('{{relationship_tables_store}}', $functions, $this->stub);

		$this->stub = str_replace('{{relationship_tables_call}}', $functionsCall, $this->stub);

		$this->stub = str_replace('{{remove_relationship_objects}}', $removeAll, $this->stub);

		$this->stub = str_replace('{{remove_relationship_objects_call}}', $removeAllCall, $this->stub);

		$this->stub = str_replace('{{relationship_tables_classes}}', $includes, $this->stub);

		$this->stub = str_replace('{{relationship_tables_joins}}', $joins, $this->stub);

		
		
		return $this;

	}


	/**
	 * replace checkbox fields
	 *
	 * @return $this
	 */
	public function replaceCheckbox(){


		$method = File::get($this->stubsDirectory . '/Controller/ControllerCheckbox.php');
		$key = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		$method = str_replace('{{class_name_lw}}', $this->modelData->tableName, $method);
		$method = str_replace('{{class_name}}', ucwords($this->modelData->tableName), $method);
		$method = str_replace('{{model_name}}', $this->modelData->modelName, $method);
		$this->stub = str_replace('{{checkbox}}', $method, $this->stub);

		/*foreach ($this->modelData->fields as $field)

		{
			if ($field->type->ui == "checkbox") {
				
				$method = str_replace('{{class_name_lw}}', $this->modelData->tableName, $method);
				$method = str_replace('{{class_name}}', ucwords($this->modelData->tableName), $method);

				$this->stub = str_replace('{{checkbox}}', $method, $this->stub);



				$key = true;
			}
		}

		if(!$key)
		{
			$this->stub = str_replace('{{checkbox}}', ' ', $this->stub);
		}*/
		

		return $this;

	}


	/**
	 * get search conditions stub by db type
	 *
	 * @param string $field
	 *
	 * @return $this
	 */
	private $conditionsStub = [];
	private function getConditionStubByField($field){

		
		if($field->index == 'primary'){
			$dbType = 'primary' ;
		}
		elseif($field->foreignKey){
			$dbType = 'primary' ;
		}
		elseif($field->type->db == 'enum'){
			$dbType = 'primary' ;
		}
		elseif($field->type->db == 'boolean'){
			$dbType = 'primary' ;
		}
		elseif($field->type->db == 'text'){
			$dbType = 'string' ;
		}
		else {
			$dbType = $field->type->db ;
		}

		if(array_key_exists($dbType, $this->conditionsStub)){
			return $this->conditionsStub[$dbType];
		}
		else {
			$this->conditionsStub[$dbType] = File::get($this->stubsDirectory . 'SearchConditions/'. ucwords($dbType). '.php');;

			return $this->conditionsStub[$dbType];
		}
	}
	


}

1		<?php
2
3		namespace Scaffolder\Compilers\Core;
4
5		use Illuminate\Support\Facades\File;
6		use Scaffolder\Compilers\AbstractCompiler;
7		use Scaffolder\Compilers\Support\FileToCompile;
8		use Scaffolder\Compilers\Support\PathParser;
9		use Scaffolder\Support\CamelCase;
10
11		class ControllerCompiler extends AbstractCompiler
12		{
		0 ignored issues – show Coding Style introduced 2017-03-30 19:31 UTC by Report Bug Copy Issue Report The opening class brace should be on a newline by itself. Loading history...
13		protected $cachePrefix = 'controller_';
14		protected $stubFilename = 'Controller/Controller.php' ;
15
16	View Code Duplication	public function __construct($scaffolderConfig, $modelData = null, $stubName = null)
		0 ignored issues – show Duplication introduced 2017-03-30 19:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
17		{
18		if ($stubName)
19		$this->stubFilename = $stubName;
20		$this->stubsDirectory = __DIR__ . '/../../../../stubs/Api/';
21		parent::__construct($scaffolderConfig, $modelData);
22		}
23
24		/**
25		* Replace and store the Stub.
26		*
27		* @return string
28		*/
29		public function replaceAndStore()
30		{
31
32		return $this->replacePrimaryKey()
		0 ignored issues – show Bug Best Practice introduced 2017-03-30 19:31 UTC by Report Bug Copy Issue Report The return type of `return $this->replacePri...modelData->modelHash));` (`Scaffolder\Compilers\Core\ControllerCompiler`) is incompatible with the return type declared by the abstract method `Scaffolder\Compilers\Abs...mpiler::replaceAndStore` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
33		->replaceEagerCode()
34		->replaceUniqueRules()
35		->replaceSearchConditions()
36		->replaceSimpleFilter()
37		->replaceSortConditions()

codificar / scaffolder

Push — master ( 63d8d6...28be9d )

ControllerCompiler::compile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like