Cecil\Renderer\Twig\Extension

Complexity

Total Complexity

67

Size/Duplication

Total Lines	519
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	minify()	0	28	5
A	toCss()	0	27	4
A	getEnv()	0	3	2
A	sortByDate()	0	22	6
A	resize()	0	3	1
B	filterBy()	0	19	7
A	minifyJs()	0	5	1
A	getFunctions()	0	9	1
D	createUrl()	0	75	17
A	scssToCss()	0	5	1
A	getName()	0	3	1
A	__construct()	0	11	2
A	sortByWeight()	0	22	6
A	minifyCss()	0	5	1
A	readtime()	0	9	2
A	filterBySection()	0	3	1
A	hashFile()	0	7	2
A	excerpt()	0	10	2
A	getFilters()	0	15	1
A	sortByTitle()	0	8	2
A	excerptHtml()	0	10	2

<?php
/*
 * Copyright (c) Arnaud Ligny <arnaud@ligny.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Renderer\Twig;

use Cecil\Assets\Image;
use Cecil\Builder;
use Cecil\Collection\CollectionInterface;
use Cecil\Collection\Page\Collection as PagesCollection;
use Cecil\Collection\Page\Page;
use Cecil\Config;
use Cecil\Exception\Exception;
use Cecil\Util;
use Cocur\Slugify\Bridge\Twig\SlugifyExtension;
use Cocur\Slugify\Slugify;
use MatthiasMullie\Minify;
use ScssPhp\ScssPhp\Compiler;
use Symfony\Component\Filesystem\Filesystem;

/**
 * Class Twig\Extension.
 */
class Extension extends SlugifyExtension
{
    /**
     * @var Builder
     */
    protected $builder;
    /**
     * @var Config
     */
    protected $config;
    /**
     * @var string
     */
    protected $outputPath;
    /**
     * @var Filesystem
     */
    protected $fileSystem;
    /**
     * @var Slugify
     */
    private static $slugifier;

    /**
     * Constructor.
     *
     * @param Builder $builder
     */
    public function __construct(Builder $builder)
    {
        if (!self::$slugifier instanceof Slugify) {
            self::$slugifier = Slugify::create(['regexp' => Page::SLUGIFY_PATTERN]);
        }

        parent::__construct(self::$slugifier);

        $this->builder = $builder;
        $this->config = $this->builder->getConfig();
        $this->outputPath = $this->config->getOutputPath();
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'cecil';
    }

    /**
     * {@inheritdoc}
     */
    public function getFilters()
    {
        return [
            new \Twig\TwigFilter('filterBySection', [$this, 'filterBySection']),
            new \Twig\TwigFilter('filterBy', [$this, 'filterBy']),
            new \Twig\TwigFilter('sortByTitle', [$this, 'sortByTitle']),
            new \Twig\TwigFilter('sortByWeight', [$this, 'sortByWeight']),
            new \Twig\TwigFilter('sortByDate', [$this, 'sortByDate']),
            new \Twig\TwigFilter('urlize', [$this, 'slugifyFilter']),
            new \Twig\TwigFilter('minifyCSS', [$this, 'minifyCss']),
            new \Twig\TwigFilter('minifyJS', [$this, 'minifyJs']),
            new \Twig\TwigFilter('SCSStoCSS', [$this, 'scssToCss']),
            new \Twig\TwigFilter('excerpt', [$this, 'excerpt']),
            new \Twig\TwigFilter('excerptHtml', [$this, 'excerptHtml']),
            new \Twig\TwigFilter('resize', [$this, 'resize']),
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getFunctions()
    {
        return [
            new \Twig\TwigFunction('url', [$this, 'createUrl']),
            new \Twig\TwigFunction('minify', [$this, 'minify']),
            new \Twig\TwigFunction('readtime', [$this, 'readtime']),
            new \Twig\TwigFunction('toCSS', [$this, 'toCss']),
            new \Twig\TwigFunction('hash', [$this, 'hashFile']),
            new \Twig\TwigFunction('getenv', [$this, 'getEnv']),
        ];
    }

    /**
     * Filter by section.
     *
     * @param PagesCollection $pages
     * @param string          $section
     *
     * @return CollectionInterface
     */
    public function filterBySection(PagesCollection $pages, string $section): CollectionInterface
    {
        return $this->filterBy($pages, 'section', $section);
    }

    /**
     * Filter by variable.
     *
     * @param PagesCollection $pages
     * @param string          $variable
     * @param string          $value
     *
     * @return CollectionInterface
     */
    public function filterBy(PagesCollection $pages, string $variable, string $value): CollectionInterface
    {
        $filteredPages = $pages->filter(function (Page $page) use ($variable, $value) {
            $notVirtual = false;
            // not virtual only
            if (!$page->isVirtual()) {
                $notVirtual = true;
            }
            // dedicated getter?
            $method = 'get'.ucfirst($variable);
            if (method_exists($page, $method) && $page->$method() == $value) {
                return $notVirtual && true;
            }
            if ($page->getVariable($variable) == $value) {
                return $notVirtual && true;
            }
        });

        return $filteredPages;
    }

    /**
     * Sort by title.
     *
     * @param CollectionInterface|array $collection
     *
     * @return array
     */
    public function sortByTitle($collection): array
    {
        if ($collection instanceof CollectionInterface) {
            $collection = $collection->toArray();
        }
        array_multisort(array_keys($collection), SORT_NATURAL | SORT_FLAG_CASE, $collection);

array_keys($collection) cannot be passed to array_multisort() as the parameter $arr expects a reference.

        return $collection;
    }

    /**
     * Sort by weight.
     *
     * @param CollectionInterface|array $collection
     *
     * @return array
     */
    public function sortByWeight($collection): array
    {
        $callback = function ($a, $b) {
            if (!isset($a['weight'])) {
                return 1;
            }
            if (!isset($b['weight'])) {
                return -1;
            }
            if ($a['weight'] == $b['weight']) {
                return 0;
            }

            return ($a['weight'] < $b['weight']) ? -1 : 1;
        };

        if ($collection instanceof CollectionInterface) {
            $collection = $collection->toArray();
        }
        usort($collection, $callback);

        return $collection;
    }

    /**
     * Sort by date.
     *
     * @param CollectionInterface|array $collection
     *
     * @return mixed
     */
    public function sortByDate($collection): array
    {
        $callback = function ($a, $b) {
            if (!isset($a['date'])) {
                return -1;
            }
            if (!isset($b['date'])) {
                return 1;
            }
            if ($a['date'] == $b['date']) {
                return 0;
            }

            return ($a['date'] > $b['date']) ? -1 : 1;
        };

        if ($collection instanceof CollectionInterface) {
            $collection = $collection->toArray();
        }
        usort($collection, $callback);

        return $collection;
    }

    /**
     * Create an URL.
     *
     * $options[
     *     'canonical' => null,
     *     'addhash'   => true,
     *     'format'    => 'json',
     * ];
     *
     * @param Page|string|null $value
     * @param array|bool|null  $options
     *
     * @return string|null
     */
    public function createUrl($value = null, $options = null): ?string
    {
        $baseurl = (string) $this->config->get('baseurl');
        $hash = md5((string) $this->config->get('time'));
        $base = '';
        // handle options
        $canonical = null;
        $addhash = false;
        $format = null;
        // backward compatibility
        if (is_bool($options)) {
            $oldOptions = $options;
            $options = [];
            $options['canonical'] = false;
            if ($oldOptions === true) {
                $options['canonical'] = true;
            }
        }
        extract(is_array($options) ? $options : []);

        // set baseurl
        if ((bool) $this->config->get('canonicalurl') || $canonical === true) {
            $base = rtrim($baseurl, '/');
        }
        if ($canonical === false) {

The condition $canonical === false is always true.

            $base = '';
        }

        // Page item
        if ($value instanceof Page) {
            if (!$format) {
                $format = $value->getVariable('output');
                if (is_array($value->getVariable('output'))) {
                    $format = $value->getVariable('output')[0];
                }
                if (!$format) {
                    $format = 'html';
                }
            }
            $url = $value->getUrl($format, $this->config);
            $url = $base.'/'.ltrim($url, '/');

            return $url;
        }
        // external URL
        if (Util::isExternalUrl($value)) {
            $url = $value;

            return $url;
        }
        // ressource URL (ie: 'path/style.css')
        if (false !== strpos($value, '.')) {
            $url = $value;
            if ($addhash) {
                $url .= '?'.$hash;
            }
            $url = $base.'/'.ltrim($url, '/');

            return $url;
        }
        // others cases
        $url = $base.'/';
        if (!empty($value) && $value != '/') {
            $url = $base.'/'.$value;
            // value == 'page-id' (ie: 'path/my-page')
            try {
                $pageId = $this->slugifyFilter($value);
                $page = $this->builder->getPages()->get($pageId);
                $url = $this->createUrl($page, $options);
            } catch (\DomainException $e) {
                // nothing to do
            }
        }

        return $url;
    }

    /**
     * Minify a CSS or a JS file.
     *
     * ie: minify('css/style.css')
     *
     * @param string $path
     *
     * @throws Exception
     *
     * @return string
     */
    public function minify(string $path): string
    {
        $filePath = $this->outputPath.'/'.$path;
        $fileInfo = new \SplFileInfo($filePath);
        $fileExtension = $fileInfo->getExtension();
        // ie: minify('css/style.min.css')
        $pathMinified = \sprintf('%s.min.%s', substr($path, 0, -strlen(".$fileExtension")), $fileExtension);
        $filePathMinified = $this->outputPath.'/'.$pathMinified;
        if (is_file($filePathMinified)) {
            return $pathMinified;
        }
        if (is_file($filePath)) {
            switch ($fileExtension) {
                case 'css':
                    $minifier = new Minify\CSS($filePath);
                    break;
                case 'js':
                    $minifier = new Minify\JS($filePath);
                    break;
                default:
                    throw new Exception(sprintf("File '%s' should be a '.css' or a '.js'!", $path));
            }
            $minifier->minify($filePathMinified);

            return $pathMinified;
        }

        throw new Exception(sprintf("File '%s' doesn't exist!", $path));
    }

    /**
     * Minify CSS.
     *
     * @param string $value
     *
     * @return string
     */
    public function minifyCss(string $value): string
    {
        $minifier = new Minify\CSS($value);

        return $minifier->minify();
    }

    /**
     * Minify JS.
     *
     * @param string $value
     *
     * @return string
     */
    public function minifyJs(string $value): string
    {
        $minifier = new Minify\JS($value);

        return $minifier->minify();
    }

    /**
     * Compile style file to CSS.
     *
     * @param string $path
     *
     * @throws Exception
     *
     * @return string
     */
    public function toCss(string $path): string
    {
        $filePath = $this->outputPath.'/'.$path;
        $subPath = substr($path, 0, strrpos($path, '/'));

        if (is_file($filePath)) {
            $fileExtension = (new \SplFileInfo($filePath))->getExtension();
            switch ($fileExtension) {
                case 'scss':
                    $scssPhp = new Compiler();
                    $scssPhp->setImportPaths($this->outputPath.'/'.$subPath);
                    $targetPath = preg_replace('/scss/m', 'css', $path);

                    // compile if target file doesn't exists
                    if (!Util::getFS()->exists($this->outputPath.'/'.$targetPath)) {
                        $scss = file_get_contents($filePath);
                        $css = $scssPhp->compile($scss);
                        Util::getFS()->dumpFile($this->outputPath.'/'.$targetPath, $css);
                    }

                    return $targetPath;
                default:
                    throw new Exception(sprintf("File '%s' should be a '.scss'!", $path));
            }
        }

        throw new Exception(sprintf("File '%s' doesn't exist!", $path));
    }

    /**
     * Compile SCSS string to CSS.
     *
     * @param string $value
     *
     * @return string
     */
    public function scssToCss(string $value): string
    {
        $scss = new Compiler();

        return $scss->compile($value);
    }

    /**
     * Read $lenght first characters of a string and add a suffix.
     *
     * @param string|null $string
     * @param int         $length
     * @param string      $suffix
     *
     * @return string|null
     */
    public function excerpt(string $string = null, int $length = 450, string $suffix = ' …'): ?string
    {
        $string = str_replace('</p>', '<br /><br />', $string);
        $string = trim(strip_tags($string, '<br>'), '<br />');
        if (mb_strlen($string) > $length) {
            $string = mb_substr($string, 0, $length);
            $string .= $suffix;
        }

        return $string;
    }

    /**
     * Read characters before '<!-- excerpt|break -->'.
     *
     * @param string|null $string
     *
     * @return string|null
     */
    public function excerptHtml(string $string = null): ?string
    {
        // https://regex101.com/r/Xl7d5I/3
        $pattern = '(.*)(<!--[[:blank:]]?(excerpt|break)[[:blank:]]?-->)(.*)';
        preg_match('/'.$pattern.'/is', $string, $matches);
        if (empty($matches)) {
            return $string;
        }

        return trim($matches[1]);
    }

    /**
     * Calculate estimated time to read a text.
     *
     * @param string|null $text
     *
     * @return string
     */
    public function readtime(string $text = null): string
    {
        $words = str_word_count(strip_tags($text));
        $min = floor($words / 200);
        if ($min === 0) {
            return '1';
        }

        return (string) $min;
    }

    /**
     * Hash file with sha384.
     * Useful for SRI (Subresource Integrity).
     *
     * @see https://developer.mozilla.org/fr/docs/Web/Security/Subresource_Integrity
     *
     * @param string $path
     *
     * @return string|null
     */
    public function hashFile(string $path): ?string
    {
        if (is_file($filePath = $this->outputPath.'/'.$path)) {
            $path = $filePath;
        }

        return sprintf('sha384-%s', base64_encode(hash_file('sha384', $path, true)));
    }

    /**
     * Gets the value of an environment variable.
     *
     * @param string $var
     *
     * @return string|null
     */
    public function getEnv(string $var): ?string
    {
        return getenv($var) ?: null;
    }

    /**
     * Resize image.
     *
     * @param string $path
     * @param int    $size
     *
     * @return string
     */
    public function resize(string $path, int $size): string
    {
        return (new Image($this->builder))->resize($path, $size);
    }
}