Publish::__construct() - Code Metrics - Inspection of "Merge branch 'release/2.0.0'" - reliqarts/laravel-docweaver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3fdc21...2574b5 )

by ReliQ

created 2019-03-23 20:58 UTC

Publish::__construct() A

↳ Parent: Publish

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

declare(strict_types=1);

namespace ReliqArts\Docweaver\Console\Commands;

use Carbon\Carbon;
use Illuminate\Console\Command;
use ReliqArts\Docweaver\Contracts\Documentation\Publisher;
use ReliqArts\Docweaver\Exceptions\InvalidDirectory;

class Publish extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'docweaver:publish 
                            {product? : Product name}
                            {source? : Product repository}
                            {--y|y : Whether to skip confirmation}
                            ';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Publish documentation for product';

    /**
     * @var Publisher
     */
    protected $publisher;

    /**
     * Create a new command instance.
     *
     * @param Publisher $publisher
     */
    public function __construct(Publisher $publisher)
    {
        parent::__construct();

        $this->publisher = $publisher;
    }

    /**
     * Execute the console command.
     *
     * @throws InvalidDirectory
     */
    public function handle(): void
    {
        $productName = $this->argument('product');
        $productSource = $this->argument('source');
        $skipConfirmation = $this->option('y');
        $confirmationMessage = sprintf(
            "This command will attempt to pull documentation for product (%s) from %s}. \n"
            . 'Please ensure your internet connection is stable. Ready?',
            $productName,
            $productSource
        );

        $this->comment(PHP_EOL
            . "<info>♣♣♣</info> Docweaver DocumentationPublisher \n"
            . 'Help is here, try: php artisan docweaver:publish --help');

        if ($skipConfirmation || $this->confirm($confirmationMessage)) {

            $this->info("Publishing {$productName}.\nT: " . Carbon::now()->toCookieString() . "\n----------");

            $result = $this->publisher->publish($productName, $productSource, $this);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

            if ($result->isSuccess()) {
                $this->info(PHP_EOL . '----------');
                $this->comment("<info>✔</info> Done. {$result->getMessage()}");

                // Display results
                $this->line('');
                $headers = ['Time', 'Versions', 'Published', 'Updated'];
                $data = $result->getData();
                $rows = [[
                    $data->executionTime,
                    count($data->versions),
                    count($data->versionsPublished),
                    count($data->versionsUpdated),
                ]];
                $this->table($headers, $rows);
                $this->line(PHP_EOL);
            } else {
                $this->line(PHP_EOL . "<error>✘</error> {$result->getError()}");
            }
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace ReliqArts\Docweaver\Console\Commands;
6
7		use Carbon\Carbon;
8		use Illuminate\Console\Command;
9		use ReliqArts\Docweaver\Contracts\Documentation\Publisher;
10		use ReliqArts\Docweaver\Exceptions\InvalidDirectory;
11
12		class Publish extends Command
13		{
14		/**
15		* The name and signature of the console command.
16		*
17		* @var string
18		*/
19		protected $signature = 'docweaver:publish
20		{product? : Product name}
21		{source? : Product repository}
22		{--y\|y : Whether to skip confirmation}
23		';
24
25		/**
26		* The console command description.
27		*
28		* @var string
29		*/
30		protected $description = 'Publish documentation for product';
31
32		/**
33		* @var Publisher
34		*/
35		protected $publisher;
36
37		/**
38		* Create a new command instance.
39		*
40		* @param Publisher $publisher
41		*/
42		public function __construct(Publisher $publisher)
43		{
44		parent::__construct();
45
46		$this->publisher = $publisher;
47		}
48
49		/**
50		* Execute the console command.
51		*
52		* @throws InvalidDirectory
53		*/
54		public function handle(): void
55		{
56		$productName = $this->argument('product');
57		$productSource = $this->argument('source');
58		$skipConfirmation = $this->option('y');
59		$confirmationMessage = sprintf(
60		"This command will attempt to pull documentation for product (%s) from %s}. \n"
61		. 'Please ensure your internet connection is stable. Ready?',
62		$productName,
63		$productSource
64		);
65
66		$this->comment(PHP_EOL
67		. "<info>♣♣♣</info> Docweaver DocumentationPublisher \n"
68		. 'Help is here, try: php artisan docweaver:publish --help');
69
70	View Code Duplication	if ($skipConfirmation \|\| $this->confirm($confirmationMessage)) {
		0 ignored issues – show Duplication introduced 2019-03-05 23:19 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
71		$this->info("Publishing {$productName}.\nT: " . Carbon::now()->toCookieString() . "\n----------");
72
73		$result = $this->publisher->publish($productName, $productSource, $this);
		0 ignored issues – show Bug introduced 2019-03-23 21:00 UTC by Report Bug Copy Issue Report It seems like `$productName` defined by `$this->argument('product')` on line `56` can also be of type `array` or `null`; however, `ReliqArts\Docweaver\Cont...on\Publisher::publish()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string / function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history... Bug introduced 2019-03-23 21:00 UTC by Report Bug Copy Issue Report It seems like `$productSource` defined by `$this->argument('source')` on line `57` can also be of type `array` or `null`; however, `ReliqArts\Docweaver\Cont...on\Publisher::publish()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /* * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
74
75		if ($result->isSuccess()) {
76		$this->info(PHP_EOL . '----------');
77		$this->comment("<info>✔</info> Done. {$result->getMessage()}");
78
79		// Display results
80		$this->line('');
81		$headers = ['Time', 'Versions', 'Published', 'Updated'];
82		$data = $result->getData();
83		$rows = [[
84		$data->executionTime,
85		count($data->versions),
86		count($data->versionsPublished),
87		count($data->versionsUpdated),
88		]];
89		$this->table($headers, $rows);
90		$this->line(PHP_EOL);
91		} else {
92		$this->line(PHP_EOL . "<error>✘</error> {$result->getError()}");
93		}
94		}
95		}
96		}
97

reliqarts / laravel-docweaver

Push — master ( 3fdc21...2574b5 )

Publish::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like