Medianet-Tunisia / backpack-form

src/AutomaticServiceProvider.php

<?php

namespace MedianetDev\BackpackForm;

/**
 * This trait automatically loads package stuff, if they're present
 * in the expected directory. Stick to the conventions and
 * your package will "just work". Feel free to override
 * any of the methods below in your ServiceProvider
 * if you need to change the paths.
 */
trait AutomaticServiceProvider
{
    public function __construct($app)
    {
        $this->app = $app;

The property app does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->path = __DIR__.'/..';

The property path does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * -------------------------
     * SERVICE PROVIDER DEFAULTS
     * -------------------------
     */

    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot(): void
    {
        if ($this->packageDirectoryExistsAndIsNotEmpty('bootstrap') &&
            file_exists($helpers = $this->packageHelpersFile())) {
            require $helpers;
        }

        if ($this->packageDirectoryExistsAndIsNotEmpty('resources/lang')) {
            $this->loadTranslationsFrom($this->packageLangsPath(), $this->vendorNameDotPackageName());

It seems like loadTranslationsFrom() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if ($this->packageDirectoryExistsAndIsNotEmpty('resources/views')) {
            // Load published views
            $this->loadViewsFrom($this->publishedViewsPath(), $this->vendorNameDotPackageName());

It seems like loadViewsFrom() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            // Fallback to package views
            $this->loadViewsFrom($this->packageViewsPath(), $this->vendorNameDotPackageName());
        }

        if ($this->packageDirectoryExistsAndIsNotEmpty('database/migrations')) {
            $this->loadMigrationsFrom($this->packageMigrationsPath());

It seems like loadMigrationsFrom() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if ($this->packageDirectoryExistsAndIsNotEmpty('routes')) {
            $this->loadRoutesFrom($this->packageRoutesFile());

It seems like loadRoutesFrom() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        // Publishing is only necessary when using the CLI.
        if ($this->app->runningInConsole()) {
            $this->bootForConsole();
        }
    }

    /**
     * Register any package services.
     *
     * @return void
     */
    public function register(): void
    {
        if ($this->packageDirectoryExistsAndIsNotEmpty('config')) {
            $this->mergeConfigFrom($this->packageConfigFile(), $this->vendorNameDotPackageName());

It seems like mergeConfigFrom() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
    }

    /**
     * Console-specific booting.
     *
     * @return void
     */
    protected function bootForConsole(): void
    {
        // Publishing the configuration file.
        if ($this->packageDirectoryExistsAndIsNotEmpty('config')) {
            $this->publishes([

The method publishes() does not exist on MedianetDev\BackpackForm\AutomaticServiceProvider. Did you maybe mean publishedLangsPath()?

                $this->packageConfigFile() => $this->publishedConfigFile(),
            ], 'config');
        }

        // Publishing the views.
        if ($this->packageDirectoryExistsAndIsNotEmpty('resources/views')) {
            $this->publishes([
                $this->packageViewsPath() => $this->publishedViewsPath(),
            ], 'views');
        }

        // Publishing assets.
        if ($this->packageDirectoryExistsAndIsNotEmpty('resources/assets')) {
            $this->publishes([
                $this->packageAssetsPath() => $this->publishedAssetsPath(),
            ], 'assets');
        }

        // Publishing the translation files.
        if ($this->packageDirectoryExistsAndIsNotEmpty('resources/lang')) {
            $this->publishes([
                $this->packageLangsPath() => $this->publishedLangsPath(),
            ], 'lang');
        }

        // Registering package commands.
        if (!empty($this->commands)) {
            $this->commands($this->commands);

It seems like commands() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
    }

    /**
     * -------------------
     * CONVENIENCE METHODS
     * -------------------
     */

    protected function vendorNameDotPackageName()
    {
        return $this->vendorName.'.'.$this->packageName;
    }

    protected function vendorNameSlashPackageName()
    {
        return $this->vendorName.'/'.$this->packageName;
    }

    // -------------
    // Package paths
    // -------------

    protected function packageViewsPath() {
        return $this->path.'/resources/views';
    }

    protected function packageLangsPath() {
        return $this->path.'/resources/lang';
    }

    protected function packageAssetsPath() {
        return $this->path.'/resources/assets';
    }

    protected function packageMigrationsPath() {
        return $this->path.'/database/migrations';
    }

    protected function packageConfigFile() {
        return $this->path.'/config/'.$this->packageName.'.php';
    }

    protected function packageRoutesFile(): string
    {
        $packageRouteFile = $this->path . '/routes/' . $this->packageName . '.php';

        $projectRouteFile = base_path('routes/' . $this->packageName . '.php');

        $routeFilePathInUse = file_exists($projectRouteFile)
            ? $projectRouteFile
            : $packageRouteFile;

        if (!file_exists($routeFilePathInUse)) {
            throw new \RuntimeException(
                sprintf(
                    'No route file found for package "%s". Checked locations: %s and %s',
                    $this->packageName,
                    $packageRouteFile,
                    $projectRouteFile
                )
            );
        }

        return $routeFilePathInUse;
    }

    protected function packageHelpersFile() {
        return $this->path.'/bootstrap/helpers.php';
    }

    // ---------------
    // Published paths
    // ---------------

    protected function publishedViewsPath() {
        return base_path('resources/views/vendor/'.$this->vendorName.'/'.$this->packageName);
    }

    protected function publishedConfigFile() {
        return config_path($this->packageName.'.php');
    }

    protected function publishedAssetsPath() {
        return public_path('vendor/'.$this->vendorNameSlashPackageName());
    }

    protected function publishedLangsPath() {
        return resource_path('lang/vendor/'.$this->vendorName);
    }

    // -------------
    // Miscellaneous
    // -------------

    protected function packageDirectoryExistsAndIsNotEmpty($name)
    {
        // check if directory exists
        if (!is_dir($this->path.'/'.$name)) {
            return false;
        }

        // check if directory has files
        foreach (scandir($this->path.'/'.$name) as $file) {
            if ($file != '.' && $file != '..' && $file != '.gitkeep') {
                return true;
            }
        }

        return false;
    }
}