ConfigCommand::setTableParams() - Code Metrics - Inspection of "Code and comment enhancements." - SetBased/php-audit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8e94f8...744b49 )

by P.R.

created 2016-08-17 13:19 UTC

ConfigCommand::setTableParams() A

↳ Parent: ConfigCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

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

<?php
//----------------------------------------------------------------------------------------------------------------------
namespace SetBased\Audit\Command;

use SetBased\Stratum\Style\StratumStyle;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Console\Question\Question;

//----------------------------------------------------------------------------------------------------------------------
/**
 * Command for editing data in config file.
 */
class ConfigCommand extends BaseCommand
{
  //--------------------------------------------------------------------------------------------------------------------
  /**
   * The helper instance by name.
   */
  private $helper;

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  protected function configure()
  {
    $this->setName('config')
         ->setDescription('Create or edit config file')
         ->addArgument('config file', InputArgument::OPTIONAL, 'The audit configuration file', 'etc/audit.json');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  protected function execute(InputInterface $input, OutputInterface $output)
  {
    $this->io = new StratumStyle($input, $output);

    $this->configFileName = $input->getArgument('config file');
    $this->readConfigFile();
    $this->configFileName = sprintf('%s%s', $input->getArgument('config file'), '.new');

    $this->helper = $this->getHelper('question');

    foreach ($this->config as $configPart => $partData)
    {
      $this->setConfigPart($input, $output, $configPart);
    }

    $this->writeTwoPhases($this->configFileName, json_encode($this->config, JSON_PRETTY_PRINT));
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Controls config parts.
   *
   * @param InputInterface  $input
   * @param OutputInterface $output
   * @param string          $configPart Part of config file.
   */
  protected function setConfigPart(InputInterface $input, OutputInterface $output, $configPart)
  {
    switch ($configPart)
    {
      case 'database':
        $this->setDatabasePart($input, $output, $configPart);
        break;
      case 'tables':
        foreach ($this->config[$configPart] as $tableName => $tableData)
        {
          $this->setTableParams($input, $output, $configPart, $tableName);
        }
        break;
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Configure each table for audit or not.
   *
   * @param InputInterface  $input
   * @param OutputInterface $output
   * @param string          $configPart Part of config file.
   * @param string          $tableName  The table name.
   */
  protected function setTableParams(InputInterface $input, OutputInterface $output, $configPart, $tableName)
  {
    $this->io->logInfo('Please input data for table <dbo>\'%s\'</dbo>.', $tableName);
    $question = sprintf('Audit table \'%s\' or not (y|(n)): ', $tableName);
    $question = new ConfirmationQuestion($question, false);

    $this->config[$configPart][$tableName]['audit'] = $this->helper->ask($input, $output, $question);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Configure database part.
   *
   * @param InputInterface  $input
   * @param OutputInterface $output
   * @param string          $configPart Part of config file.
   */
  protected function setDatabasePart(InputInterface $input, OutputInterface $output, $configPart)
  {
    $this->io->logInfo('Please input data for <dbo>\'%s\'</dbo> part.', $configPart);
    foreach ($this->config[$configPart] as $parameter => $value)
    {
      $question                              = sprintf('Please enter the \'%s\' (%s): ', $parameter, $value);
      $question                              = new Question($question, $value);
      $this->config[$configPart][$parameter] = $this->helper->ask($input, $output, $question);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
}

//----------------------------------------------------------------------------------------------------------------------


1			<?php
2			//----------------------------------------------------------------------------------------------------------------------
3			namespace SetBased\Audit\Command;
4
5			use SetBased\Stratum\Style\StratumStyle;
6			use Symfony\Component\Console\Input\InputArgument;
7			use Symfony\Component\Console\Input\InputInterface;
8			use Symfony\Component\Console\Output\OutputInterface;
9			use Symfony\Component\Console\Question\ConfirmationQuestion;
10			use Symfony\Component\Console\Question\Question;
11
12			//----------------------------------------------------------------------------------------------------------------------
13			/**
14			* Command for editing data in config file.
15			*/
16			class ConfigCommand extends BaseCommand
17			{
18			//--------------------------------------------------------------------------------------------------------------------
19			/**
20			* The helper instance by name.
21			*/
22			private $helper;
23
24			//--------------------------------------------------------------------------------------------------------------------
25			/**
26			* {@inheritdoc}
27			*/
28			protected function configure()
29			{
30			$this->setName('config')
31			->setDescription('Create or edit config file')
32			->addArgument('config file', InputArgument::OPTIONAL, 'The audit configuration file', 'etc/audit.json');
33			}
34
35			//--------------------------------------------------------------------------------------------------------------------
36			/**
37			* {@inheritdoc}
38			*/
39			protected function execute(InputInterface $input, OutputInterface $output)
40			{
41			$this->io = new StratumStyle($input, $output);
42
43			$this->configFileName = $input->getArgument('config file');
44			$this->readConfigFile();
45			$this->configFileName = sprintf('%s%s', $input->getArgument('config file'), '.new');
46
47			$this->helper = $this->getHelper('question');
48
49			foreach ($this->config as $configPart => $partData)
50			{
51			$this->setConfigPart($input, $output, $configPart);
52			}
53
54			$this->writeTwoPhases($this->configFileName, json_encode($this->config, JSON_PRETTY_PRINT));
55			}
56
57			//--------------------------------------------------------------------------------------------------------------------
58			/**
59			* Controls config parts.
60			*
61			* @param InputInterface $input
62			* @param OutputInterface $output
63			* @param string $configPart Part of config file.
64			*/
65			protected function setConfigPart(InputInterface $input, OutputInterface $output, $configPart)
66			{
67			switch ($configPart)
68			{
69			case 'database':
70			$this->setDatabasePart($input, $output, $configPart);
71			break;
72			case 'tables':
73			foreach ($this->config[$configPart] as $tableName => $tableData)
74			{
75			$this->setTableParams($input, $output, $configPart, $tableName);
76			}
77			break;
78			}
79			}
80
81			//--------------------------------------------------------------------------------------------------------------------
82			/**
83			* Configure each table for audit or not.
84			*
85			* @param InputInterface $input
86			* @param OutputInterface $output
87			* @param string $configPart Part of config file.
88			* @param string $tableName The table name.
89			*/
90			protected function setTableParams(InputInterface $input, OutputInterface $output, $configPart, $tableName)
91			{
92			$this->io->logInfo('Please input data for table <dbo>\'%s\'</dbo>.', $tableName);
93			$question = sprintf('Audit table \'%s\' or not (y\|(n)): ', $tableName);
94			$question = new ConfirmationQuestion($question, false);
95
96			$this->config[$configPart][$tableName]['audit'] = $this->helper->ask($input, $output, $question);
			0 ignored issues – show Bug introduced 2016-06-03 15:42 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `ask()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Helper\QuestionHelper`, `Symfony\Component\Consol...r\SymfonyQuestionHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
97			}
98
99			//--------------------------------------------------------------------------------------------------------------------
100			/**
101			* Configure database part.
102			*
103			* @param InputInterface $input
104			* @param OutputInterface $output
105			* @param string $configPart Part of config file.
106			*/
107			protected function setDatabasePart(InputInterface $input, OutputInterface $output, $configPart)
108			{
109			$this->io->logInfo('Please input data for <dbo>\'%s\'</dbo> part.', $configPart);
110			foreach ($this->config[$configPart] as $parameter => $value)
111			{
112			$question = sprintf('Please enter the \'%s\' (%s): ', $parameter, $value);
113			$question = new Question($question, $value);
114			$this->config[$configPart][$parameter] = $this->helper->ask($input, $output, $question);
			1 ignored issue – show Bug introduced 2016-06-03 15:42 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `ask()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Helper\QuestionHelper`, `Symfony\Component\Consol...r\SymfonyQuestionHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
115			}
116			}
117
118			//--------------------------------------------------------------------------------------------------------------------
119			}
120
121			//----------------------------------------------------------------------------------------------------------------------
122

SetBased / php-audit

Push — master ( 8e94f8...744b49 )

ConfigCommand::setTableParams() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like