ConsoleHelpers\CodeInsight\BackwardsCompatibility\Checker\AbstractChecker

Complexity

Total Complexity

27

Size/Duplication

Total Lines	250
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

92.21%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
	getName()	0	1	?
	doCheck()	0	1	?
A	__construct()	0	4	1
A	check()	0	11	1
A	sortByType()	0	11	3
A	decodeValue()	0	8	1
A	getCacheKey()	0	4	1
B	paramToString()	0	37	8
B	isParamSignatureCompatible()	0	39	9
A	addIncident()	0	14	3

<?php
/**
 * This file is part of the Code-Insight library.
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @copyright Alexander Obuhovich <aik.bold@gmail.com>
 * @link      https://github.com/console-helpers/code-insight
 */

namespace ConsoleHelpers\CodeInsight\BackwardsCompatibility\Checker;


use Aura\Sql\ExtendedPdoInterface;
use Doctrine\Common\Cache\CacheProvider;

abstract class AbstractChecker
{

	/**
	 * Source database.
	 *
	 * @var ExtendedPdoInterface
	 */
	protected $sourceDatabase;

	/**
	 * Target database.
	 *
	 * @var ExtendedPdoInterface
	 */
	protected $targetDatabase;

	/**
	 * Cache.
	 *
	 * @var CacheProvider
	 */
	protected $cache;

	/**
	 * Incidents.
	 *
	 * @var array
	 */
	private $_incidents = array();

	/**
	 * Determines the order used to sort incidents with different types.
	 *
	 * @var array
	 */
	protected $typeSorting = array();

	/**
	 * AbstractChecker constructor.
	 *
	 * @param CacheProvider $cache Cache provider.
	 */
	public function __construct(CacheProvider $cache)
	{
		$this->cache = $cache;
	}

	/**
	 * Returns backwards compatibility checker name.
	 *
	 * @return string
	 */
	abstract public function getName();

	/**
	 * Checks backwards compatibility and returns violations by category.
	 *
	 * @param ExtendedPdoInterface $source_db Source DB.
	 * @param ExtendedPdoInterface $target_db Target DB.
	 *
	 * @return array
	 */
	public function check(ExtendedPdoInterface $source_db, ExtendedPdoInterface $target_db)
	{
		$this->sourceDatabase = $source_db;
		$this->targetDatabase = $target_db;

		$this->doCheck();

		usort($this->_incidents, array($this, 'sortByType'));

		return $this->_incidents;
	}

	/**
	 * Sorts incidents by type.
	 *
	 * @param array $incident_a Incident A.
	 * @param array $incident_b Incident B.
	 *
	 * @return integer
	 */
	public function sortByType(array $incident_a, array $incident_b)
	{
		$sort_key_a = $this->typeSorting[$incident_a['type']];
		$sort_key_b = $this->typeSorting[$incident_b['type']];

		if ( $sort_key_a === $sort_key_b ) {
			return 0;
		}

		return $sort_key_a > $sort_key_b ? 1 : -1;
	}

	/**
	 * Collects backwards compatibility violations.
	 *
	 * @return void
	 */
	abstract protected function doCheck();

	/**
	 * Builds string representation of a parameter.
	 *
	 * @param array $parameter_data Parameter data.
	 *
	 * @return string
	 */
	protected function paramToString(array $parameter_data)
	{
		if ( $parameter_data['HasType'] ) {
			$type = $parameter_data['TypeName'];
		}
		elseif ( $parameter_data['IsArray'] ) {
			$type = 'array';
		}
		elseif ( $parameter_data['IsCallable'] ) {
			$type = 'callable';
		}
		else {
			$type = $parameter_data['TypeClass'];
		}

		$hash_part = strlen($type) ? $type . ' ' : '';

		if ( $parameter_data['IsPassedByReference'] ) {
			$hash_part .= '&$' . $parameter_data['Name'];
		}
		else {
			$hash_part .= '$' . $parameter_data['Name'];
		}

		if ( $parameter_data['HasDefaultValue'] ) {
			$hash_part .= ' = ';

			if ( $parameter_data['DefaultConstant'] ) {
				$hash_part .= $parameter_data['DefaultConstant'];
			}
			else {
				$hash_part .= $this->decodeValue($parameter_data['DefaultValue']);
			}
		}

		return $hash_part;
	}

	/**
	 * Determines if 2 param signatures are compatible.
	 *
	 * @param string $source_signature Source signature.
	 * @param string $target_signature Target signature.
	 *
	 * @return boolean
	 */
	protected function isParamSignatureCompatible($source_signature, $target_signature)
	{
		if ( $source_signature === $target_signature ) {
			return true;
		}

		$source_params = $source_signature ? explode(', ', $source_signature) : array();
		$target_params = $target_signature ? explode(', ', $target_signature) : array();
		$source_param_count = count($source_params);

		// Beginning of target signature doesn't match source signature.
		if ( $source_params !== array_slice($target_params, 0, $source_param_count) ) {
			$target_params_wo_defaults = preg_replace('/ = [^,]*/', '', $target_params);

			// Making existing parameter optional doesn't break compatibility.
			if ( $source_params !== array_slice($target_params_wo_defaults, 0, $source_param_count) ) {
				return false;
			}
		}

		$added_params = array_slice($target_params, $source_param_count);

		// No new parameters added.
		if ( !$added_params ) {
			return true;
		}

		$is_compatible = true;

		// When all added parameters are optional, then signature is compatible.
		foreach ( $added_params as $added_param ) {
			if ( strpos($added_param, '=') === false ) {
				$is_compatible = false;
				break;
			}
		}

		return $is_compatible;
	}

	/**
	 * Decodes json-encoded PHP value.
	 *
	 * @param string $json_string JSON string.
	 *
	 * @return string
	 */
	protected function decodeValue($json_string)
	{
		$value = var_export(json_decode($json_string), true);
		$value = str_replace(array("\t", "\n"), '', $value);
		$value = str_replace('array (', 'array(', $value);

		return $value;
	}

	/**
	 * Adds incident.
	 *
	 * @param string      $type      Incident type.
	 * @param string      $element   Element affected.
	 * @param string|null $old_value Old value.
	 * @param string|null $new_value New value.
	 *
	 * @return void
	 */
	protected function addIncident($type, $element, $old_value = null, $new_value = null)
	{
		$incident_record = array(
			'type' => $type,
			'element' => $element,
		);

		if ( isset($old_value) || isset($new_value) ) {
			$incident_record['old'] = $old_value;
			$incident_record['new'] = $new_value;
		}

		$this->_incidents[] = $incident_record;
	}

	/**
	 * Returns cache key valid for specific database only.
	 *
	 * @param ExtendedPdoInterface $db        Database.
	 * @param string               $cache_key Cache key.
	 *
	 * @return string
	 */
	protected function getCacheKey(ExtendedPdoInterface $db, $cache_key)
	{
		return sha1($db->getDsn()) . ':' . $cache_key;
	}

}