PublishAssignmentGroups - Code Metrics - Inspection of "Sync" - acacha/forge-publish - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 274b6a...1a9054 )

by Sergi Tur

created 2017-12-04 16:38 UTC

PublishAssignmentGroups A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	131
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
dl	131
loc	131
rs	10
c	0
b	0
f	0
wmc	10
lcom	1
cbo	5

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	5	5	1
A	handle()	7	7	2
A	assignGroupsToAssignment()	21	21	3
A	askForGroups()	13	13	1
A	groups()	17	17	2
A	abortCommandExecution()	4	4	1

How to fix Duplicated Code

<?php

namespace Acacha\ForgePublish\Commands;

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

/**
 * Class PublishAssignmentGroups.
 *
 * @package Acacha\ForgePublish\Commands
 */
class PublishAssignmentGroups extends Command

{
    use InteractsWithLocalGithub, InteractsWithEnvironment;

    use AborstIfEnvVariableIsnotInstalled;

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'publish:assignment_groups {--group=* : The group/s assigned to this assignment}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Assign a group of users to the current assignment';

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

    /**
     * Groups
     *
     * @var array
     */
    protected $groups;

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

    /**
     * Execute the console command.
     *
     */
    public function handle()
    {
        $this->abortCommandExecution();

        $this->groups = $this->option('group') ? $this->argument('group') : $this->askForGroups();
        $this->assignGroupsToAssignment();
    }

    /**
     * Assign groups to assignment
     *
     * @return array|mixed
     */
    protected function assignGroupsToAssignment()
    {
        $assignment = fp_env('ACACHA_FORGE_ASSIGNMENT');
        foreach ( $this->groups as $group) {
            $uri = str_replace('{assignment}', $assignment, config('forge-publish.assign_group_to_assignment_uri'));
            $uri = str_replace('{group}', $group, $uri);
            $url = config('forge-publish.url') . $uri;
            try {
                $response = $this->http->post($url, [
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                    '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 [];
            }
        }
    }

    /**
     * Ask for groups.
     *
     * @return string
     */
    protected function askForGroups()
    {
        $default = 0;
        $groups = $this->groups();
        $group_names = collect($groups)->pluck('name')->toArray();
        $selected_group_names =  $this->choice('Groups?', $group_names ,$default, null, true);

        $groups = collect($groups)->filter(function ($group) use ($selected_group_names) {
            return in_array($group->name,$selected_group_names);
        });

        return $groups->pluck('id');
    }

    /**
     * Get groups
     */
    protected function groups()
    {
        $url = config('forge-publish.url') . config('forge-publish.list_groups_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 [];
        }
        return json_decode((string) $response->getBody());
    }

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


1		<?php
2
3		namespace Acacha\ForgePublish\Commands;
4
5		use Acacha\ForgePublish\Commands\Traits\AborstIfEnvVariableIsnotInstalled;
6		use Acacha\ForgePublish\Commands\Traits\InteractsWithEnvironment;
7		use Acacha\ForgePublish\Commands\Traits\InteractsWithLocalGithub;
8		use GuzzleHttp\Client;
9		use Illuminate\Console\Command;
10
11		/**
12		* Class PublishAssignmentGroups.
13		*
14		* @package Acacha\ForgePublish\Commands
15		*/
16	View Code Duplication	class PublishAssignmentGroups extends Command
		0 ignored issues – show Duplication introduced 2017-12-04 16:40 UTC by Report Bug Copy Issue Report This class 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...
17		{
18		use InteractsWithLocalGithub, InteractsWithEnvironment;
19
20		use AborstIfEnvVariableIsnotInstalled;
21
22		/**
23		* The name and signature of the console command.
24		*
25		* @var string
26		*/
27		protected $signature = 'publish:assignment_groups {--group=* : The group/s assigned to this assignment}';
28
29		/**
30		* The console command description.
31		*
32		* @var string
33		*/
34		protected $description = 'Assign a group of users to the current assignment';
35
36		/**
37		* Server names.
38		*
39		* @var Client
40		*/
41		protected $http;
42
43		/**
44		* Groups
45		*
46		* @var array
47		*/
48		protected $groups;
49
50		/**
51		* SaveEnvVariable constructor.
52		*
53		*/
54		public function __construct(Client $http)
55		{
56		parent::__construct();
57		$this->http = $http;
58		}
59
60		/**
61		* Execute the console command.
62		*
63		*/
64		public function handle()
65		{
66		$this->abortCommandExecution();
67
68		$this->groups = $this->option('group') ? $this->argument('group') : $this->askForGroups();
69		$this->assignGroupsToAssignment();
70		}
71
72		/**
73		* Assign groups to assignment
74		*
75		* @return array\|mixed
76		*/
77		protected function assignGroupsToAssignment()
78		{
79		$assignment = fp_env('ACACHA_FORGE_ASSIGNMENT');
80		foreach ( $this->groups as $group) {
81		$uri = str_replace('{assignment}', $assignment, config('forge-publish.assign_group_to_assignment_uri'));
82		$uri = str_replace('{group}', $group, $uri);
83		$url = config('forge-publish.url') . $uri;
84		try {
85		$response = $this->http->post($url, [
		0 ignored issues – show Unused Code introduced 2017-12-04 16:40 UTC by Report Bug Copy Issue Report `$response` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
86		'headers' => [
87		'X-Requested-With' => 'XMLHttpRequest',
88		'Authorization' => 'Bearer ' . fp_env('ACACHA_FORGE_ACCESS_TOKEN')
89		]
90		]);
91		} catch (\Exception $e) {
92		$this->error('And error occurs connecting to the api url: ' . $url);
93		$this->error('Status code: ' . $e->getResponse()->getStatusCode() . ' \| Reason : ' . $e->getResponse()->getReasonPhrase());
		0 ignored issues – show Bug introduced 2017-12-04 13:01 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...
94		return [];
95		}
96		}
97		}
98
99		/**
100		* Ask for groups.
101		*
102		* @return string
103		*/
104		protected function askForGroups()
105		{
106		$default = 0;
107		$groups = $this->groups();
108		$group_names = collect($groups)->pluck('name')->toArray();
109		$selected_group_names = $this->choice('Groups?', $group_names ,$default, null, true);
110
111		$groups = collect($groups)->filter(function ($group) use ($selected_group_names) {
112		return in_array($group->name,$selected_group_names);
113		});
114
115		return $groups->pluck('id');
116		}
117
118		/**
119		* Get groups
120		*/
121		protected function groups()
122		{
123		$url = config('forge-publish.url') . config('forge-publish.list_groups_uri');
124		try {
125		$response = $this->http->get($url, [
126		'headers' => [
127		'X-Requested-With' => 'XMLHttpRequest',
128		'Authorization' => 'Bearer ' . fp_env('ACACHA_FORGE_ACCESS_TOKEN')
129		]
130		]);
131		} catch (\Exception $e) {
132		$this->error('And error occurs connecting to the api url: ' . $url);
133		$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...
134		return [];
135		}
136		return json_decode((string) $response->getBody());
137		}
138
139		/**
140		* Abort command execution.
141		*/
142		protected function abortCommandExecution()
143		{
144		$this->abortsIfEnvVarIsNotInstalled('ACACHA_FORGE_ASSIGNMENT');
145		}
146		}
147

acacha / forge-publish

Push — master ( 274b6a...1a9054 )

PublishAssignmentGroups A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like