godbout / dash-docset-builder

app/Services/DocsetBuilder.php

<?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();

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

    public function new()
    {
        $newDocset = $this->command->argument('doc');

        if (! $newDocset) {
            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/' . Str::studly($newDocset) . '.php', function () use ($newDocset) {

It seems like $newDocset can also be of type array; however, parameter $value of Illuminate\Support\Str::studly() does only seem to accept string, maybe add an additional type check?

            $this->newer->new($newDocset);

It seems like $newDocset can also be of type array; however, parameter $newDocset of Godbout\DashDocsetBuilder\Services\DocsetNewer::new() does only seem to accept null|string, maybe add an additional type check?

        });
    }

    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();
        });
    }
}