src/ConfigBridge.php
<?php
namespace SLLH\StyleCIBridge;
use Composer\Semver\Semver;
use Doctrine\Common\Inflector\Inflector;
use PhpCsFixer\Config;
use PhpCsFixer\Console\Application;
use PhpCsFixer\Finder;
use PhpCsFixer\FixerFactory;
use SLLH\StyleCIBridge\StyleCI\Configuration;
use SLLH\StyleCIFixers\Fixers;
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\Console\Formatter\OutputFormatterStyle;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Yaml\Yaml;
use Symfony\CS\Fixer;
use Symfony\CS\Fixer\Contrib\HeaderCommentFixer;
use Symfony\CS\FixerInterface;
/**
* @author Sullivan Senechal <soullivaneuh@gmail.com>
*/
final class ConfigBridge
{
const CS_FIXER_MIN_VERSION = '1.6.1';
const PRESET_NONE = 'none';
/**
* @var OutputInterface
*/
private $output;
/**
* @var FixerFactory
*/
private $fixerFactory = null;
/**
* @var string
*/
private $styleCIConfigDir;
/**
* @var array|null
*/
private $styleCIConfig = null;
/**
* @var string|array
*/
private $finderDirs;
/**
* @param string|null $styleCIConfigDir StyleCI config directory. Called script dir as default
* @param string|array|null $finderDirs A directory path or an array of directories for Finder. Called script dir as default
*/
public function __construct($styleCIConfigDir = null, $finderDirs = null)
{
if (!Semver::satisfies(
class_exists('Symfony\CS\Fixer') ? Fixer::VERSION : Application::VERSION, // PHP-CS-Fixer 1.x BC
sprintf('>=%s', self::CS_FIXER_MIN_VERSION)
)) {
throw new \RuntimeException(sprintf(
'PHP-CS-Fixer v%s is not supported, please upgrade to v%s or higher.',
Fixer::VERSION,
self::CS_FIXER_MIN_VERSION
));
}
// Guess config files path if not specified.
// getcwd function is not enough. See: https://github.com/Soullivaneuh/php-cs-fixer-styleci-bridge/issues/46
if (null === $styleCIConfigDir || null === $finderDirs) {
$dbt = version_compare(PHP_VERSION, '5.4.0', '>=') ? debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2) : debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
// Static call
if (isset($dbt[1]['class']) && 'SLLH\StyleCIBridge\ConfigBridge' === $dbt[1]['class'] && 'create' === $dbt[1]['function']) {
$configsPath = dirname($dbt[1]['file']);
} elseif (isset($dbt[0]['class']) && 'SLLH\StyleCIBridge\ConfigBridge' === $dbt[0]['class'] && '__construct' === $dbt[0]['function']) { // Manual instance
$configsPath = dirname($dbt[0]['file']);
} else { // If no case found, fallback to not reliable getcwd method.
$configsPath = getcwd();
}
$this->styleCIConfigDir = $styleCIConfigDir ?: $configsPath;
$this->finderDirs = $finderDirs ?: $configsPath;
}
$this->output = new ConsoleOutput();
$this->output->getFormatter()->setStyle('warning', new OutputFormatterStyle('black', 'yellow'));
// PHP-CS-Fixer 1.x BC
if (class_exists('PhpCsFixer\FixerFactory')) { // PHP-CS-Fixer 2.x only
$this->fixerFactory = FixerFactory::create();
$this->fixerFactory->registerBuiltInFixers();
}
$this->parseStyleCIConfig();
}
/**
* @param string $styleCIConfigDir
* @param string|array $finderDirs A directory path or an array of directories for Finder
*
* @return Config|\Symfony\CS\Config|\Symfony\CS\Config\Config
*/
public static function create($styleCIConfigDir = null, $finderDirs = null)
{
$bridge = new static($styleCIConfigDir, $finderDirs);
if (class_exists('\Symfony\CS\Config')) { // PHP-CS-Fixer >=1.12,<2.0
$config = \Symfony\CS\Config::create();
} elseif (class_exists('\Symfony\CS\Config\Config')) { // PHP-CS-Fixer 1.x
$config = \Symfony\CS\Config\Config::create();
} else { // PHP-CS-Fixer 2.x
$config = Config::create();
}
// PHP-CS-Fixer 1.x BC
if (method_exists($config, 'level')) {
$config->level(FixerInterface::NONE_LEVEL);
}
if (method_exists($config, 'setRules')) {
$config->setRules($bridge->getRules());
} else { // PHP-CS-Fixer 1.x BC
$config->fixers($bridge->getFixers());
}
// PHP-CS-Fixer 1.x BC
if (method_exists($config, 'setRiskyAllowed')) {
$config->setRiskyAllowed($bridge->getRisky());
}
// PHP-CS-Fixer 1.x BC
if (method_exists($config, 'setFinder')) {
$config->setFinder($bridge->getFinder());
} else {
$config->finder($bridge->getFinder());
}
return $config;
}
/**
* @return Finder|\Symfony\CS\Finder|\Symfony\CS\Finder\DefaultFinder
*/
public function getFinder()
{
// PHP-CS-Fixer 1.x BC
if (class_exists('\Symfony\CS\Finder')) { // PHP-CS-Fixer >=1.12,<2.0
$finder = \Symfony\CS\Finder::create()->in($this->finderDirs);
} elseif (class_exists('\Symfony\CS\Finder\DefaultFinder')) { // PHP-CS-Fixer 1.x
$finder = \Symfony\CS\Finder\DefaultFinder::create()->in($this->finderDirs);
} else { // PHP-CS-Fixer 2.x
$finder = Finder::create()->in($this->finderDirs);
}
if (isset($this->styleCIConfig['finder'])) {
$finderConfig = $this->styleCIConfig['finder'];
foreach ($finderConfig as $key => $values) {
$finderMethod = Inflector::camelize($key);
foreach ($values as $value) {
if (method_exists($finder, $finderMethod)) {
$finder->$finderMethod($value);
} else {
$this->output->writeln(sprintf(
'<warning>Can not apply "%s" finder option with PHP-CS-Fixer v%s. You fixer config may be erroneous. Consider upgrading to fix it.</warning>',
str_replace('_', '-', $key),
Fixer::VERSION
));
}
}
}
}
return $finder;
}
/**
* @return string[]
*/
public function getFixers()
{
$presetFixers = $this->resolveAliases($this->getPresetFixers());
$enabledFixers = $this->resolveAliases($this->styleCIConfig['enabled']);
$disabledFixers = $this->resolveAliases($this->styleCIConfig['disabled']);
$fixers = array_merge(
$enabledFixers,
array_map(function ($disabledFixer) {
return '-'.$disabledFixer;
}, $disabledFixers),
array_diff($presetFixers, $disabledFixers) // Remove disabled fixers from preset
);
// PHP-CS-Fixer 1.x BC
if (method_exists('Symfony\CS\Fixer\Contrib\HeaderCommentFixer', 'getHeader') && HeaderCommentFixer::getHeader()) {
array_push($fixers, 'header_comment');
}
return $fixers;
}
/**
* Returns fixers converted to rules for PHP-CS-Fixer 2.x.
*
* @return array
*/
public function getRules()
{
$fixers = $this->getFixers();
$rules = array();
foreach ($fixers as $fixer) {
if ('-' === $fixer[0]) {
$name = substr($fixer, 1);
$enabled = false;
} else {
$name = $fixer;
$enabled = true;
}
if ($this->isFixerAvailable($name)) {
$rules[$name] = $enabled;
} else {
$this->output->writeln(sprintf('<warning>Fixer "%s" does not exist, skipping.</warning>', $name));
}
}
return $rules;
}
/**
* @return bool
*/
public function getRisky()
{
return $this->styleCIConfig['risky'];
}
/**
* @return string[]
*/
private function getPresetFixers()
{
if (static::PRESET_NONE === $this->styleCIConfig['preset']) {
return array();
}
$validPresets = Fixers::getPresets();
return $validPresets[$this->styleCIConfig['preset']];
}
/**
* Adds both aliases and real fixers if set. PHP-CS-Fixer would not take care if not existing.
* Better compatibility between PHP-CS-Fixer 1.x and 2.x.
*
* @param string[] $fixers
*
* @return string[]
*/
private function resolveAliases(array $fixers)
{
foreach (Fixers::$aliases as $alias => $name) {
if (in_array($alias, $fixers, true) && !in_array($name, $fixers, true) && $this->isFixerAvailable($name)) {
array_push($fixers, $name);
}
if (in_array($name, $fixers, true) && !in_array($alias, $fixers, true) && $this->isFixerAvailable($alias)) {
array_push($fixers, $alias);
}
}
return $fixers;
}
/**
* @param string $name
*
* @return bool
*/
private function isFixerAvailable($name)
{
// PHP-CS-Fixer 1.x BC
if (null === $this->fixerFactory) {
return true;
}
return $this->fixerFactory->hasRule($name);
}
private function parseStyleCIConfig()
{
if (null === $this->styleCIConfig) {
$config = Yaml::parse(file_get_contents(sprintf('%s/.styleci.yml', $this->styleCIConfigDir)));
$processor = new Processor();
$this->styleCIConfig = $processor->processConfiguration(new Configuration(), array('styleci' => $config));
}
}
}