Added the possibility to cache transformer data & a "multi-replace" transformer

Author: Valentin Clavreul

Documentation/changelog/CHANGELOG-3.2.md

@@ -6,15 +6,17 @@ v3.2-dev
 
 ### Features
 
-_Nothing yet_
+* Added `multi_replace` transformer
+* Added `cached` transformer
 
 ### Fixes
 
 * Fixed return value of list and help commands (mandatory for Symfony 5)
 
 ### BC breaks
 
-_Nothing yet_
+* Added `psr/cache` as a dependency, but it shouldn't break anything
+* Added `ext-intl` as a dependency, since required by the `slugify` transformer
 
 v3.2.2
 ------

Transformer/CachedTransformer.php

@@ -0,0 +1,98 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of the CleverAge/ProcessBundle package.
+ *
+ * Copyright (C) 2017-2021 Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\ProcessBundle\Transformer;
+
+use CleverAge\ProcessBundle\Registry\TransformerRegistry;
+use Psr\Cache\CacheItemPoolInterface;
+use Psr\Cache\InvalidArgumentException;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class CachedTransformer implements ConfigurableTransformerInterface
+{
+
+    const CACHE_SEPARATOR = '|';
+
+    use TransformerTrait;
+
+    /** @var CacheItemPoolInterface */
+    protected $cache;
+
+    /** @var LoggerInterface */
+    protected $logger;
+
+    /**
+     * CachedTransformer constructor.
+     *
+     * @param TransformerRegistry    $transformerRegistry
+     * @param CacheItemPoolInterface $cache
+     * @param LoggerInterface        $logger
+     */
+    public function __construct(TransformerRegistry $transformerRegistry, CacheItemPoolInterface $cache, LoggerInterface $logger)
+    {
+        $this->transformerRegistry = $transformerRegistry;
+        $this->cache = $cache;
+        $this->logger = $logger;
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setRequired('cache_key');
+        $resolver->setAllowedTypes('cache_key', 'string');
+        $this->configureTransformersOptions($resolver);
+        $this->configureTransformersOptions($resolver, 'key_transformers');
+    }
+
+    public function transform($value, array $options = [])
+    {
+        $cacheKey = $this->generateCacheKey($options['cache_key'], $value, $options);
+        if ($cacheKey && $this->cache instanceof CacheItemPoolInterface) {
+            try {
+                $cacheItem = $this->cache->getItem($cacheKey);
+                if ($cacheItem->isHit()) {
+
+                    return $cacheItem->get();
+                } else {
+                    $newValue = $this->applyTransformers($options['transformers'], $value);
+                    $cacheItem->set($newValue);
+                    $success = $this->cache->saveDeferred($cacheItem);
+
+                    if (!$success) {
+                        $this->logger->warning('Cannot save cache item', ['cache_key' => $cacheKey]);
+                    }
+
+                    return $newValue;
+                }
+            } catch (InvalidArgumentException $exception) {
+                $this->logger->warning('Cannot get cache item', ['cache_key' => $cacheKey, 'message' => $exception->getMessage()]);
+            }
+        }
+
+        return $this->applyTransformers($options['transformers'], $value);
+    }
+
+    public function getCode()
+    {
+        return 'cached';
+    }
+
+    protected function generateCacheKey($cacheKeyRoot, $value, $options)
+    {
+        $value = $this->applyTransformers($options['key_transformers'], $value);
+
+        if (!\is_string($value)) {
+            return false;
+        }
+
+        return \implode(self::CACHE_SEPARATOR, [$cacheKeyRoot, \rawurlencode($value)]);
+    }
+
+}

Transformer/MultiReplaceTransformer.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of the CleverAge/ProcessBundle package.
+ *
+ * Copyright (C) 2017-2021 Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\ProcessBundle\Transformer;
+
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Quickly replace a list of values in a string
+ *
+ * ##### Options
+ *
+ * * `replace_mapping` (`array`, _required_): a list of _pattern_ => _replacement_ to apply on input strings
+ */
+class MultiReplaceTransformer implements ConfigurableTransformerInterface
+{
+    public function transform($value, array $options = [])
+    {
+        foreach($options['replace_mapping'] as $pattern => $replacement) {
+            $value = str_replace($pattern, $replacement, $value);
+        }
+
+        return $value;
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setRequired('replace_mapping');
+        $resolver->setAllowedTypes('replace_mapping', 'array');
+    }
+
+    public function getCode()
+    {
+        return 'multi_replace';
+    }
+
+}

composer.json

@@ -40,8 +40,10 @@
         "php": ">=7.2",
         "ext-json": "*",
         "ext-dom": "*",
+        "ext-intl": "*",
         "symfony/event-dispatcher-contracts": "~1.0|~2.0",
         "psr/event-dispatcher": "1.0.0",
+        "psr/cache": "^1.0.0",
         "symfony/config": "~3.0|~4.0|~5.0",
         "symfony/dependency-injection": "~3.0|~4.0|~5.0",
         "symfony/framework-bundle": "~3.0|~4.0|~5.0",