console-helpers / svn-buddy

src/SVNBuddy/Command/ConfigCommand.php

<?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\Command;


use ConsoleHelpers\ConsoleKit\Config\ConfigEditor;
use ConsoleHelpers\SVNBuddy\Config\AbstractConfigSetting;
use ConsoleHelpers\SVNBuddy\Config\ArrayConfigSetting;
use ConsoleHelpers\SVNBuddy\Config\ChoiceConfigSetting;
use ConsoleHelpers\SVNBuddy\InteractiveEditor;
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Helper\TableSeparator;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class ConfigCommand extends AbstractCommand implements IAggregatorAwareCommand
{

	/**
	 * Editor.
	 *
	 * @var InteractiveEditor
	 */
	private $_editor;

	/**
	 * Config editor.
	 *
	 * @var ConfigEditor
	 */
	private $_configEditor;

	/**
	 * Config settings.
	 *
	 * @var AbstractConfigSetting[]
	 */
	protected $configSettings = array();

	/**
	 * {@inheritdoc}
	 */
	protected function configure()
	{
		$this
			->setName('config')
			->setDescription('Change configuration settings, that are used by other commands')
			->setAliases(array('cfg'))
			->addArgument(
				'path',
				InputArgument::OPTIONAL,
				'Working copy path',
				'.'
			)
			->addOption(
				'show',
				's',
				InputOption::VALUE_REQUIRED,
				'Shows only given (instead of all) setting value'
			)
			->addOption(
				'edit',
				'e',
				InputOption::VALUE_REQUIRED,
				'Change setting value in the Interactive Editor'
			)
			->addOption(
				'delete',
				'd',
				InputOption::VALUE_REQUIRED,
				'Delete setting'
			)
			->addOption(
				'global',
				'g',
				InputOption::VALUE_NONE,
				'Operate on global instead of working copy-specific settings'
			);

		parent::configure();
	}

	/**
	 * Prepare dependencies.
	 *
	 * @return void
	 */
	protected function prepareDependencies()
	{
		parent::prepareDependencies();

		$container = $this->getContainer();

		$this->_editor = $container['editor'];
		$this->_configEditor = $container['config_editor'];
		$this->configSettings = $this->getConfigSettings();
	}

	/**
	 * Return possible values for the named option
	 *
	 * @param string            $optionName Option name.
	 * @param CompletionContext $context    Completion context.
	 *
	 * @return array
	 */
	public function completeOptionValues($optionName, CompletionContext $context)
	{
		$ret = parent::completeOptionValues($optionName, $context);

		if ( in_array($optionName, array('show', 'edit', 'delete')) ) {
			return array_keys($this->configSettings);
		}

		return $ret;
	}

	/**
	 * {@inheritdoc}
	 */
	protected function execute(InputInterface $input, OutputInterface $output)
	{
		if ( $this->processShow() || $this->processEdit() || $this->processDelete() ) {
			return;
		}

		$this->listSettings();
	}

	/**
	 * Shows setting value.
	 *
	 * @return boolean
	 */
	protected function processShow()
	{
		$setting_name = $this->io->getOption('show');

		if ( $setting_name === null ) {
			return false;
		}

		$this->listSettings($setting_name);

It seems like $setting_name can also be of type string[]; however, parameter $setting_name of ConsoleHelpers\SVNBuddy\Command\ConfigCommand::listSettings() does only seem to accept string, maybe add an additional type check?

		return true;
	}

	/**
	 * Changes setting value.
	 *
	 * @return boolean
	 */
	protected function processEdit()
	{
		$setting_name = $this->io->getOption('edit');

		if ( $setting_name === null ) {
			return false;
		}

		$config_setting = $this->getConfigSetting($setting_name);

It seems like $setting_name can also be of type string[]; however, parameter $name of ConsoleHelpers\SVNBuddy\Command\ConfigCommand::getConfigSetting() does only seem to accept string, maybe add an additional type check?

		$value = $config_setting->getValue($this->getValueFilter());
		$retry = false;

The assignment to $retry is dead and can be removed.

		if ( $config_setting instanceof ArrayConfigSetting ) {
			$value = implode(PHP_EOL, $value);
		}

		do {
			try {
				$retry = false;

				if ( $config_setting instanceof ChoiceConfigSetting ) {
					$value = $this->io->choose(
						'Please choose value for "' . $setting_name . '" config setting [' . $value . ']:',

Are you sure $setting_name of type boolean|string|string[] can be used in concatenation?

						$config_setting->getChoices(),
						(string)$value,
						'Option value "%s" is invalid.'
					);
				}
				else {
					$value = $this->openEditor($value);
				}

				$config_setting->setValue($value, $this->getScopeFilter());
				$this->io->writeln('Setting <info>' . $setting_name . '</info> was edited.');
			}
			catch ( \InvalidArgumentException $e ) {
				$this->io->writeln(array('<error>' . $e->getMessage() . '</error>', ''));

				if ( $this->io->askConfirmation('Retry editing', false) ) {
					$retry = true;
				}
			}
		} while ( $retry );

		return true;
	}

	/**
	 * Opens value editing.
	 *
	 * @param mixed $value Value.
	 *
	 * @return mixed
	 */
	protected function openEditor($value)
	{
		return $this->_editor
			->setDocumentName('config_setting_value')
			->setContent($value)
			->launch();
	}

	/**
	 * Deletes setting value.
	 *
	 * @return boolean
	 */
	protected function processDelete()
	{
		$setting_name = $this->io->getOption('delete');

		if ( $setting_name === null ) {
			return false;
		}

		$config_setting = $this->getConfigSetting($setting_name);

It seems like $setting_name can also be of type string[]; however, parameter $name of ConsoleHelpers\SVNBuddy\Command\ConfigCommand::getConfigSetting() does only seem to accept string, maybe add an additional type check?

		$config_setting->setValue(null, $this->getScopeFilter());
		$this->io->writeln('Setting <info>' . $setting_name . '</info> was deleted.');

Are you sure $setting_name of type boolean|string|string[] can be used in concatenation?

		return true;
	}

	/**
	 * Lists values for every stored setting.
	 *
	 * @param string $setting_name Setting name.
	 *
	 * @return void
	 */
	protected function listSettings($setting_name = null)
	{
		if ( isset($setting_name) ) {
			$this->getConfigSetting($setting_name);
		}

		$extra_title = isset($setting_name) ? ' (filtered)' : '';

		if ( $this->isGlobal() ) {
			$this->io->writeln('Showing global settings' . $extra_title . ':');
		}
		else {
			$this->io->writeln(
				'Showing settings' . $extra_title . ' for <info>' . $this->getWorkingCopyUrl() . '</info> url:'
			);
		}

		$table = new Table($this->io->getOutput());

		$table->setHeaders(array(
			'Setting Name',
			'Setting Value',
		));

		$value_filter = $this->getValueFilter();

		$prev_heading = null;

		foreach ( $this->getConfigSettingsByScope($this->getScopeFilter()) as $name => $config_setting ) {
			if ( isset($setting_name) && $name !== $setting_name ) {
				continue;
			}

			list($new_heading,) = explode('.', $name);

			if ( $prev_heading !== null && $new_heading !== $prev_heading ) {
				$table->addRow(new TableSeparator());
			}

			$table->addRow(array(
				$name,
				var_export($config_setting->getValue($value_filter), true),
			));

			$prev_heading = $new_heading;
		}

		$table->render();
	}

	/**
	 * Returns config settings filtered by scope.
	 *
	 * @param integer $scope_filter Scope filter.
	 *
	 * @return AbstractConfigSetting[]
	 */
	protected function getConfigSettingsByScope($scope_filter)
	{
		$ret = array();

		foreach ( $this->configSettings as $name => $config_setting ) {
			if ( $config_setting->isWithinScope($scope_filter) ) {
				$ret[$name] = $config_setting;
			}
		}

		return $ret;
	}

	/**
	 * Validates setting name.
	 *
	 * @param string $name Setting name.
	 *
	 * @return AbstractConfigSetting
	 * @throws \InvalidArgumentException When non-existing/outside of scope setting given.
	 */
	protected function getConfigSetting($name)
	{
		if ( !array_key_exists($name, $this->configSettings) ) {
			throw new \InvalidArgumentException('The "' . $name . '" setting is unknown.');
		}

		$config_setting = $this->configSettings[$name];

		if ( !$config_setting->isWithinScope($this->getScopeFilter()) ) {
			throw new \InvalidArgumentException('The "' . $name . '" setting cannot be used in this scope.');
		}

		return $config_setting;
	}

	/**
	 * Returns scope filter for viewing config settings.
	 *
	 * @return integer
	 */
	protected function getScopeFilter()
	{
		return $this->isGlobal() ? AbstractConfigSetting::SCOPE_GLOBAL : AbstractConfigSetting::SCOPE_WORKING_COPY;
	}

	/**
	 * Returns value filter for editing config settings.
	 *
	 * @return integer
	 */
	protected function getValueFilter()
	{
		return $this->isGlobal() ? AbstractConfigSetting::SCOPE_GLOBAL : null;
	}

	/**
	 * Returns possible settings with their defaults.
	 *
	 * @return AbstractConfigSetting[]
	 */
	protected function getConfigSettings()
	{
		/** @var AbstractConfigSetting[] $config_settings */
		$config_settings = array();

		foreach ( $this->getApplication()->all() as $command ) {
			if ( $command instanceof IConfigAwareCommand ) {
				foreach ( $command->getConfigSettings() as $config_setting ) {
					$config_settings[$config_setting->getName()] = $config_setting;
				}
			}
		}

		// Allow to operate on global settings outside of working copy.
		$wc_url = $this->isGlobal() ? '' : $this->getWorkingCopyUrl();

		foreach ( $config_settings as $config_setting ) {
			$config_setting->setWorkingCopyUrl($wc_url);
			$config_setting->setEditor($this->_configEditor);
		}

		return $config_settings;
	}

	/**
	 * Determines if global only config settings should be used.
	 *
	 * @return boolean
	 */
	protected function isGlobal()
	{
		// During auto-complete the IO isn't set.
		if ( !isset($this->io) ) {
			return true;
		}

		return $this->io->getOption('global');

The expression return $this->io->getOption('global') also could return the type string|string[] which is incompatible with the documented return type boolean.

	}

	/**
	 * Returns option names, that makes sense to use in aggregation mode.
	 *
	 * @return array
	 */
	public function getAggregatedOptions()
	{
		return array();
	}

}