ModelDomainTraitGenerator::generateNormalize() - Code Metrics - Inspection of "Bugfixes for code generation" - keeko/tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( dae493...440cc5 )

by Thomas
created 2016-07-21 16:57 UTC
ModelDomainTraitGenerator::generateNormalize() B

↳ Parent: ModelDomainTraitGenerator
Complexity

Conditions	5
Paths	2
Size

Total Lines	33
Code Lines	22
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
c	1
b	0
f	0
dl	0
loc	33
rs	8.439
cc	5
eloc	22
nc	2
nop	2
<?php
namespace keeko\tools\generator\domain\base;

use gossi\codegen\model\PhpClass;
use gossi\codegen\model\PhpMethod;
use gossi\codegen\model\PhpParameter;
use gossi\codegen\model\PhpProperty;
use gossi\codegen\model\PhpTrait;
use keeko\framework\utils\NameUtils;
use keeko\tools\model\Relationship;
use Propel\Generator\Model\Table;
use keeko\tools\model\ManyToManyRelationship;
use keeko\tools\model\OneToManyRelationship;
use phootwork\lang\Text;

class ModelDomainTraitGenerator extends ReadOnlyModelDomainTraitGenerator {

	public function generate(Table $model) {
		$trait = parent::generate($model);

		// generate event
		$event = $this->generateEvent($model);
		$trait->addUseStatement($event->getQualifiedName());
		$this->generateDispatch($trait, $model);

		// generate CUD methods
		$this->generateNormalize($trait, $model);
		$this->generateCreate($trait, $model);
		$this->generateUpdate($trait, $model);
		$this->generateDelete($trait, $model);

		// generate relationship methods
		if (!$model->isReadOnly()) {
			$relationships = $this->modelService->getRelationships($model);

			foreach ($relationships->getAll() as $relationship) {
				switch ($relationship->getType()) {
					case Relationship::ONE_TO_ONE:
						$this->generateToOneRelationshipSet($trait, $relationship);
						break;

					case Relationship::ONE_TO_MANY:
						$this->generateToManyRelationshipAdd($trait, $relationship);
						$this->generateToManyRelationshipRemove($trait, $relationship);
						$this->generateOneToManyRelationshipUpdate($trait, $relationship);
						break;

					case Relationship::MANY_TO_MANY:
						$this->generateToManyRelationshipAdd($trait, $relationship);
						$this->generateToManyRelationshipRemove($trait, $relationship);
						$this->generateManyToManyRelationshipUpdate($trait, $relationship);
						break;
				}
			}
		}

		return $trait;
	}

	/**
	 *
	 * @param Table $model
	 * @return PhpClass
	 */
	protected function generateEvent(Table $model) {
		$package = $this->packageService->getPackage();
		$slug = $package->getKeeko()->getModule()->getSlug();
		$modelName = $model->getOriginCommonName();

		$class = new PhpClass();
		$class->setNamespace(str_replace('model', 'event', $model->getNamespace()));
		$class->setName($model->getPhpName() . 'Event');
		$class->setParentClassName('Event');
		if ($model->getPhpName() == 'Event') {
			$class->addUseStatement($model->getNamespace() . '\\' . $model->getPhpName(), 'Model');
		} else {
			$class->addUseStatement($model->getNamespace() . '\\' . $model->getPhpName());
		}
		$class->addUseStatement('Symfony\Component\EventDispatcher\Event');

		// constants
		$class->setConstant('PRE_CREATE', sprintf('%s.%s.pre_create', $slug, $modelName));
		$class->setConstant('POST_CREATE', sprintf('%s.%s.post_create', $slug, $modelName));
		$class->setConstant('PRE_UPDATE', sprintf('%s.%s.pre_update', $slug, $modelName));
		$class->setConstant('POST_UPDATE', sprintf('%s.%s.post_update', $slug, $modelName));
		$class->setConstant('PRE_SAVE', sprintf('%s.%s.pre_save', $slug, $modelName));
		$class->setConstant('POST_SAVE', sprintf('%s.%s.post_save', $slug, $modelName));
		$class->setConstant('PRE_DELETE', sprintf('%s.%s.pre_delete', $slug, $modelName));
		$class->setConstant('POST_DELETE', sprintf('%s.%s.post_delete', $slug, $modelName));

		// generate relationship constants
		if (!$model->isReadOnly()) {
			$relationships = $this->modelService->getRelationships($model);

			foreach ($relationships->getAll() as $relationship) {
				// one-to-one relationships
				if ($relationship->getType() == Relationship::ONE_TO_ONE) {
					$snake = NameUtils::toSnakeCase($relationship->getRelatedName());
					$name = strtoupper($snake);
					$class->setConstant('PRE_' . $name . '_UPDATE', sprintf('%s.%s.pre_%s_update', $slug, $modelName, $snake));
					$class->setConstant('POST_' . $name . '_UPDATE', sprintf('%s.%s.post_%s_update', $slug, $modelName, $snake));
				}

				// others
				else {
					$snake = NameUtils::toSnakeCase($relationship->getRelatedPluralName());
					$name = strtoupper($snake);
					$class->setConstant('PRE_' . $name . '_ADD', sprintf('%s.%s.pre_%s_add', $slug, $modelName, $snake));
					$class->setConstant('POST_' . $name . '_ADD', sprintf('%s.%s.post_%s_add', $slug, $modelName, $snake));
					$class->setConstant('PRE_' . $name . '_REMOVE', sprintf('%s.%s.pre_%s_add', $slug, $modelName, $snake));
					$class->setConstant('POST_' . $name . '_REMOVE', sprintf('%s.%s.post_%s_add', $slug, $modelName, $snake));
					$class->setConstant('PRE_' . $name . '_UPDATE', sprintf('%s.%s.pre_%s_update', $slug, $modelName, $snake));
					$class->setConstant('POST_' . $name . '_UPDATE', sprintf('%s.%s.post_%s_update', $slug, $modelName, $snake));
				}
			}
		}

		// properties
		$modelVariableName = $model->getCamelCaseName();
		$class->setProperty(PhpProperty::create($modelVariableName)
			->setType($model->getPackage())
			->setVisibility(PhpProperty::VISIBILITY_PROTECTED)
		);

		// constructor
		$type = $model->getPhpName() == 'Event' ? 'Model' : $model->getPhpName();
		$class->setMethod(PhpMethod::create('__construct')
			->addParameter(PhpParameter::create($modelVariableName)->setType($type))
			->setBody('$this->' . $modelVariableName . ' = $' . $modelVariableName .';')
		);

		// getModel()
		$class->setMethod(PhpMethod::create('get' . $model->getPhpName())
			->setType($model->getPhpName())
			->setBody('return $this->' . $modelVariableName .';')
		);

		$this->codeService->dumpStruct($class, true);

		return $class;
	}

	protected function generateDispatch(PhpTrait $trait, Table $model) {
		$trait->setMethod(PhpMethod::create('dispatch')
			->addParameter(PhpParameter::create('type')
				->setType('string')
			)
			->addParameter(PhpParameter::create('model')
				->setType($model->getPhpName())
			)
			->addParameter(PhpParameter::create('data')
				->setType('array')
				->setExpression('[]')
			)
			->setBody($this->twig->render('dispatch.twig', [
				'class' => $model->getPhpName()
			]))
			->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
		);
	}

	protected function generateNormalize(PhpTrait $trait, Table $model) {
		if ($model->isReadOnly()) {
			$body = 'return $data';
		} else {
			$modelName = $model->getOriginCommonName();
			$normalizer = $this->project->getGeneratorDefinition()->getNormalizer($modelName);
			$fields = $this->generatorDefinitionService->getWriteFields($modelName);
			$code = '';

			foreach ($fields as $field) {
				if ($normalizer->has($field)) {
					$class = new Text($normalizer->get($field));
					if (!$class->startsWith('\\')) {
						$class = $class->prepend('\\');
					}
					$code .= $this->twig->render('normalizer-field.twig', [
						'class' => $class->toString(),
						'field' => $field
					]);
				}
			}

			$body = $this->twig->render('normalizer.twig', [
				'code' => $code
			]);
		}

		$trait->setMethod(PhpMethod::create('normalize')
			->addParameter(PhpParameter::create('data')->setType('array'))
			->setBody($body)
			->setType('array', 'normalized data')
		);
	}

	protected function generateCreate(PhpTrait $trait, Table $model) {
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\Created');
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotFound');
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotValid');

		$trait->setMethod(PhpMethod::create('create')
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('create.twig', [
				'class' => $model->getPhpName()
			]))
			->setDescription('Creates a new ' . $model->getPhpName() . ' with the provided data')
			->setType('PayloadInterface')
		);
	}

	protected function generateUpdate(PhpTrait $trait, Table $model) {
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\Updated');
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotUpdated');
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotFound');
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotValid');

		$trait->setMethod(PhpMethod::create('update')
			->addParameter(PhpParameter::create('id'))
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('update.twig', [
				'class' => $model->getPhpName()
			]))
			->setDescription('Updates a ' . $model->getPhpName() . ' with the given id' .
				'and the provided data')
			->setType('PayloadInterface')
		);
	}

	protected function generateDelete(PhpTrait $trait, Table $model) {
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\Deleted');
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotDeleted');
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotFound');

		$trait->setMethod(PhpMethod::create('delete')
			->addParameter(PhpParameter::create('id'))
			->setBody($this->twig->render('delete.twig', [
				'class' => $model->getPhpName()
			]))
			->setDescription('Deletes a ' . $model->getPhpName() . ' with the given id')
			->setType('PayloadInterface')
		);
	}

	protected function generateToOneRelationshipSet(PhpTrait $trait, Relationship $relationship) {
		$model = $relationship->getModel();
		$name = $relationship->getRelatedName();
		$trait->setMethod(PhpMethod::create('set' . $name . 'Id')
			->setDescription(str_replace('{foreign}', $relationship->getRelatedName(), 'Sets the {foreign} id'))
			->addParameter(PhpParameter::create('id'))
			->addParameter(PhpParameter::create('relatedId'))
			->setBody($this->twig->render('to-one-set.twig', [
				'class' => $model->getPhpName(),
				'related_name' => $name,
				'const' => strtoupper(NameUtils::toSnakeCase($relationship->getRelatedName()))
			]))
			->setType('PayloadInterface')
		);

		$trait->setMethod(PhpMethod::create('doSet' . $name . 'Id')
			->setDescription(str_replace('{foreign}', $relationship->getRelatedName(), 'Internal mechanism to set the {foreign} id'))
			->addParameter(PhpParameter::create('model')
				->setType($model->getPhpName())
			)
			->addParameter(PhpParameter::create('relatedId'))
			->setBody($this->twig->render('do-to-one-set.twig', [
				'local' => $relationship->getForeignKey()->getLocalColumn()->getPhpName()
			]))
			->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
		);
	}

	protected function generateToManyRelationshipAdd(PhpTrait $trait, Relationship $relationship) {
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotValid');

		$model = $relationship->getModel();
		$foreign = $relationship->getForeign();
		$trait->addUseStatement($foreign->getNamespace() . '\\' . $foreign->getPhpName() . 'Query');
		$trait->setMethod(PhpMethod::create('add' . $relationship->getRelatedPluralName())
			->setDescription('Adds ' . $relationship->getRelatedPluralName() . ' to ' . $model->getPhpName())
			->addParameter(PhpParameter::create('id'))
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('to-many-add.twig', [
				'class' => $model->getPhpName(),
				'related_name' => $relationship->getRelatedPluralName(),
				'const' => strtoupper(NameUtils::toSnakeCase($relationship->getRelatedPluralName()))
			]))
			->setType('PayloadInterface')
		);

		$methodNameGenerator = $this->factory->getRelationshipMethodNameGenerator();
		$trait->setMethod(PhpMethod::create('doAdd' . $relationship->getRelatedPluralName())
			->setDescription('Interal mechanism to add ' . $relationship->getRelatedPluralName() . ' to ' . $model->getPhpName())
			->addParameter(PhpParameter::create('model')
				->setType($model->getPhpName())
			)
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('do-to-many-add.twig', [
				'foreign_class' => $foreign->getPhpName(),
				'method_name' => $methodNameGenerator->generateMethodName($relationship)
			]))
			->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
		);

		// reflexive add method on many-to-many relationship
		if ($relationship->getType() == Relationship::MANY_TO_MANY && $relationship->isReflexive()) {
			$trait->setMethod(PhpMethod::create('add' . $relationship->getReverseRelatedPluralName())
				->setDescription('Adds ' . $relationship->getReverseRelatedPluralName() . ' to ' . $model->getPhpName())
				->addParameter(PhpParameter::create('id'))
				->addParameter(PhpParameter::create('data'))
				->setBody($this->twig->render('to-many-add.twig', [
					'class' => $model->getPhpName(),
					'related_name' => $relationship->getReverseRelatedPluralName(),
					'const' => strtoupper(NameUtils::toSnakeCase($relationship->getRelatedPluralName()))
				]))
				->setType('PayloadInterface')
			);

			$methodNameGenerator = $this->factory->getRelationshipMethodNameGenerator();
			$trait->setMethod(PhpMethod::create('doAdd' . $relationship->getReverseRelatedPluralName())
				->setDescription('Interal mechanism to add ' . $relationship->getReverseRelatedPluralName() . ' to ' . $model->getPhpName())
				->addParameter(PhpParameter::create('model')
					->setType($model->getPhpName())
				)
				->addParameter(PhpParameter::create('data'))
				->setBody($this->twig->render('do-to-many-add.twig', [
					'foreign_class' => $foreign->getPhpName(),
					'method_name' => $methodNameGenerator->generateReverseMethodName($relationship)
				]))
				->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
			);
		}
	}

	protected function generateToManyRelationshipRemove(PhpTrait $trait, Relationship $relationship) {
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotValid');

		$model = $relationship->getModel();
		$foreign = $relationship->getForeign();
		$trait->addUseStatement($foreign->getNamespace() . '\\' . $foreign->getPhpName() . 'Query');
		$trait->setMethod(PhpMethod::create('remove' . $relationship->getRelatedPluralName())
			->setDescription('Removes ' . $relationship->getRelatedPluralName() . ' from ' . $model->getPhpName())
			->addParameter(PhpParameter::create('id'))
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('to-many-remove.twig', [
				'class' => $model->getPhpName(),
				'related_name' => $relationship->getRelatedPluralName(),
				'const' => strtoupper(NameUtils::toSnakeCase($relationship->getRelatedPluralName()))
			]))
			->setType('PayloadInterface')
		);

		$methodNameGenerator = $this->factory->getRelationshipMethodNameGenerator();
		$trait->setMethod(PhpMethod::create('doRemove' . $relationship->getRelatedPluralName())
			->setDescription('Interal mechanism to remove ' . $relationship->getRelatedPluralName() . ' from ' . $model->getPhpName())
			->addParameter(PhpParameter::create('model')
				->setType($model->getPhpName())
				)
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('do-to-many-remove.twig', [
				'foreign_class' => $foreign->getPhpName(),
				'method_name' => $methodNameGenerator->generateMethodName($relationship)
			]))
			->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
		);

		// reflexive remove method on many-to-many relationship
		if ($relationship->getType() == Relationship::MANY_TO_MANY && $relationship->isReflexive()) {
			$trait->setMethod(PhpMethod::create('remove' . $relationship->getReverseRelatedPluralName())
				->setDescription('Removes ' . $relationship->getReverseRelatedPluralName() . ' from ' . $model->getPhpName())
				->addParameter(PhpParameter::create('id'))
				->addParameter(PhpParameter::create('data'))
				->setBody($this->twig->render('to-many-remove.twig', [
					'class' => $model->getPhpName(),
					'related_name' => $relationship->getReverseRelatedPluralName(),
					'const' => strtoupper(NameUtils::toSnakeCase($relationship->getRelatedPluralName()))
				]))
				->setType('PayloadInterface')
			);

			$methodNameGenerator = $this->factory->getRelationshipMethodNameGenerator();
			$trait->setMethod(PhpMethod::create('doRemove' . $relationship->getReverseRelatedPluralName())
				->setDescription('Interal mechanism to remove ' . $relationship->getReverseRelatedPluralName() . ' from ' . $model->getPhpName())
				->addParameter(PhpParameter::create('model')
					->setType($model->getPhpName())
				)
				->addParameter(PhpParameter::create('data'))
				->setBody($this->twig->render('do-to-many-remove.twig', [
					'foreign_class' => $foreign->getPhpName(),
					'method_name' => $methodNameGenerator->generateMethodName($relationship)
				]))
				->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
			);
		}
	}

	protected function generateOneToManyRelationshipUpdate(PhpTrait $trait, OneToManyRelationship $relationship) {
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotValid');
		$trait->addUseStatement('keeko\\framework\\exceptions\\ErrorsException');

		$model = $relationship->getModel();
		$foreign = $relationship->getForeign();
		$trait->addUseStatement($foreign->getNamespace() . '\\' . $foreign->getPhpName() . 'Query');
		$trait->setMethod(PhpMethod::create('update' . $relationship->getRelatedPluralName())
			->setDescription('Updates ' . $relationship->getRelatedPluralName() . ' on ' . $model->getPhpName())
			->addParameter(PhpParameter::create('id'))
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('one-to-many-update.twig', [
				'class' => $model->getPhpName(),
				'related_name' => $relationship->getRelatedPluralName(),
				'const' => strtoupper(NameUtils::toSnakeCase($relationship->getRelatedPluralName()))
			]))
			->setType('PayloadInterface')
		);

		$trait->setMethod(PhpMethod::create('doUpdate' . $relationship->getRelatedPluralName())
			->setDescription('Internal update mechanism of ' . $relationship->getRelatedPluralName() . ' on ' . $model->getPhpName())
			->addParameter(PhpParameter::create('model')
				->setType($model->getPhpName())
			)
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('do-one-to-many-update.twig', [
				'related' => $relationship->getRelatedName(),
				'reverse_related' => $relationship->getReverseRelatedName(),
				'foreign_class' => $foreign->getPhpName()
			]))
			->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
		);
	}

	protected function generateManyToManyRelationshipUpdate(PhpTrait $trait, ManyToManyRelationship $relationship) {
		$trait->addUseStatement('keeko\\framework\\domain\\payload\\NotValid');
		$trait->addUseStatement('keeko\\framework\\exceptions\\ErrorsException');

		$model = $relationship->getModel();
		$foreign = $relationship->getForeign();
		$middle = $relationship->getMiddle();
		$trait->addUseStatement($middle->getNamespace() . '\\' . $middle->getPhpName() . 'Query');
		$trait->addUseStatement($foreign->getNamespace() . '\\' . $foreign->getPhpName() . 'Query');
		$trait->setMethod(PhpMethod::create('update' . $relationship->getRelatedPluralName())
			->setDescription('Updates ' . $relationship->getRelatedPluralName() . ' on ' . $model->getPhpName())
			->addParameter(PhpParameter::create('id'))
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('many-to-many-update.twig', [
				'class' => $model->getPhpName(),
				'related_name' => $relationship->getRelatedPluralName(),
				'const' => strtoupper(NameUtils::toSnakeCase($relationship->getRelatedPluralName()))
			]))
			->setType('PayloadInterface')
		);

		$methodNameGenerator = $this->factory->getRelationshipMethodNameGenerator();
		$trait->setMethod(PhpMethod::create('doUpdate' . $relationship->getRelatedPluralName())
			->setDescription('Internal update mechanism of ' . $relationship->getRelatedPluralName() . ' on ' . $model->getPhpName())
			->addParameter(PhpParameter::create('model')
				->setType($model->getPhpName())
			)
			->addParameter(PhpParameter::create('data'))
			->setBody($this->twig->render('do-many-to-many-update.twig', [
				'method_name' => $methodNameGenerator->generateMethodName($relationship),
				'reverse_related' => $methodNameGenerator->generateReverseMethodName($relationship),
				'foreign_class' => $foreign->getPhpName(),
				'middle_class' => $middle->getPhpName(),
			]))
			->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
		);

		// reflexive update methods
		if ($relationship->isReflexive()) {
			$trait->setMethod(PhpMethod::create('update' . $relationship->getReverseRelatedPluralName())
				->setDescription('Updates ' . $relationship->getReverseRelatedPluralName() . ' on ' . $model->getPhpName())
				->addParameter(PhpParameter::create('id'))
				->addParameter(PhpParameter::create('data'))
				->setBody($this->twig->render('many-to-many-update.twig', [
					'class' => $model->getPhpName(),
					'related_name' => $relationship->getReverseRelatedName(),
					'const' => strtoupper(NameUtils::toSnakeCase($relationship->getRelatedPluralName()))
				]))
				->setType('PayloadInterface')
			);

			$methodNameGenerator = $this->factory->getRelationshipMethodNameGenerator();
			$trait->setMethod(PhpMethod::create('doUpdate' . $relationship->getReverseRelatedPluralName())
				->setDescription('Internal update mechanism of ' . $relationship->getReverseRelatedPluralName() . ' on ' . $model->getPhpName())
				->addParameter(PhpParameter::create('model')
					->setType($model->getPhpName())
				)
				->addParameter(PhpParameter::create('data'))
				->setBody($this->twig->render('do-many-to-many-update.twig', [
					'method_name' => $methodNameGenerator->generateReverseMethodName($relationship),
					'reverse_related' => $methodNameGenerator->generateMethodName($relationship),
					'foreign_class' => $foreign->getPhpName(),
					'middle_class' => $middle->getPhpName(),
				]))
				->setVisibility(PhpMethod::VISIBILITY_PROTECTED)
			);
		}
	}
}

keeko / tools

Push — master ( dae493...440cc5 )

ModelDomainTraitGenerator::generateNormalize() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
