phpgearbox / asset

src/Compilers/Css.php

<?php declare(strict_types=1);
////////////////////////////////////////////////////////////////////////////////
// __________ __             ________                   __________
// \______   \  |__ ______  /  _____/  ____ _____ ______\______   \ _______  ___
//  |     ___/  |  \\____ \/   \  ____/ __ \\__  \\_  __ \    |  _//  _ \  \/  /
//  |    |   |   Y  \  |_> >    \_\  \  ___/ / __ \|  | \/    |   (  <_> >    <
//  |____|   |___|  /   __/ \______  /\___  >____  /__|  |______  /\____/__/\_ \
//                \/|__|           \/     \/     \/             \/            \/
// -----------------------------------------------------------------------------
//          Designed and Developed by Brad Jones <brad @="bjc.id.au" />
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////

namespace Gears\Asset\Compilers;

use Autoprefixer;
use Gears\String\Str;
use Gears\Asset\Compilers\Base;
use Symfony\Component\Filesystem\Filesystem;

/**
 * Normally css files will reference other assets, such as images and fonts.
 *
 * When we build a new asset from the source css and that asset is saved
 * else where in our project, the paths to these other "binary" assets
 * may no longer point to the correct place.
 *
 * This compiler takes care of this issues for us.
 *
 * > NOTE: We do make the assumption however that the fonts and images are
 * > indeed located in the public web accessible document root. If your assets
 * > are not it is on you to move / copy them at build time.
 */
class Css extends Base
{
    public function compile(): string
    {
        // Run the parent compiler first, so that we are dealing with the
        // final/minfied source. If were to perform our link replacing before
        // then the minfier might find a pre-minified asset and simply use that.
        $source = parent::compile();

        // Grab the real paths to both the source file and the destination asset
        $css_asset_root = realpath($this->file->getPath());
        $destination_root = realpath($this->destination->getPath());

        // Lets find some urls in our css
        preg_match_all('/url\(([\'"]?.*?[\'"]?)\)/', $source, $matches);

        // Loop through the matches
        foreach ($matches[1] as $key => $match)
        {
            // Split the match into an array of file path parts
            $fileinfo = pathinfo(str_replace(["'", '"'], '', $match));

            // This is here really just to catter for font faces.
            $after_file_name = '';

            // Fonts in css sometimes contain some funny charcters that are not
            // part of the file name but are just there to deal with, yep you
            // guessed it... IE :(
            if (Str::s($fileinfo['extension'])->contains('?#'))

This code seems to be duplicated across your project.

            {
                $ext = '<START>'.$fileinfo['extension'].'<END>';
                $fileinfo['extension'] = Str::s($ext)->between('<START>', '?');
                $after_file_name = '?'.Str::s($ext)->between('?', '<END>');
            }

            // SVG fonts can have some sort of ID, I am no expert on this but
            // for our purposes we can safely ignore the id..
            if (Str::s($fileinfo['extension'])->contains('svg#'))

This code seems to be duplicated across your project.

            {
                $ext = '<START>'.$fileinfo['extension'].'<END>';
                $fileinfo['extension'] = 'svg';
                $after_file_name = '#'.Str::s($ext)->between('#', '<END>');
            }

            // Create the real path to the actual asset
            $css_asset_path = realpath
            (
                $css_asset_root.'/'.
                $fileinfo['dirname'].'/'.
                $fileinfo['filename'].'.'.
                $fileinfo['extension']
            );

            // Sometimes we don't get it right. Perhaps the URL was pointing to
            // somewhere on the web. In any case if can't find the actual file
            // on the filesystem its time to move on.
            if ($css_asset_path === false)
            {
                continue;
            }

            // Now lets calulate the relative path between the destination
            // location and the actual asset location.
            $css_asset_path = (new Filesystem())->makePathRelative
            (
                $css_asset_path,
                $destination_root
            );

            // Remove the last slash that is added
            // by the above relative path calulation
            if (Str::s($css_asset_path)->endsWith('/'))
            {
                $css_asset_path = substr($css_asset_path, 0, -1);
            }

            // Fix for windows enviroments
            $css_asset_path = Str::s($css_asset_path)->replace('\\', '/');

            // Do some search and replacing
            $source = (string) Str::s($source)->replace
            (
                'url('.$match.')',
                'url('.$css_asset_path.$after_file_name.')'
            );
        }

        // Next run autoprefixer over the css
        if ($this->autoprefix !== false)
        {
            $prefixer = new Autoprefixer();

            if (is_string($this->autoprefix) || is_array($this->autoprefix))
            {
                $prefixer->setBrowsers($this->autoprefix);
            }

            $source = $prefixer->compile($source);
        }

        // Return the css source with correct paths.
        return $source;
    }
}