setup.php

<?php

/**
 * SETUP BOILERPLATE
 *
 * 1. Edit the setup.json file with details for your new module.
 * 2. run 'php setup.php'
 * 3. run 'php build.php'
 *
 * All keys in setup.json are transformed to keys according to the following pattern
 * {{BPREPLACE[JSONKEY]}}
 *
 * [JSONKEY] is replaced by an uppercase version of the key.
 *
 * This script will self destruct when done.
 * Track with git to be able to reverse changes.
 *
 * Avabile replacement keys are:
 * {{BPREPLACENAME}}
 * {{BPREPLACEDESCRIPTION}}
 * {{BPREPLACESLUG}}
 * {{BPREPLACESLUGCAMELCASE}}
 * {{BPREPLACENAMESPACE}}
 * {{BPREPLACECAPSCONSTANT}}
 * {{BPREPLACEAUTHOR}}
 * {{BPREPLACEAUTHOREMAIL}}
 * {{BPREPLACEGITHUB}}
 *
 */

class Setup
{
    private static $config;
    private static $folders = ['source'];
    private static $searchableFileTypes = ['php', 'scss', 'js'];

    public function __construct()
    {
        self::info("Starting setup");

        if (self::$config = self::getConfig()) {

            //Traverse directories and make replacements
            $filesToReplace = self::getFilesList();
            if (is_array($filesToReplace) && !empty($filesToReplace)) {
                foreach ($filesToReplace as $file) {
                    self::updateFile($file);
                }
            } else {
                self::err("No files found to replace");
            }

            //Manually replacement targets
            self::updateFile(self::getBasePath() . 'package.json');
            self::updateFile(self::getBasePath() . 'composer.json');
            self::updateFile(self::getBasePath() . 'webpack.config.js');
            self::updateFile(self::getBasePath() . 'README-boilerplate.md');
            self::updateFile(self::getBasePath() . 'modularity-boilerplate.php');
            self::updateFile(self::getBasePath() . 'Public.php');

            //Remove readme.md & replace with template
            self::removeFile(self::getBasePath() . 'README.md');
            self::moveFile(
                self::getBasePath() . 'README-boilerplate.md',
                self::getBasePath() . 'README.md'
            );

            //Rename main file
            self::moveFile(
                self::getBasePath() . 'modularity-boilerplate.php',
                self::getBasePath() . 'modularity-' . self::$config->slug . '.php'
            );

            //Rename module files
            self::moveFile(
                self::getBasePath() . 'source/php/Module/Boilerplate.php',
                self::getBasePath() . 'source/php/Module/' . self::$config->slugcamelcase . '.php'
            );
            self::moveFile(
                self::getBasePath() . 'source/php/Module/views/boilerplate.blade.php',
                self::getBasePath() . 'source/php/Module/views/' . self::$config->slug . '.blade.php'
            );

            //Rename asset source files
            self::moveFile(
                self::getBasePath() . 'source/js/modularity-boilerplate.js',
                self::getBasePath() . 'source/js/modularity-' . self::$config->slug . '.js'
            );
            self::moveFile(
                self::getBasePath() . 'source/sass/modularity-boilerplate.scss',
                self::getBasePath() . 'source/sass/modularity-' . self::$config->slug . '.scss'
            );

            //Remove me
            if (self::remove()) {
                self::log("All done! Now go and make something beautiful!", 'info');
            }
        } else {
            self::log("Exiting setup");
        }
    }

    /**
     * Get files lists
     *
     * @return array
     */
    private static function getFilesList()
    {
        $files = [];

        if (empty(self::$folders) || !is_array(self::$folders)) {
            self::err("No folders to scan for replacements.");
            return $files;
        }

        foreach (self::$folders as $folder) {
            $iterator   = new \RecursiveIteratorIterator(
                new \RecursiveDirectoryIterator(
                    self::getBasePath() . $folder,
                    \RecursiveDirectoryIterator::SKIP_DOTS
                ),
            );

            foreach ($iterator as $info) {
                if (!$info->isFile()) {
                    continue;
                }

                if ($info->isFile() && $fileType = $info->getExtension()) {
                    if (!in_array($fileType, self::$searchableFileTypes)) {
                        continue;
                    }
                }

                $files[] = $info->getPathname();
            }
        }

        return $files;
    }

    /**
     * Replace contents of composer json
     *
     * @return void
     */
    private static function updateFile($filename)
    {
        foreach (self::$config as $key => $value) {
            $result = self::makeReplacements(
                "{{BPREPLACE" . strtoupper($key) . "}}",
                $value,
                $filename
            );

            if (!$result) {
                self::err("Failed to replace " . $filename);
                break;
            }
        }

        if ($result) {
            self::log("Updated " . $filename);
        }
    }

    /**
     * Move a file
     *
     * @return bool
     */
    private static function moveFile($from, $to)
    {
        if (rename($from, $to)) {
            self::log("Moved file " . $from . " to " . $to);
            return true;
        }
        self::err("Could not move file " . $from . " to " . $to);
        return false;
    }

    /**
     * Replace contents of file
     *
     * @param string $from
     * @param string $to
     * @param string $filename
     * @return bool
     */
    private static function makeReplacements($from, $to, $filename)
    {

        if (!file_exists($filename)) {
            return false;
        }

        $content = str_replace(
            $from,
            $to,
            file_get_contents($filename)
        );

        if (!file_put_contents($filename, $content)) {
            return false;
        }

        return true;
    }

    /**
     * Get config
     *
     * @return bool | string
     */
    private static function getConfig()
    {
        if (file_exists(self::getConfigPath())) {
            self::log("Found config file in " . self::getConfigPath());
            return (object) json_decode(
                file_get_contents(self::getConfigPath()),
                true
            );
        } else {
            self::log("Could not find config file in " . self::getConfigPath());
        }
        return false;
    }

    /**
     * Get configuration file path
     *
     * @return string
     */
    private static function getConfigPath()
    {
        return self::getBasePath() . 'setup.json';
    }

    /**
     * Get base path
     *
     * @return string
     */
    private static function getBasePath()
    {
        return rtrim(__DIR__, '/') . "/";
    }

    /**
     * Log message to user
     *
     * @param string $message   The message
     * @param string $type    Should not be changed
     */
    private static function log($message, $type = null, $trimPath = true)
    {
        //Trim path in log msg, to make them readable
        if ($trimPath === true) {
            $message = str_replace(__DIR__, '', $message);
        }

        //Set type
        if (is_null($type)) {
            $type = __FUNCTION__;
        }

        //Print
        echo self::getColor($type) . "[" . strtoupper($type) . "] " . $message . "\n";
    }

    /**
     * Get colorcoding for messages
     *
     * @param string $type
     */
    private static function getColor($type)
    {
        if ($type == 'info') {
            return "\033[0;95m";
        }
        if ($type == 'log') {
            return "\033[0;32m";
        }
        if ($type == 'err') {
            return "\033[0;31m";
        }
    }

    /**
     * Invoke log, but with error prefix.
     *
     * @param string $message
     */
    private static function err($message)
    {
        self::log($message, __FUNCTION__);
    }

    /**
     * Invoke log, but with info prefix.
     *
     * @param string $message
     */
    private static function info($message)
    {
        self::log($message, __FUNCTION__);
    }

    /**
     * Remove a file
     *
     * @return bool
     */
    private static function removeFile($file)
    {
        if (!unlink($file)) {
            self::err("Failed to remove " . $file);
            return false;
        }
        self::log("Removed file " . $file);
        return true;
    }

    /**
     * Remove this setup script
     */
    private static function remove()
    {
        $files = [
            self::getBasePath() . "setup.json",
            self::getBasePath() . "setup.php"
        ];

        if (!empty($files) && is_array($files)) {
            foreach ($files as $file) {
                self::removeFile($file);
            }
            return true;
        }
        self::err("Nothing to delete.");
        return false;
    }
}

new Setup();