TomSchlick\Townhouse\BaseTenantableCommand

Complexity

Total Complexity

13

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	17	3
	handleTenant()	0	1	?
A	parseTenantInput()	0	19	3
A	getArguments()	0	4	1
A	getOptions()	0	8	1
A	fire()	0	4	1
A	bootstrapTenant()	0	10	4

<?php

namespace TomSchlick\Townhouse;

use Illuminate\Console\Command;
use Illuminate\Support\Collection;
use Symfony\Component\Console\Input\InputOption;

abstract class BaseTenantableCommand extends Command
{
    /**
     * Declare the handle method as final and use it to traverse through tenants.
     */
    final public function handle()
    {
        if (! $this->confirmToProceed()) {

The method confirmToProceed() does not exist on TomSchlick\Townhouse\BaseTenantableCommand. Did you maybe mean confirm()?

            return;
        }

        /** @var Tenant $tenant */
        foreach ($this->parseTenantInput() as $tenant) {

The expression $this->parseTenantInput() of type object<Illuminate\Support\Collection>|null is not guaranteed to be traversable. How about adding an additional type check?

            $this->info("Starting for tenant: {$tenant->id} - {$tenant->name}");

            $this->bootstrapTenant($tenant);

            $this->handleTenant($tenant);

            $this->info("\nFinished for tenant: " . $tenant->id);
        }
    }

    /**
     * @param \TomSchlick\Townhouse\Tenant $tenant
     *
     * @return void
     */
    abstract public function handleTenant(Tenant $tenant) : void;

    /**
     * Get or ask for the tenant(s) you'd like to run the commands on.
     *
     * @return \Illuminate\Support\Collection|null
     */
    protected function parseTenantInput() : ?Collection
    {
        if ($this->option('all')) {
            return Tenant::all();
        }

        $input_ids = $this->option('tenant')
            ? $this->option('tenant')
            : $this->ask('Which tenant would you like to use? [tenant_id]');

        return Tenant::find(
            array_map(
                function ($id) {
                    return trim($id);
                },
                explode(',', $input_ids)
            )
        );
    }

    /**
     * Get the console command arguments.
     *
     * @return array
     */
    public function getArguments()
    {
        return [];
    }

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['tenant', null, InputOption::VALUE_REQUIRED, 'The tenant you want to run the command as.'],
            ['all', null, InputOption::VALUE_NONE, 'Run all tenants instead of just one.'],
            ['force', null, InputOption::VALUE_NONE, 'Force the operation to run when in production.'],
        ];
    }

    /**
     * Override the fire method as well.
     */
    final public function fire()
    {
        $this->handle();
    }

    /**
     * Make Laravel ready for the tenant we want to run the command on.
     *
     * @param \TomSchlick\Townhouse\Tenant $tenant
     */
    protected function bootstrapTenant(Tenant $tenant)
    {
        if ($this->checkTenantDatabaseExists && ! $tenant->databaseExists()) {

The property checkTenantDatabaseExists does not exist. Did you maybe forget to declare it?

            $this->error('Tenant ' . $tenant->id . ' does not have a database setup.');
        }

        if ($tenant->databaseExists()) {
            $tenant->setCurrentTenantConfiguration();
        }
    }
}