Merge branch 'develop'

Author: picodexter

CHANGELOG.md

@@ -28,6 +28,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 *   (empty)
 
+## 1.1.1 (2018-03-06)
+
+### Added
+
+*   Added support for resolving Symfony parameters using environment placeholders (Symfony 3.2+)
+*   Added rewriting Doctrine configuration key "url" (Symfony 4.0+)
+*   Added Composer scripts for PHPUnit
+*   Added Composer scripts for PHP CS Fixer
+
 ## 1.1.0 (2018-01-20)
 
 ### Added

CONTRIBUTING.md

@@ -45,14 +45,26 @@ The following steps are required:
 
 *   Check the code coverage in order to stay at 100%:
 
+    ```console
+    $ composer test-coverage
+    ```
+
+    or
+
     ```console
     $ ./vendor/bin/phpunit -v --coverage-text
     ```
 
 *   Run PHP CS Fixer for coding standards / code style:
 
     ```console
-    $ ./vendor/bin/php-cs-fixer fix -v --dry-run --diff .
+    $ composer cs
+    ```
+
+    or
+
+    ```console
+    $ ./vendor/bin/php-cs-fixer fix -v --dry-run --diff
     ```
 
 Automated versions of these checks will run during the build process.

Console/Processor/DecryptProcessor.php

@@ -79,7 +79,7 @@ public function renderDecryptOutput(DecryptRequest $request, OutputInterface $ou
 
         $algorithmConfig = $this->algorithmConfigContainer->get($request->getAlgorithmId());
 
-        $plaintextValue = $this->getEncryptedValue($request);
+        $encryptedValue = $this->getEncryptedValue($request);
 
         $activeKeyConfig = $this->activeKeyConfigProvider->getActiveKeyConfiguration(
             $request->isKeyProvided(),
@@ -90,7 +90,7 @@ public function renderDecryptOutput(DecryptRequest $request, OutputInterface $ou
         $transformedKey = $this->transformedKeyProvider->getTransformedKey($activeKeyConfig);
 
         $decryptedValue = $algorithmConfig->getDecrypter()
-            ->decryptValue($plaintextValue, $transformedKey->getFinalKey());
+            ->decryptValue($encryptedValue, $transformedKey->getFinalKey());
 
         $this->renderer->renderOutput($decryptedValue, $transformedKey, $output);
     }

DependencyInjection/BundleConfiguration/ServiceDefinition/Rewriter/DoctrineRewriter.php

@@ -136,5 +136,7 @@ private function replaceConnectionArguments(array &$serviceConnArguments, array
             ->replaceArgumentIfExists($serviceConnArguments, $resolvedConnConfig, 'user');
         $serviceConnArguments = $this->argumentReplacer
             ->replaceArgumentIfExists($serviceConnArguments, $resolvedConnConfig, 'password');
+        $serviceConnArguments = $this->argumentReplacer
+            ->replaceArgumentIfExists($serviceConnArguments, $resolvedConnConfig, 'url');
     }
 }

DependencyInjection/Compiler/ParameterReplacementPass.php

@@ -33,6 +33,6 @@ public function process(ContainerBuilder $container)
 
         $parameterReplacer = $container->get(ServiceNames::PARAMETER_REPLACER);
 
-        $parameterReplacer->processParameterBag($parameterBag);
+        $parameterReplacer->processParameterBag($parameterBag, $container);
     }
 }

DependencyInjection/Parameter/EnvironmentPlaceholderResolver.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the PcdxParameterEncryptionBundle package.
+ *
+ * (c) picodexter <https://picodexter.io/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Picodexter\ParameterEncryptionBundle\DependencyInjection\Parameter;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * EnvironmentPlaceholderResolver.
+ */
+class EnvironmentPlaceholderResolver implements EnvironmentPlaceholderResolverInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function resolveEnvironmentPlaceholders($parameterValue, ContainerBuilder $container)
+    {
+        return $container->resolveEnvPlaceholders($parameterValue, true);
+    }
+}

DependencyInjection/Parameter/EnvironmentPlaceholderResolverFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the PcdxParameterEncryptionBundle package.
+ *
+ * (c) picodexter <https://picodexter.io/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Picodexter\ParameterEncryptionBundle\DependencyInjection\Parameter;
+
+use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
+
+/**
+ * EnvironmentPlaceholderResolverFactory.
+ */
+class EnvironmentPlaceholderResolverFactory
+{
+    /**
+     * Create environment placeholder resolver.
+     *
+     * @param string $classNameToCheck
+     *
+     * @return EnvironmentPlaceholderResolverInterface
+     */
+    public static function createResolver($classNameToCheck = EnvPlaceholderParameterBag::class)
+    {
+        if (class_exists($classNameToCheck)) {
+            return new EnvironmentPlaceholderResolver();
+        }
+
+        return new LegacyEnvironmentPlaceholderResolver();
+    }
+}

DependencyInjection/Parameter/EnvironmentPlaceholderResolverInterface.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the PcdxParameterEncryptionBundle package.
+ *
+ * (c) picodexter <https://picodexter.io/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Picodexter\ParameterEncryptionBundle\DependencyInjection\Parameter;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * EnvironmentPlaceholderResolverInterface.
+ */
+interface EnvironmentPlaceholderResolverInterface
+{
+    /**
+     * Resolve environment placeholders.
+     *
+     * @param mixed            $parameterValue
+     * @param ContainerBuilder $container
+     *
+     * @return mixed
+     */
+    public function resolveEnvironmentPlaceholders($parameterValue, ContainerBuilder $container);
+}

DependencyInjection/Parameter/LegacyEnvironmentPlaceholderResolver.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the PcdxParameterEncryptionBundle package.
+ *
+ * (c) picodexter <https://picodexter.io/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Picodexter\ParameterEncryptionBundle\DependencyInjection\Parameter;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * LegacyEnvironmentPlaceholderResolver.
+ *
+ * Compatibility layer for Symfony < 3.2 which did not support environment placeholders.
+ */
+class LegacyEnvironmentPlaceholderResolver implements EnvironmentPlaceholderResolverInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function resolveEnvironmentPlaceholders($parameterValue, ContainerBuilder $container)
+    {
+        return $parameterValue;
+    }
+}

DependencyInjection/Service/Initializer/Handler/ReplacementSourceDecrypterRegistrationHandler.php

@@ -12,6 +12,7 @@
 namespace Picodexter\ParameterEncryptionBundle\DependencyInjection\Service\Initializer\Handler;
 
 use Picodexter\ParameterEncryptionBundle\Configuration\Key\KeyConfiguration;
+use Picodexter\ParameterEncryptionBundle\DependencyInjection\Parameter\EnvironmentPlaceholderResolverInterface;
 use Picodexter\ParameterEncryptionBundle\DependencyInjection\Service\BundleConfigurationValidatorInterface;
 use Picodexter\ParameterEncryptionBundle\DependencyInjection\Service\DefinitionFactoryInterface;
 use Picodexter\ParameterEncryptionBundle\DependencyInjection\Service\ReferenceFactoryInterface;
@@ -35,6 +36,11 @@ class ReplacementSourceDecrypterRegistrationHandler implements ReplacementSource
      */
     private $definitionFactory;
 
+    /**
+     * @var EnvironmentPlaceholderResolverInterface
+     */
+    private $environmentPlaceholderResolver;
+
     /**
      * @var ReferenceFactoryInterface
      */
@@ -48,19 +54,22 @@ class ReplacementSourceDecrypterRegistrationHandler implements ReplacementSource
     /**
      * Constructor.
      *
-     * @param BundleConfigurationValidatorInterface $configValidator
-     * @param DefinitionFactoryInterface            $definitionFactory
-     * @param ReferenceFactoryInterface             $referenceFactory
-     * @param ServiceNameGeneratorInterface         $serviceNameGenerator
+     * @param BundleConfigurationValidatorInterface   $bundleConfigValidator
+     * @param DefinitionFactoryInterface              $definitionFactory
+     * @param EnvironmentPlaceholderResolverInterface $environmentPlaceholderResolver
+     * @param ReferenceFactoryInterface               $referenceFactory
+     * @param ServiceNameGeneratorInterface           $serviceNameGenerator
      */
     public function __construct(
-        BundleConfigurationValidatorInterface $configValidator,
+        BundleConfigurationValidatorInterface $bundleConfigValidator,
         DefinitionFactoryInterface $definitionFactory,
+        EnvironmentPlaceholderResolverInterface $environmentPlaceholderResolver,
         ReferenceFactoryInterface $referenceFactory,
         ServiceNameGeneratorInterface $serviceNameGenerator
     ) {
-        $this->bundleConfigValidator = $configValidator;
+        $this->bundleConfigValidator = $bundleConfigValidator;
         $this->definitionFactory = $definitionFactory;
+        $this->environmentPlaceholderResolver = $environmentPlaceholderResolver;
         $this->referenceFactory = $referenceFactory;
         $this->serviceNameGenerator = $serviceNameGenerator;
     }
@@ -75,9 +84,14 @@ public function registerReplacementSourceDecrypters(array $bundleConfig, Contain
         $definitions = [];
 
         foreach ($bundleConfig['algorithms'] as $algorithmConfig) {
+            $decryptionKeyConfig = $this->environmentPlaceholderResolver->resolveEnvironmentPlaceholders(
+                $algorithmConfig['decryption']['key'],
+                $container
+            );
+
             $decryptionKeyConfDef = $this->definitionFactory->createDefinition(
                 KeyConfiguration::class,
-                [$algorithmConfig['decryption']['key']]
+                [$decryptionKeyConfig]
             );
             $decryptionKeyConfDef->setFactory([
                 $this->referenceFactory->createReference(ServiceNames::KEY_CONFIGURATION_FACTORY),