Godbout\DashDocsetBuilder\Services\DocsetBuilder

Complexity

Total Complexity

13

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Test Coverage

Coverage

72.21%

Importance

Changes	2
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	grab()	0	11	3
A	new()	0	12	2
A	grabFromIndex()	0	4	1
A	grabFromDocset()	0	4	1
A	archive()	0	4	1
A	build()	0	5	1
A	grabFromSitemap()	0	4	1
A	__construct()	0	11	2
A	package()	0	28	1

<?php

namespace Godbout\DashDocsetBuilder\Services;

use Godbout\DashDocsetBuilder\Contracts\Docset;
use Illuminate\Console\Command as LaravelCommand;
use Illuminate\Support\Str;
use LaravelZero\Framework\Commands\Command;

class DocsetBuilder
{
    protected $docset;

    protected $newer;
    protected $grabber;
    protected $packager;
    protected $archiver;

    protected $command;


    public function __construct(?Docset $docset = null, ?Command $command = null)
    {
        $this->docset = $docset;
        $this->command = $command ?? new LaravelCommand();

        $this->newer = new DocsetNewer($this->command->argument('doc'));

It seems like $this->command->argument('doc') can also be of type string[]; however, parameter $docsetName of Godbout\DashDocsetBuilder\Services\DocsetNewer::__construct() does only seem to accept null|string, maybe add an additional type check?

        if ($this->docset) {
            $this->grabber = new DocsetGrabber($this->docset);
            $this->packager = new DocsetPackager($this->docset);
            $this->archiver = new DocsetArchiver($this->docset);
        }
    }

    public function new()
    {
        $class = Str::studly($this->command->argument('doc'));

It seems like $this->command->argument('doc') can also be of type string[]; however, parameter $value of Illuminate\Support\Str::studly() does only seem to accept string, maybe add an additional type check?

        if (! $class) {
            return $this->command->task('  - Never gonna give you up. Generating app/Docsets/RickAstley.php', function () {
                $this->newer->new();
            });
        }

        return $this->command->task("  - Generating app/Docsets/$class.php", function () {
            $this->newer->new();
        });
    }

    public function build()
    {
        $this->grab();
        $this->package();
        $this->archive();
    }

    public function grab()
    {
        if (method_exists($this->docset, 'grab')) {
            return $this->grabFromDocset();
        }

        if ($this->grabber->sitemapExists()) {
            return $this->grabFromSitemap();
        }

        return $this->grabFromIndex();
    }

    protected function grabFromDocset()
    {
        return $this->command->task('  - Downloading doc from docset custom instructions', function () {
            return $this->docset->grab();

The method grab() does not exist on null.

The method grab() does not exist on Godbout\DashDocsetBuilder\Contracts\Docset.

        });
    }

    protected function grabFromSitemap()
    {
        return $this->command->task('  - Downloading doc from sitemap', function () {
            return $this->grabber->grabFromSitemap();
        });
    }

    protected function grabFromIndex()
    {
        return $this->command->task('  - Downloading doc from index', function () {
            return $this->grabber->grabFromIndex();
        });
    }

    public function package()
    {
        $this->command->task('  - Remove previous .docset', function () {
            $this->packager->removePreviousDocsetFile();
        });

        $this->command->task('  - Create new .docset', function () {
            return $this->packager->createDocsetFile();
        });

        $this->command->task('  - Copy original doc files', function () {
            return $this->packager->copyDocFiles();
        });

        $this->command->task('  - Create Info.plist', function () {
            return $this->packager->createInfoPlist();
        });

        $this->command->task('  - Populate SQLiteIndex', function () {
            return $this->packager->createAndPopulateSQLiteIndex();
        });

        $this->command->task('  - Format doc files for Dash', function () {
            return $this->packager->formatDocFiles();
        });

        $this->command->task('  - Copy icons', function () {
            $this->packager->copyIcons();
        });
    }

    public function archive()
    {
        $this->command->task('  - Archiving package', function () {
            return $this->archiver->archive();
        });
    }
}