felixarntz/boilerplate

<?php
/**
 * Class FelixArntz\Boilerplate\Util
 *
 * @package FelixArntz\Boilerplate
 * @license GNU General Public License v2 (or later)
 * @link    https://github.com/felixarntz/boilerplate
 */

namespace FelixArntz\Boilerplate;

use Composer\Util\Filesystem;

/**
 * Class containing static utility methods.
 *
 * @since 1.0.0
 */
class Util
{

    /**
     * Transforms a regular human-readable name to hyphen-case.
     *
     * @since 1.0.0
     *
     * @param string $name Input name. Is not checked against invalid characters.
     * @return string Name in hyphen-case.
     */
    public static function toHyphenCase(string $name) : string
    {
        return str_replace(' ', '-', $name);
    }

    /**
     * Transforms a regular human-readable name to underscore-case.
     *
     * @since 1.0.0
     *
     * @param string $name Input name. Is not checked against invalid characters.
     * @return string Name in underscore-case.
     */
    public static function toUnderscoreCase(string $name) : string
    {
        return str_replace(' ', '_', $name);
    }

    /**
     * Transforms a regular human-readable name to lower hyphen-case.
     *
     * @since 1.0.0
     *
     * @param string $name Input name. Is not checked against invalid characters.
     * @return string Name in hyphen-case.
     */
    public static function toHyphenLowerCase(string $name) : string
    {
        return static::toHyphenCase(strtolower($name));
    }

    /**
     * Transforms a regular human-readable name to lower underscore-case.
     *
     * @since 1.0.0
     *
     * @param string $name Input name. Is not checked against invalid characters.
     * @return string Name in underscore-case.
     */
    public static function toUnderscoreLowerCase(string $name) : string
    {
        return static::toUnderscoreCase(strtolower($name));
    }

    /**
     * Transforms a regular human-readable name to Pascal-case.
     *
     * @since 1.0.0
     *
     * @param string $name Input name. Is not checked against invalid characters.
     * @return string Name in Pascal-case.
     */
    public static function toPascalCase(string $name) : string
    {
        return str_replace(' ', '', ucwords($name));
    }

    /**
     * Transforms a regular human-readable name to camel-case.
     *
     * @since 1.0.0
     *
     * @param string $name Input name. Is not checked against invalid characters.
     * @return string Name in camel-case.
     */
    public static function toCamelCase(string $name) : string
    {
        return lcfirst(static::toPascalCase($name));
    }

    /**
     * Transforms a regular human-readable name to constant-case.
     *
     * @since 1.0.0
     *
     * @param string $name Input name. Is not checked against invalid characters.
     * @return string Name in constant-case.
     */
    public static function toConstantCase(string $name) : string
    {
        return str_replace(' ', '_', strtoupper($name));
    }

    /**
     * Generates an array with a range of version numbers.
     *
     * @since 1.0.0
     *
     * @param string $start     Version number to start with.
     * @param string $end       Version number to end with. Must be greater or equal than $start.
     * @param string $precision Optional. Precision for increasing version numbers. Either 'major', 'minor',
     *                          or 'patch'. Default 'minor'.
     * @return array Range of version numbers.
     */
    public static function versionRange(string $start, string $end, string $precision = 'minor') : array
    {
        switch ($precision) {
            case 'major':
                $decimals = 1;
                break;
            case 'patch':
                $decimals = 3;
                break;
            default:
                $decimals = 2;
        }

        $start = implode('.', array_slice(explode('.', $start), 0, $decimals));
        $end   = implode('.', array_slice(explode('.', $end), 0, $decimals));

        $range = [];
        while (version_compare($start, $end, '<=')) {
            $range[] = $start;

            $start = (int) str_replace('.', '', $start) + 1;
            $start = str_split((string) $start);
            if (count($start) > $decimals) {
                $start = array_shift($start) . implode('.', $start);
            } else {
                $start = implode('.', $start);
            }
        }

        return $range;
    }

    /**
     * Gets the absolute path to the package's root directory.
     *
     * @since 1.0.0
     *
     * @return string Absolute root directory path, without trailing slash.
     */
    public static function getRootPath() : string
    {
        return static::getAbsolutePath('');
    }

    /**
     * Gets the absolute path to a file within the package directory.
     *
     * @since 1.0.0
     *
     * @param string $file File path, relative to the package's root directory.
     * @return string Absolute file path.
     */
    public static function getAbsolutePath(string $file) : string
    {
        return (new Filesystem())->normalizePath(__DIR__ . '/../' . ltrim($file, '/'));
    }
}