maestriam / samurai

src/Entities/Directive.php

<?php

namespace Maestriam\Samurai\Entities;

use Illuminate\Support\Str;
use Maestriam\Samurai\Entities\Theme;
use Illuminate\Support\Facades\Blade;
use Maestriam\FileSystem\Support\FileSystem;
use Maestriam\Samurai\Contracts\Entities\DirectiveContract;
use Maestriam\Samurai\Exceptions\DirectiveExistsException;
use Maestriam\Samurai\Exceptions\InvalidDirectiveNameException;
use Maestriam\Samurai\Exceptions\InvalidTypeDirectiveException;
use ReflectionClass;

abstract class Directive extends Source implements DirectiveContract
{
    /**
     * Nome da diretiva
     *
     * @var string
     */
    protected string $name;

    /**
     * Sentença que foi inserida pelo usuário,
     * que irá fornecer o nome/sub-diretório
     *
     * @var string
     */
    protected string $sentence;

    /**
     * Tipo da diretiva
     *
     * @var string
     */
    protected string $type;

    /**
     * Tema de origem
     *
     * @var Theme
     */
    protected $theme;

    /**
     * Caminho do arquivo
     *
     * @var string
     */
    protected string $path;

    /**
     * Apelido pelo qual é chamado dentro do projeto,
     * como camel-case
     * 
     * @var string
     */
    protected string $camelAlias;

    /**
     * Apelido pelo qual é chamado dentro do projeto,
     * como camel-case
     * 
     * @var string
     */
    protected string $kebabAlias;

    /**
     * Instância as regras de negócio de uma diretiva
     *
     * @param Theme  $theme
     * @param string $sentence
     */
    public function __construct(Theme $theme, string $sentence)
    {
        $this->init($theme, $sentence, $this->type());
    }

    /**
     * {@inheritDoc}
     */
    public function sentence() : string
    {
        return $this->sentence;
    }

    /**
     * {@inheritDoc}
     */
    public function type() : string
    {
        return $this->type;
    }

    /**
     * {@inheritDoc}
     */
    public function path() : string
    {
        return $this->path;
    }

    /**
     * {@inheritDoc}
     */
    public function alias() : object
    {
        return (object) [
            'camel' => $this->camelAlias,
            'kebab' => $this->kebabAlias,
        ];
    }

    /**
     * {@inheritDoc}
     */
    public function filename() : string
    {        
        return $this->nominator()->filename($this->sentence(), $this->type());
    }

    /**
     * {@inheritDoc}
     */
    public function placeholders() : array
    {
        return ['name' => $this->name];
    }

    /**
     * Retorna o nome da diretiva.  
     *
     * @return string
     */
    public function name() : string
    {
        return $this->name;
    }

    /**
     * {@inheritDoc}
     */
    public function create() : Component|Includer
    {
        if ($this->exists()) {
            throw new DirectiveExistsException($this->name(), $this->theme()->package());
        }

        $this->createFile();
        $this->setPath();

        return $this;

The expression return $this returns the type Maestriam\Samurai\Entities\Directive which includes types incompatible with the type-hinted return Maestriam\Samurai\Entities\Component|Maestriam\Samurai\Entities\Includer.

    }

    /**
     * {@inheritDoc}
     */
    public function load() : Component|Includer
    {                
        $alias = $this->alias();
        $view  = $this->getViewComponent();

        if ($view) {
            return $this->loadViewComponent($alias->kebab, $view);

The expression return $this->loadViewComponent($alias->kebab, $view) returns the type Maestriam\Samurai\Entities\Directive which includes types incompatible with the type-hinted return Maestriam\Samurai\Entities\Component|Maestriam\Samurai\Entities\Includer.

        }

        $namespace = $this->theme()->namespace();
        
        $path = $this->relative();
        $file = $this->nominator()->blade($namespace, $path);

        $this->loadKebabAlias($file, $alias->kebab);

        if ($this->type() == 'include') {
            return $this->loadInclude($file, $alias->camel);

The expression return $this->loadInclude($file, $alias->camel) returns the type Maestriam\Samurai\Entities\Directive which includes types incompatible with the type-hinted return Maestriam\Samurai\Entities\Component|Maestriam\Samurai\Entities\Includer.

        }
        
        return $this->loadComponent($file, $alias->camel);

The expression return $this->loadComponent($file, $alias->camel) returns the type Maestriam\Samurai\Entities\Directive which includes types incompatible with the type-hinted return Maestriam\Samurai\Entities\Component|Maestriam\Samurai\Entities\Includer.

    }

    private function loadViewComponent($alias, $view) : Directive
    {
        Blade::component($alias,  $view);

        return $this;
    }

    private function getViewComponent() : ?string
    {        
        $view = null;
        $name = Str::studly($this->name);
     
        $classes = get_declared_classes();

        foreach($classes as $class) {     
            
            if (! $this->isViewComponent($class, $name)) {
                continue;
            }

            $view = $class;
        }

        return $view;
    }

    private function isViewComponent(string $class, string $name) : bool
    {
        if (! is_subclass_of($class, ViewComponent::class)) {
            return false;
        }

        if ($name != class_basename($class)) {
            return false;
        }

        return true;
    }
    
    /**
     * Retorna o caminho relativo da diretiva dentro do tema
     *
     * @return string
     */
    public function relative() : string
    {
        $path = $this->path();

        $base = $this->theme()->paths()->root() . DS;
        $base = FileSystem::folder($base)->sanitize();    

        return str_replace($base, '', $path);
    }

    /**
     * Retorna se a diretiva existe ou não dentro do projeto.  
     *
     * @return boolean
     */
    public function exists() : bool
    {
        return $this->fileExists();
    }

    /**
     * Carrega a diretiva (include/component) dentro do projeto como kebab-case.  
     * Padrão utilizado no Blade UI.  
     *
     * @param  string $file
     * @param  string $alias
     * @return Directive
     */
    private function loadKebabAlias(string $file, string $alias) : Directive
    {       
        Blade::component($file, $alias);
        
        return $this;
    }
    
    /**
     * Carrega o include dentro do projeto como camel-case.  
     * Padrão utilizado no Blade padrão.
     *
     * @param  string $file
     * @param  string $alias
     * @return Directive
     */
    protected function loadInclude(string $file, string $alias) : Directive
    {        
        Blade::aliasInclude($file, $alias);   

        return $this;
    }

    /**
     * Carrega o include dentro do projeto como camel-case.  
     * Padrão utilizado no Blade padrão.
     *
     * @param  string $file
     * @param  string $alias
     * @return Directive
     */
    protected function loadComponent(string $file, string $alias) : Directive
    {
        Blade::aliasComponent($file, $alias);   
        
        return $this;
    }

    /**
     * Carrega todas as informações da diretiva através do tema,
     * nome da diretiva e com seu tipo
     *
     * @param  Theme  $theme
     * @param  string $sentence
     * @param  string $type
     * @return void
     */
    protected function init(Theme $theme, string $sentence, string $type) : void
    {
        $this->setTheme($theme);        
        $this->setType($type);
        $this->setSentence($sentence);
        $this->setName($sentence);
        $this->setAlias();
        $this->setPath();
    }

    /**
     * Define a sentença que foi inserida pelo usuário via console,
     * que irá fornecer o nome/sub-diretório
     *
     * @param  Theme $theme
     * @return Directive
     * @throws InvalidDirectiveNameException
     */
    protected function setSentence(string $sentence) : Directive
    {
        $parsed = $this->parser()->filename($sentence);

Are you sure the assignment to $parsed is correct as $this->parser()->filename($sentence) targeting Maestriam\Samurai\Foundation\FilenameParser::filename() seems to always return null.

        if (! $parsed) {

$parsed is of type null, thus it always evaluated to false.

            throw new InvalidDirectiveNameException($sentence);
        }

        if (! $this->valid()->directive($parsed->name)) {
            throw new InvalidDirectiveNameException($sentence);
        }

        $this->sentence = strtolower($sentence);
        return $this;
    }
    
    /**
     * Define o tipo da diretiva
     *
     * @param  string $type
     * @return Directive
     * @throws InvalidDirectiveNameException
     */
    protected function setType(string $type) : Directive
    {
        if (! $this->valid()->type($type)) {
            throw new InvalidTypeDirectiveException($type);
        }

        $this->type = $type;
        return $this;
    }

    /**
     * Define o caminho absoluto do arquivo composer.json dentro do tema
     *
     * @param  string $path
     * @return Composer
     */
    protected function setPath() : Directive
    {
        $this->path = $this->filePath();
        return $this;

The expression return $this returns the type Maestriam\Samurai\Entities\Directive which is incompatible with the documented return type Maestriam\Samurai\Entities\Composer.

    }

    /**
     * Define o nome da diretiva
     *
     * @param  string $name
     * @return Directive
     */
    protected function setName(string $name) : Directive
    {
        $parsed = $this->parser()->filename($name);

Are you sure the assignment to $parsed is correct as $this->parser()->filename($name) targeting Maestriam\Samurai\Foundation\FilenameParser::filename() seems to always return null.

        $this->name = Str::slug($parsed->name);

        return $this;
    }

    /**
     * Define o alias para ser chamado dentro do projeto
     *
     * @return Directive
     */
    protected function setAlias() : Directive
    {
        $this->camelAlias = $this->nominator()->camelAlias($this->name);
        $this->kebabAlias = $this->nominator()->kebabAlias($this->name);

        return $this;
    }
}