HoneybadgerInstallCommand::sendTest() - Code Metrics - Inspection of "[WIP] Add installer command" - honeybadger-io/honeybadger-laravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#11)

by TJ

created 2018-08-20 13:18 UTC

HoneybadgerInstallCommand::sendTest() A

↳ Parent: HoneybadgerInstallCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Honeybadger\HoneybadgerLaravel\Commands;

use Honeybadger\Honeybadger;
use InvalidArgumentException;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Config;
use sixlive\DotenvEditor\DotenvEditor;

abstract class HoneybadgerInstallCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'honeybadger:install {apiKey?}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Install and configure Honeybadger';

    /**
     * Results of each step of the install.
     *
     * @var array
     */
    protected $results = [];

    /**
     * Configuration from gathered input.
     *
     * @var array
     */
    protected $config = [];

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        $this->config = $this->gatherConfig();

        $this->writeEnv();

        if ($this->shouldPublishConfig()) {
            $this->task(
                'Publish the config file',
                $this->publishConfig()
            );
        }

        if ($this->config['send_test']) {
            $this->sendTest();
        }

        $this->outputResults();
    }

    /**
     * Publish the configuration file to the framework.
     *
     * @return bool
     */
    abstract public function publishConfig();

    /**
     * Prompt for input and gather responses.
     *
     * @return array
     */
    private function gatherConfig()
    {
        return [
            'api_key' => $this->argument('apiKey') ?? $this->secret('Please enter your API key'),
            'send_test' => $this->confirm('Would you like to send a test exception now?', true),
        ];
    }

    /**
     * Send test exception to Honeybadger.
     *
     * @return void
     */
    private function sendTest()
    {
        Config::set('honeybadger.api_key', $this->config['api_key']);

        $this->task(
            'Send test exception to Honeybadger',
            $this->callSilent('honeybadger:test') === 0
        );
    }

    /**
     * Write configuration values to the env files.
     *
     * @return void
     */
    private function writeEnv()
    {
        $this->task(
            'Write HONEYBADGER_API_KEY to .env',
            $this->writeConfig(['HONEYBADGER_API_KEY' => $this->config['api_key']])
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        $this->task(
            'Write HONEYBADGER_API_KEY placeholder to .env.example',
            $this->writeConfig(['HONEYBADGER_API_KEY' => ''], '.env.example')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }

    /**
     * Whether the configuration needs to be published or no.
     *
     * @return bool
     */
    private function shouldPublishConfig()
    {
        return ! file_exists(base_path('config/honeybadger.php'));
    }

    /**
     * Write the configurations to dotenv files.
     *
     * @param  string  $config
     * @param  string  $file
     * @return bool
     */
    private function writeConfig($config, $file = '.env')
    {
        try {
            $env = new DotenvEditor;
            $env->load(base_path($file));
        } catch (InvalidArgumentException $e) {
            return false;
        }

        collect($config)->each(function ($value, $key) use ($env) {
            $env->set($key, $value);
        });

        return $env->save();
    }

    /**
     * Add the results of each installation step.
     *
     * @param  string  $name
     * @param  bool  $result
     * @return void
     */
    public function task($name, $result)
    {
        $this->results[$name] = $result;
    }

    /**
     * Output the results of each step of the installation.
     *
     * @return void
     */
    private function outputResults()
    {
        collect($this->results)->each(function ($result, $description) {
            $this->line(vsprintf('%s: %s', [
                $description,
                $result ? '<fg=green>✔</>' : '<fg=red>✘</>',
            ]));
        });
    }
}


1			<?php
2
3			namespace Honeybadger\HoneybadgerLaravel\Commands;
4
5			use Honeybadger\Honeybadger;
6			use InvalidArgumentException;
7			use Illuminate\Console\Command;
8			use Illuminate\Support\Facades\Config;
9			use sixlive\DotenvEditor\DotenvEditor;
10
11			abstract class HoneybadgerInstallCommand extends Command
12			{
13			/**
14			* The name and signature of the console command.
15			*
16			* @var string
17			*/
18			protected $signature = 'honeybadger:install {apiKey?}';
19
20			/**
21			* The console command description.
22			*
23			* @var string
24			*/
25			protected $description = 'Install and configure Honeybadger';
26
27			/**
28			* Results of each step of the install.
29			*
30			* @var array
31			*/
32			protected $results = [];
33
34			/**
35			* Configuration from gathered input.
36			*
37			* @var array
38			*/
39			protected $config = [];
40
41			/**
42			* Execute the console command.
43			*
44			* @return mixed
45			*/
46			public function handle()
47			{
48			$this->config = $this->gatherConfig();
49
50			$this->writeEnv();
51
52			if ($this->shouldPublishConfig()) {
53			$this->task(
54			'Publish the config file',
55			$this->publishConfig()
56			);
57			}
58
59			if ($this->config['send_test']) {
60			$this->sendTest();
61			}
62
63			$this->outputResults();
64			}
65
66			/**
67			* Publish the configuration file to the framework.
68			*
69			* @return bool
70			*/
71			abstract public function publishConfig();
72
73			/**
74			* Prompt for input and gather responses.
75			*
76			* @return array
77			*/
78			private function gatherConfig()
79			{
80			return [
81			'api_key' => $this->argument('apiKey') ?? $this->secret('Please enter your API key'),
82			'send_test' => $this->confirm('Would you like to send a test exception now?', true),
83			];
84			}
85
86			/**
87			* Send test exception to Honeybadger.
88			*
89			* @return void
90			*/
91			private function sendTest()
92			{
93			Config::set('honeybadger.api_key', $this->config['api_key']);
94
95			$this->task(
96			'Send test exception to Honeybadger',
97			$this->callSilent('honeybadger:test') === 0
98			);
99			}
100
101			/**
102			* Write configuration values to the env files.
103			*
104			* @return void
105			*/
106			private function writeEnv()
107			{
108			$this->task(
109			'Write HONEYBADGER_API_KEY to .env',
110			$this->writeConfig(['HONEYBADGER_API_KEY' => $this->config['api_key']])
			0 ignored issues – show Documentation introduced 2018-08-20 13:15 UTC by Report Bug Copy Issue Report `array('HONEYBADGER_API_K...his->config['api_key'])` is of type `array<string,?,{"HONEYBADGER_API_KEY":"?"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
111			);
112
113			$this->task(
114			'Write HONEYBADGER_API_KEY placeholder to .env.example',
115			$this->writeConfig(['HONEYBADGER_API_KEY' => ''], '.env.example')
			0 ignored issues – show Documentation introduced 2018-08-20 13:15 UTC by Report Bug Copy Issue Report `array('HONEYBADGER_API_KEY' => '')` is of type `array<string,string,{"HO...GER_API_KEY":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
116			);
117			}
118
119			/**
120			* Whether the configuration needs to be published or no.
121			*
122			* @return bool
123			*/
124			private function shouldPublishConfig()
125			{
126			return ! file_exists(base_path('config/honeybadger.php'));
127			}
128
129			/**
130			* Write the configurations to dotenv files.
131			*
132			* @param string $config
133			* @param string $file
134			* @return bool
135			*/
136			private function writeConfig($config, $file = '.env')
137			{
138			try {
139			$env = new DotenvEditor;
140			$env->load(base_path($file));
141			} catch (InvalidArgumentException $e) {
142			return false;
143			}
144
145			collect($config)->each(function ($value, $key) use ($env) {
146			$env->set($key, $value);
147			});
148
149			return $env->save();
150			}
151
152			/**
153			* Add the results of each installation step.
154			*
155			* @param string $name
156			* @param bool $result
157			* @return void
158			*/
159			public function task($name, $result)
160			{
161			$this->results[$name] = $result;
162			}
163
164			/**
165			* Output the results of each step of the installation.
166			*
167			* @return void
168			*/
169			private function outputResults()
170			{
171			collect($this->results)->each(function ($result, $description) {
172			$this->line(vsprintf('%s: %s', [
173			$description,
174			$result ? '<fg=green>✔</>' : '<fg=red>✘</>',
175			]));
176			});
177			}
178			}
179

honeybadger-io / honeybadger-laravel

GitHub Access Token became invalid

Pull Request — master (#11)

HoneybadgerInstallCommand::sendTest() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like