DeploymentStrategy

Complexity

Total Complexity

41

Size/Duplication

Total Lines	331
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	2
Bugs	0	Features	0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setActionTitle()	0	3	1
A	getActionTitle()	0	3	1
A	setActionCode()	0	3	1
A	getActionCode()	0	3	1
A	setEstimatedTime()	0	3	1
A	getEstimatedTime()	0	3	1
A	setChangeDescriptionOnly()	0	5	1
B	getChangesModificationNeeded()	0	15	6
A	setChange()	0	6	1
A	getChange()	0	7	2
A	setOption()	0	3	1
A	getOption()	0	5	2
A	getOptions()	0	3	1
A	setValidationCode()	0	3	1
A	getValidationCode()	0	3	1
A	setMessage()	0	16	2
A	getMessages()	0	3	1
A	toArray()	0	21	3
A	toJSON()	0	3	1
A	fromJSON()	0	4	1
A	fromArray()	0	17	3
A	createDeployment()	0	10	1
B	getChanges()	0	14	6

<?php

class DeploymentStrategy extends ViewableData {

	const SUCCESS_CODE = 'success';

	const WARNING_CODE = 'warning';

	const ERROR_CODE = 'error';

	/**
	 * @var DNEnvironment
	 */
	protected $environment;

	/**
	 * @var string
	 */
	protected $actionTitle = 'Deploy';

	/**
	 * @var string
	 */
	protected $actionCode = 'default';

	/**
	 * @var int
	 */
	protected $estimatedTime = 0;

	/**
	 * @var array
	 */
	protected $changes = [];

	/**
	 * @var array
	 */
	protected $options;

	/**
	 * Validation code
	 *
	 * @var string
	 */
	protected $validationCode = DeploymentStrategy::SUCCESS_CODE;

	/**
	 * @var array
	 */
	protected $messages = [];


	/**
	 * @param DNEnvironment $environment
	 * @param array $options
	 */
	public function __construct(DNEnvironment $environment, $options = array()) {
		$this->environment = $environment;
		$this->options = $options;
	}

	/**
	 * @param string $title
	 */
	public function setActionTitle($title) {
		$this->actionTitle = $title;
	}

	/**
	 * @return string
	 */
	public function getActionTitle() {
		return $this->actionTitle;
	}

	/**
	 */
	public function setActionCode($code) {
		$this->actionCode = $code;
	}

	/**
	 * @return string
	 */
	public function getActionCode() {
		return $this->actionCode;
	}

	/**
	 * @param int
	 */
	public function setEstimatedTime($seconds) {
		$this->estimatedTime = $seconds;
	}

	/**
	 * @return int Time in minutes
	 */
	public function getEstimatedTime() {
		return $this->estimatedTime;
	}

	/**
	 * @param string $title
	 * @param string $from
	 * @param string $to
	 */
	public function setChange($title, $from, $to) {
		return $this->changes[$title] = array(
			'from' => $from,
			'to' => $to
		);
	}

	/**
	 * @param string $title
	 * @param string $desc
	 */
	public function setChangeDescriptionOnly($title, $desc) {
		return $this->changes[$title] = array(
			'description' => $desc
		);
	}

	/**
	 * Filter the changeset where modification was not required.
	 *
	 * @return array
	 */
	public function getChangesModificationNeeded() {
		$filtered = [];
		foreach ($this->getChanges() as $change => $details) {
			if (array_key_exists('description', $details)) {
				$filtered[$change] = $details;
			} else if (
				(array_key_exists('from', $details) || array_key_exists('to', $details))
				&& $details['from'] !== $details['to']
			) {
				$filtered[$change] = $details;
			}
		}

		return $filtered;
	}

	/**
	 * @return array Associative array of changes, e.g.
	 *	array(
	 *		'SHA' => array(
	 *			'from' => 'abc',
	 *			'to' => 'def'
	 *		)
	 *	)
	 */
	public function getChanges() {
		// Normalise "empty" values into empty strings so comparisons are done properly.
		// This means there is no diference between an empty string and a null
		// but "0" is considered to be non-empty.
		$changes = $this->changes;
		foreach($changes as $field => $events) {
			foreach($events as $event => $value) {
				if(empty($value) && !strlen($value) || $value === '-') {
					$changes[$field][$event] = '';
				}
			}
		}
		return $changes;
	}

	/**
	 * Returns a change or a given key.
	 *
	 * @return ArrayData|null
	 */
	public function getChange($key) {
		$changes = $this->getChanges();
		if(array_key_exists($key, $changes)) {
			return new ArrayData($changes[$key]);
		}
		return null;
	}

	/**
	 * @param string $option
	 * @param string $value
	 */
	public function setOption($option, $value) {
		$this->options[$option] = $value;
	}

	/**
	 * @param string $option
	 * @return string|null
	 */
	public function getOption($option) {
		if(!empty($this->options[$option])) {
			return $this->options[$option];
		}
	}

	/**
	 * @return string
	 */
	public function getOptions() {
		return $this->options;
	}

	/**
	 * @param string $code
	 */
	public function setValidationCode($code) {
		$this->validationCode = $code;
	}

	/**
	 * @return string
	 */
	public function getValidationCode() {
		return $this->validationCode;
	}

	/**
	 * @param string $msg
	 */
	public function setMessage($msg, $code = self::ERROR_CODE) {
		$this->messages[] = [
			'text' => $msg,
			'code' => $code
		];

		$current = $this->getValidationCode();
		$map = [
			DeploymentStrategy::SUCCESS_CODE => 0,
			DeploymentStrategy::WARNING_CODE => 1,
			DeploymentStrategy::ERROR_CODE => 2
		];
		if($map[$current] < $map[$code]) {
			$this->setValidationCode($code);
		}
	}

	/**
	 * @return array
	 */
	public function getMessages() {
		return $this->messages;
	}

	/**
	 * Transform the deployment strategy to an array.
	 *
	 * @return array
	 */
	public function toArray() {
		$fields = array(
			'actionTitle',
			'actionCode',
			'estimatedTime',
			'changes',
			'options',
			'validationCode',
			'messages'
		);

		$output = array();
		foreach($fields as $field) {
			if(method_exists($this, 'get' . $field)) {
				$output[$field] = $this->{'get' . $field}();
			} else {
				$output[$field] = $this->$field;
			}
		}
		return $output;
	}

	/**
	 * @return string
	 */
	public function toJSON() {
		return json_encode($this->toArray(), JSON_PRETTY_PRINT);
	}

	/**
	 * Load from JSON associative array.
	 * Environment must be set by the callee when creating this object.
	 *
	 * @param string $json
	 */
	public function fromJSON($json) {
		$decoded = json_decode($json, true);
		return $this->fromArray($decoded);
	}

	/**
	 * Load from array.
	 * Environment must be set by the callee when creating this object.
	 *
	 * @param string $data
	 */
	public function fromArray($data) {
		$fields = array(
			'actionTitle',
			'actionCode',
			'estimatedTime',
			'changes',
			'options',
			'validationCode',
			'messages'
		);

		foreach($fields as $field) {
			if(!empty($data[$field])) {
				$this->$field = $data[$field];
			}
		}
	}

	/**
	 * @return DNDeployment
	 */
	public function createDeployment() {
		$deployment = DNDeployment::create();
		$deployment->EnvironmentID = $this->environment->ID;
		// Pull out the SHA from the options so we can make it queryable.
		$deployment->SHA = $this->getOption('sha');
		$deployment->Strategy = $this->toJSON();

The property Strategy does not exist on object<DNDeployment>. Since you implemented __set, maybe consider adding a @property annotation.

		$deployment->write();

		return $deployment;
	}

}