Maestriam\Samurai\Entities\Source

Complexity

Total Complexity

10

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setTheme()	0	4	1
A	getDrive()	0	7	2
A	theme()	0	3	1
A	createFile()	0	7	1
A	loadContent()	0	7	1
A	filePath()	0	7	1
A	previewContent()	0	6	1
A	fileExists()	0	7	1
A	initDrive()	0	13	1

<?php

namespace Maestriam\Samurai\Entities;

use Maestriam\FileSystem\Foundation\Drive;
use Maestriam\FileSystem\Foundation\File\FileInfo;
use Maestriam\FileSystem\Support\FileSystem;

abstract class Source extends Foundation
{
    /**
     * Tema qual o arquivo pertence
     */
    protected Theme $themeInstance;

    /**
     * Nome do template
     */
    protected string $template;

    /**
     * Retorna os dados para a geração do arquivo composer.json
     *
     * @return array
     */
    abstract protected function placeholders() : array;
    
    /**
     * Retorna o nome do arquivo 
     *
     * @return string
     */
    abstract protected function filename() : string;
   
    /**
     * Define o tema que será 
     *
     * @param  Theme $theme
     * @return self
     */
    protected function setTheme(Theme $theme) : self
    {
        $this->themeInstance = $theme;
        return $this;
    }

    /**
     * Retorna a instância do tema
     *
     * @return Theme
     */
    protected function theme() : Theme
    {
        return $this->themeInstance;
    }

    /**
     * Retorna o drive para a manipulação de arquivos dentro do tema.    
     * Se não houver drive criado para o tema, configura um novo drive.  
     *
     * @return Drive
     */
    private function getDrive() : Drive
    {
        $name = $this->theme()->vendor()->package();

        $drive = FileSystem::drive($name);

        return ($drive->exists()) ? $drive : $this->initDrive($drive);

The expression return $drive->exists() ? $drive : $this->initDrive($drive) could return the type Illuminate\Contracts\Filesystem\Filesystem which is incompatible with the type-hinted return Maestriam\FileSystem\Foundation\Drive. Consider adding an additional type-check to rule them out.

The call to Illuminate\Filesystem\FilesystemAdapter::exists() has too few arguments starting with path.

$drive of type Illuminate\Contracts\Filesystem\Filesystem is incompatible with the type Maestriam\FileSystem\Foundation\Drive expected by parameter $drive of Maestriam\Samurai\Entities\Source::initDrive().

    }

    /**
     * Configura um novo drive para criação de tema   
     *
     * @param  Drive $drive
     * @return Drive
     */
    private function initDrive(Drive $drive) : Drive
    {
        $root = $this->theme()->paths()->root();
        $stub = $this->config()->template();
        $path = $this->config()->structure();

        $drive->structure()->root($root);
        $drive->structure()->template($stub);
        $drive->structure()->paths($path);

        $drive->save();

        return $drive;
    }

    /**
     * Executa a criação do arquivo, baseado em um template
     *
     * @return void
     */
    protected function createFile() : FileInfo
    {
        $drive    = $this->getDrive();
        $filename = $this->filename();
        $holders  = $this->placeholders();

        return $drive->template($this->template)->create($filename, $holders);

The expression return $drive->template($this->template)->create($filename, $holders) returns the type Maestriam\FileSystem\Foundation\File\FileInfo which is incompatible with the documented return type void.

    }

    /**
     * Retorna a previa do conteúdo do template já interpretado
     *
     * @return string
     */
    protected function previewContent() : string
    {
        $drive = $this->getDrive();
        $holders = $this->placeholders();

        return $drive->template($this->template)->preview($holders);
    }

    /**
     * Verifica se o arquivo existe, de acordo com o template
     *
     * @return boolean
     */
    protected function fileExists() : bool
    {
        $drive    = $this->getDrive();
        $template = $this->template;
        $filename = $this->filename();

        return $drive->template($template)->exists($filename);
    }

    protected function loadContent() : string 
    {
        $drive    = $this->getDrive();
        $template = $this->template;
        $filename = $this->filename();

        return $drive->template($template)->load($filename);

The expression return $drive->template($template)->load($filename) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    protected function filePath() : string 
    {
        $drive    = $this->getDrive();
        $template = $this->template;
        $filename = $this->filename();

        return $drive->template($template)->path($filename);
    }
}