EndpointCommand::configure() - Code Metrics - Inspection of "created some scaffolding cmd tools" - PascalKleindienst/simple-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a10e7d...7e29e1 )

by Pascal

created 2016-05-16 10:22 UTC

EndpointCommand::configure() A

↳ Parent: EndpointCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace Atog\Api\Console;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class EndpointCommand
 * @package Atog\Console
 */
class EndpointCommand extends Command
{
    /**
     * Command Config
     */
    protected function configure()
    {
        $this
            ->setName('create:endpoint')
            ->setDescription('Create a new Endpoint')
            ->addArgument(
                'namespace',
                InputArgument::REQUIRED,
                'Namespace in Dot-Notation e.g. Acme.Api'
            )
            ->addArgument(
                'name',
                InputArgument::REQUIRED,
                'Name of the Endpoint'
            )
        ;
    }

    /**
     * Execute command
     * @param \Symfony\Component\Console\Input\InputInterface   $input
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     * @return void
     */
    protected function execute(InputInterface $input, OutputInterface $output)

    {
        // args
        $namespace = str_replace('.', '\\', $input->getArgument('namespace'));
        $name = $input->getArgument('name');
        $path = $this->getApplication()->endpointPath();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        $file = $path . str_plural($name) . '.php';

        // only write file if path exists and file does not exist yet
        if (file_exists($path) && !file_exists($file)) {
            // write file
            $endpoint = fopen($file, "w+");
            fwrite($endpoint, $this->template($namespace, $name));
            fclose($endpoint);

            // output
            $output->writeln("<info>Created Endpoint: $name</info>");
            return;
        }

        // error
        $output->writeln("<error>Could not create file $file at $path</error>");
    }

    /**
     * File Template
     * @param string $namespace
     * @param string $name
     * @param string $endpointNS
     * @return string
     */
    protected function template($namespace, $name, $endpointNS = "Endpoints")
    {
        $className = str_plural($name);
        $endpointName = strtolower($name);
        $namespace = "{$namespace}\\{$endpointNS}";

        return <<< EOT
<?php
namespace $namespace;

use Atog\Api\Endpoint;

/**
 * Class $className
 * @package $namespace
 */
class $className extends Endpoint
{
    /**
     * @var string
     */
    protected \$endpoint = '$endpointName';
}

EOT;
    }
}


1		<?php
2		namespace Atog\Api\Console;
3
4		use Symfony\Component\Console\Command\Command;
5		use Symfony\Component\Console\Input\InputArgument;
6		use Symfony\Component\Console\Input\InputInterface;
7		use Symfony\Component\Console\Output\OutputInterface;
8
9		/**
10		* Class EndpointCommand
11		* @package Atog\Console
12		*/
13		class EndpointCommand extends Command
14		{
15		/**
16		* Command Config
17		*/
18		protected function configure()
19		{
20		$this
21		->setName('create:endpoint')
22		->setDescription('Create a new Endpoint')
23		->addArgument(
24		'namespace',
25		InputArgument::REQUIRED,
26		'Namespace in Dot-Notation e.g. Acme.Api'
27		)
28		->addArgument(
29		'name',
30		InputArgument::REQUIRED,
31		'Name of the Endpoint'
32		)
33		;
34		}
35
36		/**
37		* Execute command
38		* @param \Symfony\Component\Console\Input\InputInterface $input
39		* @param \Symfony\Component\Console\Output\OutputInterface $output
40		* @return void
41		*/
42	View Code Duplication	protected function execute(InputInterface $input, OutputInterface $output)
		0 ignored issues – show Duplication introduced 2016-05-16 10:25 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
43		{
44		// args
45		$namespace = str_replace('.', '\\', $input->getArgument('namespace'));
46		$name = $input->getArgument('name');
47		$path = $this->getApplication()->endpointPath();
		0 ignored issues – show Bug introduced 2016-05-16 10:25 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Application` as the method `endpointPath()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Atog\Api\Console\Application`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
48		$file = $path . str_plural($name) . '.php';
49
50		// only write file if path exists and file does not exist yet
51		if (file_exists($path) && !file_exists($file)) {
52		// write file
53		$endpoint = fopen($file, "w+");
54		fwrite($endpoint, $this->template($namespace, $name));
55		fclose($endpoint);
56
57		// output
58		$output->writeln("<info>Created Endpoint: $name</info>");
59		return;
60		}
61
62		// error
63		$output->writeln("<error>Could not create file $file at $path</error>");
64		}
65
66		/**
67		* File Template
68		* @param string $namespace
69		* @param string $name
70		* @param string $endpointNS
71		* @return string
72		*/
73		protected function template($namespace, $name, $endpointNS = "Endpoints")
74		{
75		$className = str_plural($name);
76		$endpointName = strtolower($name);
77		$namespace = "{$namespace}\\{$endpointNS}";
78
79		return <<< EOT
80		<?php
81		namespace $namespace;
82
83		use Atog\Api\Endpoint;
84
85		/**
86		* Class $className
87		* @package $namespace
88		*/
89		class $className extends Endpoint
90		{
91		/**
92		* @var string
93		*/
94		protected \$endpoint = '$endpointName';
95		}
96
97		EOT;
98		}
99		}
100

PascalKleindienst / simple-api-client

Push — master ( a10e7d...7e29e1 )

EndpointCommand::configure() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like