Cecil\Step\Optimize\AbstractOptimize

Complexity

Total Complexity

15

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	process()	0	55	9
A	init()	0	10	4
A	encode()	0	3	1
A	decode()	0	3	1

<?php

/**
 * This file is part of Cecil.
 *
 * (c) Arnaud Ligny <arnaud@ligny.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cecil\Step\Optimize;

use Cecil\Cache;
use Cecil\Exception\RuntimeException;
use Cecil\Step\AbstractStep;
use Cecil\Util;
use Symfony\Component\Finder\Finder;

/**
 * Abstract class for optimization steps.
 *
 * This class provides a base implementation for steps that optimize files
 * of a specific type (e.g., CSS, JS). It handles the initialization of the
 * optimization process, file processing, and caching of optimized files.
 */
abstract class AbstractOptimize extends AbstractStep
{
    /** @var string File type (ie: 'css') */
    protected $type;

    /** @var mixed File processor */
    protected $processor;

    /**
     * {@inheritdoc}
     */
    public function init(array $options): void
    {
        if ($options['dry-run']) {
            return;
        }
        if (!$this->config->isEnabled(\sprintf('optimize.%s', $this->type))) {
            return;
        }
        if ($this->config->isEnabled('optimize')) {
            $this->canProcess = true;
        }
    }

    /**
     * {@inheritdoc}
     *
     * @throws RuntimeException
     */
    public function process(): void
    {
        $this->setProcessor();

        $extensions = (array) $this->config->get(\sprintf('optimize.%s.ext', $this->type));
        if (empty($extensions)) {
            throw new RuntimeException(\sprintf('The config key "optimize.%s.ext" is empty.', $this->type));
        }

        $files = Finder::create()
            ->files()
            ->in($this->config->getOutputPath())
            ->name('/\.(' . implode('|', $extensions) . ')$/')
            ->notName('/\.min\.(' . implode('|', $extensions) . ')$/')
            ->sortByName(true);
        $max = \count($files);

        if ($max <= 0) {
            $this->builder->getLogger()->info('No files');

            return;
        }

        $count = 0;
        $optimized = 0;
        $cache = new Cache($this->builder, 'optimized');

        /** @var \Symfony\Component\Finder\SplFileInfo $file */
        foreach ($files as $file) {
            $count++;
            $sizeBefore = $file->getSize();
            $message = \sprintf('File "%s" processed', $this->builder->isDebug() ? $file->getPathname() : $file->getRelativePathname());

            $cacheKey = $cache->createKeyFromFile($file);
            if (!$cache->has($cacheKey)) {
                $processed = $this->processFile($file);
                $sizeAfter = \strlen($processed);
                if ($sizeAfter < $sizeBefore) {
                    $message = \sprintf(
                        'File "%s" optimized (%s Ko -> %s Ko)',
                        $this->builder->isDebug() ? $file->getPathname() : $file->getRelativePathname(),
                        ceil($sizeBefore / 1000),
                        ceil($sizeAfter / 1000)
                    );
                }
                $cache->set($cacheKey, $this->encode($processed));
                $optimized++;

                $this->builder->getLogger()->info($message, ['progress' => [$count, $max]]);
            }
            $processed = $this->decode($cache->get($cacheKey));
            Util\File::getFS()->dumpFile($file->getPathname(), $processed);
        }
        if ($optimized == 0) {
            $this->builder->getLogger()->info('Nothing to do');
        }
    }

    /**
     * Set file processor object.
     */
    abstract public function setProcessor(): void;

    /**
     * Process a file.
     */
    abstract public function processFile(\Symfony\Component\Finder\SplFileInfo $file): string;

    /**
     * Encode file content.
     */
    public function encode(?string $content = null): ?string
    {
        return $content;
    }

    /**
     * Decode file content.
     */
    public function decode(?string $content = null): ?string
    {
        return $content;
    }
}