ghaskell / scaffold

src/Scaffold.php

<?php

namespace Ghaskell\Scaffold;

use Ghaskell\Scaffold\Facades\Vibro;
use Ghaskell\Scaffold\ScaffoldException;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Str;

class Scaffold
{
    protected $model;
    protected $migration;
    protected $variables;
    protected $migrationFileName;
    protected $files;

    public $messages = [];
    public $created = [];



    public function __construct($migration)

The parameter $migration is not used and could be removed.

    {


    }

    public static function make($migrationName)
    {
        $scaffold =  new Scaffold($migrationName);
        $scaffold->files = new Filesystem();
        $scaffold->files->requireOnce($migrationName);
        $migrationInstance = $scaffold->resolve($name = $scaffold->getMigrationName($migrationName)); //parse into instance
        $reflector = new \ReflectionClass($migrationInstance);  //reflect
        $migrationFileName = $reflector->getFileName();
        $scaffold->migration = $scaffold->files->get($migrationFileName);
        $scaffold->model = ModelPattern::make($scaffold->migration);
        return $scaffold;

    }


    /**
     * Resolve a migration instance from a file.
     *
     * @param  string  $file
     * @return object
     */
    public function resolve($file)
    {
        $class = Str::studly(implode('_', array_slice(explode('_', $file), 4)));

        return new $class;
    }

    /**
     * Get the name of the migration.
     *
     * @param  string  $path
     * @return string
     */
    public function getMigrationName($path)
    {
        return str_replace('.php', '', basename($path));
    }

    /**
     * Get all of the migration files in a given path.
     *
     * @param  string|array  $paths
     * @return array
     */
    public function getMigrationFiles($paths)
    {
        return Collection::make($paths)->flatMap(function ($path) {
            return $this->files->glob($path.'/*_*.php');
        })->filter()->sortBy(function ($file) {
            return $this->getMigrationName($file);
        })->values()->keyBy(function ($file) {
            return $this->getMigrationName($file);
        })->all();
    }



    public function build($stub, $data)
    {
        $path = $this->getStubPath($stub);
        return Vibro::compileFile($path, $data);

The method compileFile() does not exist on Ghaskell\Scaffold\Facades\Vibro. Since you implemented __callStatic, consider adding a @method annotation.

    }

    protected function getStub($stub)
    {
        $stub = Str::camel($stub);
        if($this->files->exists(app_path("Scaffold/stubs/$stub.stub"))) {
                return $this->files->get(app_path("Scaffold/stubs/$stub.stub"));
        } else {
            return false;
        }
    }

    protected function getStubPath($stub)
    {
        $stub = Str::camel($stub);
        return app_path("Scaffold/stubs/$stub.stub");
    }

    
    public function addRoutes()
    {
        foreach(config('scaffold.routes') as $key => $route)
        {
            $namespace = Str::studly($key);
            $routeContent = $this->files->get($route['fileName']);
            $uri = Str::plural(strtolower(preg_replace(
                '/([a-zA-Z])(?=[A-Z])/',
                '$1-', $this->model->name
            )));


            if($key === 'web') {
                $routeString = "\n\nRoute::resource('$uri', '$namespace\\{$this->model->name}Controller')->only(['index', 'show']);";
            } else {
                $routeString = "\n\nRoute::apiResource('$uri', '$namespace\\{$this->model->name}Controller');";
            }

            if (!str_contains($routeContent, $routeString)) {
                $this->files->append($route['fileName'], $routeString);
            }
        }
        return $this;
    }

    public function generate($file)
    {
        $target = Str::camel(str_replace('build', '', $file));
        $config = config("scaffold.files.$target");
        if(empty($config)) {
            throw new ScaffoldException("Configuration for $file not found");
        }
        if(array_key_exists('dedependencies', $config)) {
            foreach($config['dependencies'] as $dependency) {
                $this->generate($dependency); //recursively generate dependencies
            }
        }
        $pathPrefix = $config['path'];
        $variables = ['model' => $this->model];

        if(!empty(config("scaffold.variables"))) {
            foreach (config("scaffold.variables") as $variable => $value) {
                $variables[$variable] = $this->compileVariable($value);
            }
        }

        $fileName = Vibro::compileFileName($config['fileNamePattern'], $variables);

The method compileFileName() does not exist on Ghaskell\Scaffold\Facades\Vibro. Since you implemented __callStatic, consider adding a @method annotation.

        $pathPrefix = base_path(Vibro::compileFileName("$pathPrefix", $variables));
        if($this->files->exists("$pathPrefix/$fileName")) {
            $this->messages[] = "File '$fileName' exists and was not overwritten.";
            return $this;
        }

        if(!$this->files->isDirectory($pathPrefix)) {
            $this->files->makeDirectory("$pathPrefix");
        }

        $content = $this->build($target, $variables);
        if($content) {
            $this->files->put("$pathPrefix/$fileName", $content);
            $this->created[] = "$pathPrefix/$fileName";
        } else {
            $this->messages[] = "File stub $target not found.";
        }

        return $this;

    }

    public function compileVariable($string) {
        $model = $this->model;

The assignment to $model is dead and can be removed.

        ob_start();
        eval( "echo $string;");

The use of eval() is discouraged.

        $output = ob_get_contents();
        ob_end_clean();

        return $output;
    }



}