AbstractCommand::getParameterFileName() - Code Metrics - Inspection of "Merge pull request #77 from msiebeneicher/feature/..." - trivago/chapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 151e35...1ba630 )

by Marc

created 2017-03-07 13:28 UTC

AbstractCommand::getParameterFileName() A

↳ Parent: AbstractCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0
crap	2

<?php
/**
 * @package: chapi
 *
 * @author:  msiebeneicher
 * @since:   2015-07-21
 *
 */


namespace Chapi\Commands;


use Chapi\Component\Command\CommandUtils;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;

abstract class AbstractCommand extends Command
{
    const FOLDER_RESOURCES = '/../../app/Resources/config/';

    /**
     * @var InputInterface
     */
    protected $oInput;

    /**
     * @var OutputInterface
     */
    protected $oOutput;

    /**
     * @var ContainerBuilder
     */
    private $oContainer;

    /**
     * @var string
     */
    private static $sHomeDir = '';

    /**
     * @inheritdoc
     */
    public function __construct($name = null)
    {
        parent::__construct($name);

        // setup default --profile option for all commands
        $this->addOption('profile', null, InputOption::VALUE_OPTIONAL, 'Use a specific profile from your config file.');
    }

    /**
     * @inheritdoc
     */
    protected function initialize(InputInterface $oInput, OutputInterface $oOutput)
    {
        $this->oInput = $oInput;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->oOutput = $oOutput;

        parent::initialize($oInput, $oOutput);
    }

    /**
     * Executes the current command.
     *
     * This method is not abstract because you can use this class
     * as a concrete class. In this case, instead of defining the
     * execute() method, you set the code to execute by passing
     * a Closure to the setCode() method.
     *
     * @param InputInterface $oInput An InputInterface instance
     * @param OutputInterface $oOutput An OutputInterface instance
     *
     * @return integer null or 0 if everything went fine, or an error code
     *
     * @throws \LogicException When this abstract method is not implemented
     *
     * @see setCode()
     */
    protected function execute(InputInterface $oInput, OutputInterface $oOutput)
    {
        if (!$this->isAppRunable())
        {
            return 1;
        }

        // set output for verbosity handling
        /** @var \Symfony\Bridge\Monolog\Handler\ConsoleHandler $_oConsoleHandler */
        $_oConsoleHandler = $this->getContainer()->get('ConsoleHandler');
        $_oConsoleHandler->setOutput($this->oOutput);

        return $this->process();
    }

    /**
     * @return int
     */
    abstract protected function process();

    /**
     * @return ContainerBuilder
     */
    protected function getContainer()
    {
        if (is_null($this->oContainer))
        {
            $_oContainer = new ContainerBuilder();

            // load local parameters
            $this->loadParameterConfig($this->getHomeDir(), $this->getParameterFileName(), $_oContainer);

            // load optional parameter in the current working directory
            $this->loadParameterConfig($this->getWorkingDir(), '.chapiconfig', $_oContainer);

            // load services
            $_oLoader = new YamlFileLoader($_oContainer, new FileLocator(__DIR__ . self::FOLDER_RESOURCES));
            $_oLoader->load('services.yml');

            $this->oContainer = $_oContainer;
        }

        return $this->oContainer;
    }

    /**
     * @return string
     */
    protected function getParameterFileName()
    {
        $_sProfile = $this->oInput->getOption('profile');
        return (is_string($_sProfile))
            ? sprintf('parameters_%s.yml', $_sProfile)
            : 'parameters.yml';
    }

    /**
     * @return bool
     */
    protected function isAppRunable()
    {
        // one file have to exist
        if (
            !file_exists($this->getHomeDir() . DIRECTORY_SEPARATOR . 'parameters.yml')
            && !file_exists($this->getWorkingDir() . DIRECTORY_SEPARATOR . '.chapiconfig')
        )
        {
            $this->oOutput->writeln(sprintf(
                '<error>%s</error>',
                'No parameter file found. Please run "configure" command for initial setup or add a local `.chapiconfig` to your working directory.'
            ));
            return false;
        }

        return true;
    }

    /**
     * @return string
     */
    protected function getHomeDir()
    {
        if (!empty(self::$sHomeDir))
        {
            return self::$sHomeDir;
        }

        $_sHomeDir = getenv('CHAPI_HOME');
        if (!$_sHomeDir)
        {
            $_sHomeDir = CommandUtils::getOsHomeDir() . DIRECTORY_SEPARATOR . '.chapi';
        }

        CommandUtils::hasCreateDirectoryIfNotExists($_sHomeDir);

        return self::$sHomeDir = $_sHomeDir;
    }

    /**
     * @return string
     */
    protected function getCacheDir()
    {
        $_sCacheDir = $this->getHomeDir() . DIRECTORY_SEPARATOR . 'cache';
        CommandUtils::hasCreateDirectoryIfNotExists($_sCacheDir);

        return $_sCacheDir;
    }

    /**
     * @return string
     */
    protected function getWorkingDir()
    {
        return getcwd();
    }

    /**
     * @param string $sPath
     * @param string $sFile
     * @param ContainerBuilder $oContainer
     */
    private function loadParameterConfig($sPath, $sFile, $oContainer)
    {
        // load local parameters
        if (file_exists($sPath . DIRECTORY_SEPARATOR . $sFile))
        {
            $_oLoader = new YamlFileLoader($oContainer, new FileLocator($sPath));
            $_oLoader->load($sFile);
        }
    }
}

1		<?php
2		/**
3		* @package: chapi
4		*
5		* @author: msiebeneicher
6		* @since: 2015-07-21
7		*
8		*/
9
10
11		namespace Chapi\Commands;
12
13
14		use Chapi\Component\Command\CommandUtils;
15		use Symfony\Component\Config\FileLocator;
16		use Symfony\Component\Console\Command\Command;
17		use Symfony\Component\Console\Input\InputInterface;
18		use Symfony\Component\Console\Input\InputOption;
19		use Symfony\Component\Console\Output\OutputInterface;
20		use Symfony\Component\DependencyInjection\ContainerBuilder;
21		use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
22
23		abstract class AbstractCommand extends Command
24		{
25		const FOLDER_RESOURCES = '/../../app/Resources/config/';
26
27		/**
28		* @var InputInterface
29		*/
30		protected $oInput;
31
32		/**
33		* @var OutputInterface
34		*/
35		protected $oOutput;
36
37		/**
38		* @var ContainerBuilder
39		*/
40		private $oContainer;
41
42		/**
43		* @var string
44		*/
45		private static $sHomeDir = '';
46
47		/**
48		* @inheritdoc
49		*/
50	25	public function __construct($name = null)
51		{
52	25	parent::__construct($name);
53
54		// setup default --profile option for all commands
55	25	$this->addOption('profile', null, InputOption::VALUE_OPTIONAL, 'Use a specific profile from your config file.');
56	25	}
57
58		/**
59		* @inheritdoc
60		*/
61	20	protected function initialize(InputInterface $oInput, OutputInterface $oOutput)
62		{
63	20	$this->oInput = $oInput;
		0 ignored issues – show Coding Style introduced 2017-03-02 10:41 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
64	20	$this->oOutput = $oOutput;
65
66	20	parent::initialize($oInput, $oOutput);
67	20	}
68
69		/**
70		* Executes the current command.
71		*
72		* This method is not abstract because you can use this class
73		* as a concrete class. In this case, instead of defining the
74		* execute() method, you set the code to execute by passing
75		* a Closure to the setCode() method.
76		*
77		* @param InputInterface $oInput An InputInterface instance
78		* @param OutputInterface $oOutput An OutputInterface instance
79		*
80		* @return integer null or 0 if everything went fine, or an error code
81		*
82		* @throws \LogicException When this abstract method is not implemented
83		*
84		* @see setCode()
85		*/
86	14	protected function execute(InputInterface $oInput, OutputInterface $oOutput)
87		{
88	14	if (!$this->isAppRunable())
89		{
90		return 1;
91		}
92
93		// set output for verbosity handling
94		/** @var \Symfony\Bridge\Monolog\Handler\ConsoleHandler $_oConsoleHandler */
95	14	$_oConsoleHandler = $this->getContainer()->get('ConsoleHandler');
96	14	$_oConsoleHandler->setOutput($this->oOutput);
97
98	14	return $this->process();
99		}
100
101		/**
102		* @return int
103		*/
104		abstract protected function process();
105
106		/**
107		* @return ContainerBuilder
108		*/
109		protected function getContainer()
110		{
111		if (is_null($this->oContainer))
112		{
113		$_oContainer = new ContainerBuilder();
114
115		// load local parameters
116		$this->loadParameterConfig($this->getHomeDir(), $this->getParameterFileName(), $_oContainer);
117
118		// load optional parameter in the current working directory
119		$this->loadParameterConfig($this->getWorkingDir(), '.chapiconfig', $_oContainer);
120
121		// load services
122		$_oLoader = new YamlFileLoader($_oContainer, new FileLocator(__DIR__ . self::FOLDER_RESOURCES));
123		$_oLoader->load('services.yml');
124
125		$this->oContainer = $_oContainer;
126		}
127
128		return $this->oContainer;
129		}
130
131		/**
132		* @return string
133		*/
134	6	protected function getParameterFileName()
135		{
136	6	$_sProfile = $this->oInput->getOption('profile');
137	6	return (is_string($_sProfile))
138	1	? sprintf('parameters_%s.yml', $_sProfile)
139	6	: 'parameters.yml';
140		}
141
142		/**
143		* @return bool
144		*/
145	3	protected function isAppRunable()
146		{
147		// one file have to exist
148		if (
149	3	!file_exists($this->getHomeDir() . DIRECTORY_SEPARATOR . 'parameters.yml')
150	3	&& !file_exists($this->getWorkingDir() . DIRECTORY_SEPARATOR . '.chapiconfig')
151		)
152		{
153		$this->oOutput->writeln(sprintf(
154		'<error>%s</error>',
155		'No parameter file found. Please run "configure" command for initial setup or add a local `.chapiconfig` to your working directory.'
156		));
157		return false;
158		}
159
160	3	return true;
161		}
162
163		/**
164		* @return string
165		*/
166	1	protected function getHomeDir()
167		{
168	1	if (!empty(self::$sHomeDir))
169		{
170	1	return self::$sHomeDir;
171		}
172
173	1	$_sHomeDir = getenv('CHAPI_HOME');
174	1	if (!$_sHomeDir)
175		{
176	1	$_sHomeDir = CommandUtils::getOsHomeDir() . DIRECTORY_SEPARATOR . '.chapi';
177		}
178
179	1	CommandUtils::hasCreateDirectoryIfNotExists($_sHomeDir);
180
181	1	return self::$sHomeDir = $_sHomeDir;
182		}
183
184		/**
185		* @return string
186		*/
187	1	protected function getCacheDir()
188		{
189	1	$_sCacheDir = $this->getHomeDir() . DIRECTORY_SEPARATOR . 'cache';
190	1	CommandUtils::hasCreateDirectoryIfNotExists($_sCacheDir);
191
192	1	return $_sCacheDir;
193		}
194
195		/**
196		* @return string
197		*/
198		protected function getWorkingDir()
199		{
200		return getcwd();
201		}
202
203		/**
204		* @param string $sPath
205		* @param string $sFile
206		* @param ContainerBuilder $oContainer
207		*/
208		private function loadParameterConfig($sPath, $sFile, $oContainer)
209		{
210		// load local parameters
211		if (file_exists($sPath . DIRECTORY_SEPARATOR . $sFile))
212		{
213		$_oLoader = new YamlFileLoader($oContainer, new FileLocator($sPath));
214		$_oLoader->load($sFile);
215		}
216		}
217		}

trivago / chapi

GitHub Access Token became invalid

Push — master ( 151e35...1ba630 )

AbstractCommand::getParameterFileName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like