ConsoleHelpers\SVNBuddy\Repository\RevisionLog\RevisionLog

Complexity

Total Complexity

29

Size/Duplication

Total Lines	296
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

99.05%

Importance

Changes	11
Bugs	0	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
C	refresh()	0	40	7
A	_getCacheInvalidator()	0	13	2
A	_getLastRevision()	0	14	2
B	_queryRevisionData()	0	36	5
A	_parseLog()	0	6	2
A	registerPlugin()	0	10	2
A	find()	0	8	2
A	getRevisionsData()	0	8	2
A	pluginRegistered()	0	4	1
A	getBugsFromRevisions()	0	15	3

<?php
/**
 * This file is part of the SVN-Buddy 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/svn-buddy
 */

namespace ConsoleHelpers\SVNBuddy\Repository\RevisionLog;


use ConsoleHelpers\ConsoleKit\ConsoleIO;
use ConsoleHelpers\SVNBuddy\Cache\CacheManager;
use ConsoleHelpers\SVNBuddy\Repository\Connector\Connector;

class RevisionLog
{

	const CACHE_FORMAT_VERSION = 1;

	/**
	 * Repository path.
	 *
	 * @var string
	 */
	private $_repositoryUrl;

	/**
	 * Repository connector.
	 *
	 * @var Connector
	 */
	private $_repositoryConnector;

	/**
	 * Cache manager.
	 *
	 * @var CacheManager
	 */
	private $_cacheManager;

	/**
	 * Console IO.
	 *
	 * @var ConsoleIO
	 */
	private $_io;

	/**
	 * Installed plugins.
	 *
	 * @var IRevisionLogPlugin[]
	 */
	private $_plugins = array();

	/**
	 * Create revision log.
	 *
	 * @param string       $repository_url       Repository url.
	 * @param Connector    $repository_connector Repository connector.
	 * @param CacheManager $cache_manager        Cache.
	 * @param ConsoleIO    $io                   Console IO.
	 */
	public function __construct(
		$repository_url,
		Connector $repository_connector,
		CacheManager $cache_manager,
		ConsoleIO $io = null
	) {
		$this->_repositoryUrl = $repository_url;
		$this->_repositoryConnector = $repository_connector;
		$this->_cacheManager = $cache_manager;
		$this->_io = $io;
	}

	/**
	 * Queries missing revisions.
	 *
	 * @return void
	 * @throws \LogicException When no plugins are registered.
	 */
	public function refresh()
	{
		if ( !$this->_plugins ) {
			throw new \LogicException('Please register at least one revision log plugin.');
		}

		$project_url = $this->_repositoryConnector->getProjectUrl($this->_repositoryUrl);

		if ( preg_match(Connector::URL_REGEXP, $project_url, $regs) ) {
			$cache_key = $regs[2] . $regs[3] . $regs[4] . '/log:' . $project_url;
		}
		else {
			$cache_key = 'misc/log:' . $project_url;
		}

		// Initialize plugins with data from cache.
		$cache = $this->_cacheManager->getCache($cache_key, $this->_getCacheInvalidator());

		if ( is_array($cache) ) {
			foreach ( $this->_plugins as $plugin_name => $plugin ) {
				$plugin->setCollectedData($cache[$plugin_name]);
			}
		}

		$from_revision = $this->_getLastRevision();
		$to_revision = $this->_repositoryConnector->getLastRevision($project_url);

		if ( $to_revision > $from_revision ) {
			$this->_queryRevisionData($from_revision, $to_revision);

			// Collect and cache plugin data.
			$cache = array();

			foreach ( $this->_plugins as $plugin_name => $plugin ) {
				$cache[$plugin_name] = $plugin->getCollectedData();
			}

			$this->_cacheManager->setCache($cache_key, $cache, $this->_getCacheInvalidator());
		}
	}

	/**
	 * Returns format version.
	 *
	 * @return mixed
	 */
	private function _getCacheInvalidator()
	{
		$invalidators = array('main' => 'main:' . self::CACHE_FORMAT_VERSION);

		foreach ( $this->_plugins as $plugin_name => $plugin ) {
			$invalidator_key = 'plugin(' . $plugin_name . ')';
			$invalidators[$invalidator_key] = $invalidator_key . ':' . $plugin->getCacheInvalidator();
		}

		ksort($invalidators);

		return implode(';', $invalidators);
	}

	/**
	 * Returns last known revision.
	 *
	 * @return integer
	 */
	private function _getLastRevision()
	{
		/** @var IRevisionLogPlugin $plugin */
		$plugin = reset($this->_plugins);
		$last_revision = $plugin->getLastRevision();

		if ( $last_revision === null ) {
			return $this->_repositoryConnector->getFirstRevision(
				$this->_repositoryConnector->getProjectUrl($this->_repositoryUrl)
			);
		}

		return $last_revision;
	}

	/**
	 * Queries missing revision data.
	 *
	 * @param integer $from_revision From revision.
	 * @param integer $to_revision   To revision.
	 *
	 * @return void
	 */
	private function _queryRevisionData($from_revision, $to_revision)
	{
		$range_start = $from_revision;
		$project_url = $this->_repositoryConnector->getProjectUrl($this->_repositoryUrl);

		// The "io" isn't set during autocomplete.
		if ( isset($this->_io) ) {
			$progress_bar = $this->_io->createProgressBar(ceil(($to_revision - $from_revision) / 200));
			$progress_bar->setFormat(
				' * Reading missing revisions: %current%/%max% [%bar%] %percent:3s%% %elapsed:6s%/%estimated:-6s%'
			);
			$progress_bar->start();
		}

		while ( $range_start <= $to_revision ) {
			$range_end = min($range_start + 199, $to_revision);

			$command = $this->_repositoryConnector->getCommand(
				'log',
				'-r ' . $range_start . ':' . $range_end . ' --xml --verbose --use-merge-history {' . $project_url . '}'
			);
			$command->setCacheDuration('10 years');

			$this->_parseLog($command->run());

It seems like $command->run() targeting ConsoleHelpers\SVNBuddy\Repository\Connector\Command::run() can also be of type string; however, ConsoleHelpers\SVNBuddy\Repository\RevisionLog\RevisionLog::_parseLog() does only seem to accept object<SimpleXMLElement>, maybe add an additional type check?

			$range_start = $range_end + 1;

			if ( isset($progress_bar) ) {
				$progress_bar->advance();
			}
		}

		if ( isset($progress_bar) ) {
			$progress_bar->finish();
			$this->_io->writeln('');
		}
	}

	/**
	 * Parses output of "svn log" command.
	 *
	 * @param \SimpleXMLElement $log Log.
	 *
	 * @return void
	 */
	private function _parseLog(\SimpleXMLElement $log)
	{
		foreach ( $this->_plugins as $plugin ) {
			$plugin->parse($log);
		}
	}

	/**
	 * Registers a plugin.
	 *
	 * @param IRevisionLogPlugin $plugin Plugin.
	 *
	 * @return void
	 * @throws \LogicException When plugin is registered several times.
	 */
	public function registerPlugin(IRevisionLogPlugin $plugin)
	{
		$plugin_name = $plugin->getName();

		if ( $this->pluginRegistered($plugin_name) ) {
			throw new \LogicException('The "' . $plugin_name . '" revision log plugin is already registered.');
		}

		$this->_plugins[$plugin_name] = $plugin;
	}

	/**
	 * Finds information using plugin.
	 *
	 * @param string       $plugin_name Plugin name.
	 * @param array|string $criteria    Search criteria.
	 *
	 * @return array
	 * @throws \InvalidArgumentException When unknown plugin is given.
	 */
	public function find($plugin_name, $criteria)
	{
		if ( !$this->pluginRegistered($plugin_name) ) {
			throw new \InvalidArgumentException('The "' . $plugin_name . '" revision log plugin is unknown.');
		}

		return $this->_plugins[$plugin_name]->find((array)$criteria);
	}

	/**
	 * Returns information about revisions.
	 *
	 * @param string $plugin_name Plugin name.
	 * @param array  $revisions   Revisions.
	 *
	 * @return array
	 * @throws \InvalidArgumentException When unknown plugin is given.
	 */
	public function getRevisionsData($plugin_name, array $revisions)
	{
		if ( !$this->pluginRegistered($plugin_name) ) {
			throw new \InvalidArgumentException('The "' . $plugin_name . '" revision log plugin is unknown.');
		}

		return $this->_plugins[$plugin_name]->getRevisionsData($revisions);
	}

	/**
	 * Determines if plugin is registered.
	 *
	 * @param string $plugin_name Plugin name.
	 *
	 * @return boolean
	 */
	public function pluginRegistered($plugin_name)
	{
		return array_key_exists($plugin_name, $this->_plugins);
	}

	/**
	 * Returns bugs, from revisions.
	 *
	 * @param array $revisions Revisions.
	 *
	 * @return array
	 */
	public function getBugsFromRevisions(array $revisions)
	{
		$bugs = array();
		$revisions_bugs = $this->getRevisionsData('bugs', $revisions);

		foreach ( $revisions as $revision ) {
			$revision_bugs = $revisions_bugs[$revision];

			foreach ( $revision_bugs as $bug_id ) {
				$bugs[$bug_id] = true;
			}
		}

		return array_keys($bugs);
	}

}