PublishShowAssignment::abortCommandExecution() - Code Metrics - acacha/forge-publish - Measure and Improve Code Quality continuously with Scrutinizer

PublishShowAssignment::abortCommandExecution() A
last analyzed 2018-03-14 17:57 UTC

↳ Parent: PublishShowAssignment

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Acacha\ForgePublish\Commands;

use Acacha\ForgePublish\Commands\Traits\AborstIfEnvVariableIsnotInstalled;
use Acacha\ForgePublish\Commands\Traits\InteractsWithAssignments;
use Acacha\ForgePublish\Commands\Traits\InteractsWithEnvironment;
use Acacha\ForgePublish\Commands\Traits\InteractsWithLocalGithub;
use Acacha\ForgePublish\Commands\Traits\ItFetchesAssignments;
use GuzzleHttp\Client;
use Illuminate\Console\Command;

/**
 * Class PublishShowAssignment.
 *
 * @package Acacha\ForgePublish\Commands
 */
class PublishShowAssignment extends Command
{
    use InteractsWithEnvironment,
        AborstIfEnvVariableIsnotInstalled,
        InteractsWithAssignments,
        ItFetchesAssignments;

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'publish:show_assignment {assignment? : The assignment to show}' ;

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Shows an assignment';

    /**
     * Assignment.
     *
     * @var integer
     */
    protected $assignment;

    /**
     * Server names.
     *
     * @var Client
     */
    protected $http;

    /**
     * SaveEnvVariable constructor.
     *
     */
    public function __construct(Client $http)
    {
        parent::__construct();
        $this->http = $http;
    }

    /**
     * Execute the console command.
     *
     */
    public function handle()

    {
        $this->abortCommandExecution();
        $this->assignment = $this->argument('assignment') ? $this->argument('assignment') : $this->askAssignment();

        $this->show_assignment();
    }

    /**
     * Show assignment.
     */
    protected function show_assignment() {
        $assignment = $this->fetch_assignment();

        $headers = ['Key', 'Value'];

        $rows = [
            [ 'Id' , $assignment->id],
            [ 'Name' , $assignment->name],
            [ 'Repository uri' , $assignment->repository_uri],
            [ 'Repository type' , $assignment->repository_type],
            [ 'Forge Site' , $assignment->forge_site],
            [ 'Forge server' , $assignment->forge_server],
            [ 'Groups' , join(', ', collect($assignment->groups)->pluck('name')->toArray()) ],
            [ 'Users' , join(', ', collect($assignment->users)->pluck('name')->toArray())],
            [ 'Teachers' , join(', ', collect($assignment->assignators)->pluck('name')->toArray())],
            [ 'Created' , $assignment->created_at],
            [ 'Updated' , $assignment->updated_at]
        ];

        $this->table($headers, $rows);
    }

    /**
     * Show assignment.
     *
     * @return array|mixed
     */
    protected function fetch_assignment()

    {
        $uri = str_replace('{assignment}', $this->assignment, config('forge-publish.show_assignment_uri'));
        $url = config('forge-publish.url') . $uri;
        try {
            $response = $this->http->get($url, [
                'headers' => [
                    'X-Requested-With' => 'XMLHttpRequest',
                    'Authorization' => 'Bearer ' . fp_env('ACACHA_FORGE_ACCESS_TOKEN')
                ]
            ]);
        } catch (\Exception $e) {
            $this->error('And error occurs connecting to the api url: ' . $url);
            $this->error('Status code: ' . $e->getResponse()->getStatusCode() . ' | Reason : ' . $e->getResponse()->getReasonPhrase());
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.
    }
}
        }
        return json_decode((string) $response->getBody());
    }

    /**
     * Abort command execution.
     */
    protected function abortCommandExecution()
    {
        $this->abortsIfEnvVarIsNotInstalled('ACACHA_FORGE_ACCESS_TOKEN');
    }
}


1		<?php
2
3		namespace Acacha\ForgePublish\Commands;
4
5		use Acacha\ForgePublish\Commands\Traits\AborstIfEnvVariableIsnotInstalled;
6		use Acacha\ForgePublish\Commands\Traits\InteractsWithAssignments;
7		use Acacha\ForgePublish\Commands\Traits\InteractsWithEnvironment;
8		use Acacha\ForgePublish\Commands\Traits\InteractsWithLocalGithub;
9		use Acacha\ForgePublish\Commands\Traits\ItFetchesAssignments;
10		use GuzzleHttp\Client;
11		use Illuminate\Console\Command;
12
13		/**
14		* Class PublishShowAssignment.
15		*
16		* @package Acacha\ForgePublish\Commands
17		*/
18		class PublishShowAssignment extends Command
19		{
20		use InteractsWithEnvironment,
21		AborstIfEnvVariableIsnotInstalled,
22		InteractsWithAssignments,
23		ItFetchesAssignments;
24
25		/**
26		* The name and signature of the console command.
27		*
28		* @var string
29		*/
30		protected $signature = 'publish:show_assignment {assignment? : The assignment to show}' ;
31
32		/**
33		* The console command description.
34		*
35		* @var string
36		*/
37		protected $description = 'Shows an assignment';
38
39		/**
40		* Assignment.
41		*
42		* @var integer
43		*/
44		protected $assignment;
45
46		/**
47		* Server names.
48		*
49		* @var Client
50		*/
51		protected $http;
52
53		/**
54		* SaveEnvVariable constructor.
55		*
56		*/
57		public function __construct(Client $http)
58		{
59		parent::__construct();
60		$this->http = $http;
61		}
62
63		/**
64		* Execute the console command.
65		*
66		*/
67	View Code Duplication	public function handle()
		0 ignored issues – show Duplication introduced 2017-12-04 16:40 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...
68		{
69		$this->abortCommandExecution();
70		$this->assignment = $this->argument('assignment') ? $this->argument('assignment') : $this->askAssignment();
71
72		$this->show_assignment();
73		}
74
75		/**
76		* Show assignment.
77		*/
78		protected function show_assignment() {
79		$assignment = $this->fetch_assignment();
80
81		$headers = ['Key', 'Value'];
82
83		$rows = [
84		[ 'Id' , $assignment->id],
85		[ 'Name' , $assignment->name],
86		[ 'Repository uri' , $assignment->repository_uri],
87		[ 'Repository type' , $assignment->repository_type],
88		[ 'Forge Site' , $assignment->forge_site],
89		[ 'Forge server' , $assignment->forge_server],
90		[ 'Groups' , join(', ', collect($assignment->groups)->pluck('name')->toArray()) ],
91		[ 'Users' , join(', ', collect($assignment->users)->pluck('name')->toArray())],
92		[ 'Teachers' , join(', ', collect($assignment->assignators)->pluck('name')->toArray())],
93		[ 'Created' , $assignment->created_at],
94		[ 'Updated' , $assignment->updated_at]
95		];
96
97		$this->table($headers, $rows);
98		}
99
100		/**
101		* Show assignment.
102		*
103		* @return array\|mixed
104		*/
105	View Code Duplication	protected function fetch_assignment()
		0 ignored issues – show Duplication introduced 2018-03-14 17:57 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...
106		{
107		$uri = str_replace('{assignment}', $this->assignment, config('forge-publish.show_assignment_uri'));
108		$url = config('forge-publish.url') . $uri;
109		try {
110		$response = $this->http->get($url, [
111		'headers' => [
112		'X-Requested-With' => 'XMLHttpRequest',
113		'Authorization' => 'Bearer ' . fp_env('ACACHA_FORGE_ACCESS_TOKEN')
114		]
115		]);
116		} catch (\Exception $e) {
117		$this->error('And error occurs connecting to the api url: ' . $url);
118		$this->error('Status code: ' . $e->getResponse()->getStatusCode() . ' \| Reason : ' . $e->getResponse()->getReasonPhrase());
		0 ignored issues – show Bug introduced 2017-12-04 16:40 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getResponse()` does only exist in the following sub-classes of `Exception`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\RequestException`, `GuzzleHttp\Exception\ServerException`, `GuzzleHttp\Exception\TooManyRedirectsException`. 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...
119		}
120		return json_decode((string) $response->getBody());
121		}
122
123		/**
124		* Abort command execution.
125		*/
126		protected function abortCommandExecution()
127		{
128		$this->abortsIfEnvVarIsNotInstalled('ACACHA_FORGE_ACCESS_TOKEN');
129		}
130		}
131

acacha / forge-publish

PublishShowAssignment::abortCommandExecution() A last analyzed 2018-03-14 17:57 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

PublishShowAssignment::abortCommandExecution() A
last analyzed 2018-03-14 17:57 UTC