Honeybadger\HoneybadgerLaravel\Commands\HoneybadgerInstallCommand

Complexity

Total Complexity

11

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	25	3
A	gatherConfig()	0	7	1
A	promptForApiKey()	0	4	1
A	sendTest()	0	13	1
A	writeEnv()	0	18	1
A	publishConfig()	0	8	2
A	outputSuccessMessage()	0	8	2

<?php

namespace Honeybadger\HoneybadgerLaravel\Commands;

use Honeybadger\Honeybadger;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Config;
use Honeybadger\HoneybadgerLaravel\CommandTasks;
use Honeybadger\HoneybadgerLaravel\Contracts\Installer;
use Honeybadger\HoneybadgerLaravel\Concerns\RequiredInput;

class HoneybadgerInstallCommand extends Command
{
    use RequiredInput;

    /**
     * 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';

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

    /**
     * @var \Honeybadger\HoneybadgerLaravel\Contracts\Installer;
     */
    protected $installer;

    /**
     * @var \Honeybadger\HoneybadgerLaravel\CommandTasks
     */
    protected $tasks;

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle(Installer $installer, CommandTasks $commandTasks)
    {
        $this->installer = $installer;
        $this->tasks = $commandTasks;
        $this->tasks->setOutput($this->output);

        $this->config = $this->gatherConfig();

        $this->writeEnv();

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

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

        $this->tasks->outputResults();

        $this->outputSuccessMessage(array_get($results ?? [], 'id', ''));
    }

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

    /**
     * Prompt for the API key.
     *
     * @return string
     */
    private function promptForApiKey() : string
    {
        return $this->requiredSecret('Your API key', 'The API key is required');
    }

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

        $result = $this->installer->sendTestException();

        $this->tasks->addTask(
            'Send test exception to Honeybadger',
            ! empty($result)
        );

        return $result;
    }

    /**
     * Write configuration values to the env files.
     *
     * @return void
     */
    private function writeEnv() : void
    {
        $this->tasks->addTask(
            'Write HONEYBADGER_API_KEY to .env',
            $this->installer->writeConfig(
                ['HONEYBADGER_API_KEY' => $this->config['api_key']],
                base_path('.env')
            )
        );

        $this->tasks->addTask(
            'Write HONEYBADGER_API_KEY placeholder to .env.example',
            $this->installer->writeConfig(
                ['HONEYBADGER_API_KEY' => ''],
                base_path('.env.example')
            )
        );
    }

    /**
     * Publish the config file for Lumen or Laravel.
     *
     * @return bool
     */
    public function publishConfig() : bool
    {
        if (app('honeybadger.isLumen')) {
            return $this->installer->publishLumenConfig();
        }

        return $this->installer->publishLaravelConfig();
    }

    /**
     * Output the success message.
     *
     * @param  string  $noticeId
     * @return void
     */
    private function outputSuccessMessage(string $noticeId) : void
    {
        if ($noticeId) {
            $this->line(SuccessMessage::withLinkToNotice($noticeId));
        } else {
            $this->line(SuccessMessage::withoutLinkToNotices());
        }
    }
}