EndpointCommand::template() - Code Metrics - Inspection of "refactored to abstract scaffolding command" - PascalKleindienst/simple-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7e29e1...6077fa )

by Pascal

created 2016-05-16 10:36 UTC

EndpointCommand::template() B

↳ Parent: EndpointCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	26
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	26
ccs	0
cts	22
cp	0
rs	8.8571
cc	1
eloc	12
nc	1
nop	3
crap	2

<?php
namespace Atog\Api\Console;

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

/**
 * Class EndpointCommand
 * @package Atog\Console
 */
class EndpointCommand extends AbstractScaffoldingCommand
{
    /**
     * @var string
     */
    protected $type = '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)
    {
        $this->createFileTemplate($input, $output, $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 Template
     * @param string $namespace
     * @param string $name
     * @param string $topNSPart
     * @return string
     */
    protected function template($namespace, $name, $topNSPart = "Endpoints")
    {
        $className = str_plural($name);
        $endpointName = strtolower($name);
        $namespace = "{$namespace}\\{$topNSPart}";

        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\Input\InputInterface;
5			use Symfony\Component\Console\Output\OutputInterface;
6
7			/**
8			* Class EndpointCommand
9			* @package Atog\Console
10			*/
11			class EndpointCommand extends AbstractScaffoldingCommand
12			{
13			/**
14			* @var string
15			*/
16			protected $type = 'endpoint';
17
18			/**
19			* Execute command
20			* @param \Symfony\Component\Console\Input\InputInterface $input
21			* @param \Symfony\Component\Console\Output\OutputInterface $output
22			* @return void
23			*/
24			protected function execute(InputInterface $input, OutputInterface $output)
25			{
26			$this->createFileTemplate($input, $output, $this->getApplication()->endpointPath());
			0 ignored issues – show Bug introduced 2016-05-16 10:39 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...
27			}
28
29			/**
30			* File Template
31			* @param string $namespace
32			* @param string $name
33			* @param string $topNSPart
34			* @return string
35			*/
36			protected function template($namespace, $name, $topNSPart = "Endpoints")
37			{
38			$className = str_plural($name);
39			$endpointName = strtolower($name);
40			$namespace = "{$namespace}\\{$topNSPart}";
41
42			return <<< EOT
43			<?php
44			namespace $namespace;
45
46			use Atog\Api\Endpoint;
47
48			/**
49			* Class $className
50			* @package $namespace
51			*/
52			class $className extends Endpoint
53			{
54			/**
55			* @var string
56			*/
57			protected \$endpoint = '$endpointName';
58			}
59
60			EOT;
61			}
62			}
63

PascalKleindienst / simple-api-client

Push — master ( 7e29e1...6077fa )

EndpointCommand::template() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like