Cecil\Step\Assets\Save

Complexity

Total Complexity

12

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

75.86%

Importance

Changes	1
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	clearCacheIfDisabled()	0	7	3
A	process()	0	17	4
A	init()	0	16	4
A	getName()	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\Assets;

use Cecil\Cache;
use Cecil\Exception\RuntimeException;
use Cecil\Step\AbstractStep;
use Cecil\Util;

/**
 * Save assets step.
 *
 * This step is responsible for saving assets to the output directory.
 * It copies files from the cache to the output directory, ensuring that
 * assets are available for the final build. If the cache is disabled, it
 * clears the cache directory before processing assets.
 */
class Save extends AbstractStep
{
    protected Cache $cache;
    protected string $cacheKey;

    /**
     * {@inheritdoc}
     */
    public function getName(): string
    {
        return 'Saving assets';
    }

    /**
     * {@inheritdoc}
     */
    public function init(array $options): void
    {
        // last build step: should clear cache?
        $this->clearCacheIfDisabled();

        if ($options['dry-run']) {
            return;
        }

        $this->cache = new Cache($this->builder, 'assets');
        $this->cacheKey = \sprintf('_list__%s', $this->builder->getVersion());
        if (empty($this->builder->getAssets()) && $this->cache->has($this->cacheKey)) {
            $this->builder->setAssets($this->cache->get($this->cacheKey));
        }

        $this->canProcess = true;
    }

    /**
     * {@inheritdoc}
     * Note: a file from `static/` with the same name will NOT be overridden.
     *
     * @throws RuntimeException
     */
    public function process(): void
    {
        $total = \count($this->builder->getAssets());
        if ($total > 0) {
            $count = 0;
            foreach ($this->builder->getAssets() as $path) {
                // if file deleted from cache...
                if (!Util\File::getFS()->exists($this->cache->getContentFilePathname($path))) {
                    $this->builder->getLogger()->warning(\sprintf('Asset "%s" not found in cache, skipping. You should clear all cache.', $path));
                    break;
                }
                $count++;
                Util\File::getFS()->copy($this->cache->getContentFilePathname($path), Util::joinFile($this->config->getOutputPath(), $path), false);
                $message = \sprintf('Asset "%s" saved', $path);
                $this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
            }
            $this->cache->set($this->cacheKey, $this->builder->getAssets());
        }
    }

    /**
     * Deletes cache directory, if cache is disabled.
     */
    private function clearCacheIfDisabled(): void
    {
        if (!$this->config->isEnabled('cache')) {
            try {
                Util\File::getFS()->remove($this->config->getCachePath());
            } catch (\Exception) {
                throw new RuntimeException(\sprintf('Unable to remove cache directory "%s".', $this->config->getCachePath()));
            }
        }
    }
}