Merge pull request #108 from symfony-cmf/improve-ckeditor

Move CKEditor configuration to the factory

Author: dbu

.travis.yml

@@ -1,7 +1,7 @@
 language: php
 
 php:
-  - 7.0
+  - 7.1
   - hhvm
 
 sudo: false
@@ -12,21 +12,19 @@ cache:
     - $HOME/.composer/cache/files
 
 env:
-  matrix: SYMFONY_VERSION=3.1.*
+  matrix: SYMFONY_VERSION=3.2.*
   global:
     - SYMFONY_DEPRECATIONS_HELPER=2080
     - SYMFONY_PHPUNIT_DIR=".phpunit" SYMFONY_PHPUNIT_REMOVE="symfony/yaml" SYMFONY_PHPUNIT_VERSION=5.7
 
 matrix:
   include:
-    #- php: 7.0
+    #- php: 7.1
     #  env: DEPS=dev SYMFONY_VERSION=3.3.*
     - php: 5.6
       env: COMPOSER_FLAGS="--prefer-lowest" SYMFONY_VERSION=2.8.* SYMFONY_DEPRECATIONS_HELPER=weak
-    - php: 7.1
-      env: SYMFONY_VERSION=3.0.*
-    #- php: 7.0
-    #  env: DEPS=dev COMPOSER_FLAGS="--prefer-stable" SYMFONY_VERSION=3.2.*
+    - php: 7.0
+      env: SYMFONY_VERSION=3.1.*
   fast_finish: true
 
 before_install:

src/DependencyInjection/CmfSonataPhpcrAdminIntegrationExtension.php

@@ -11,8 +11,6 @@
 
 namespace Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\DependencyInjection;
 
-use Ivory\CKEditorBundle\IvoryCKEditorBundle;
-use Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\DependencyInjection\Factory\IsConfigEnabledTrait;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -26,8 +24,6 @@
  */
 class CmfSonataPhpcrAdminIntegrationExtension extends Extension implements CompilerPassInterface
 {
-    use IsConfigEnabledTrait;
-
     /**
      * @var AdminFactoryInterface[]
      */
@@ -65,36 +61,6 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader->load('main.xml');
         $loader->load('enhancer.xml');
-
-        $this->loadIvoryCKEditor($config['ivory_ckeditor'], $container);
-    }
-
-    /**
-     * Adds the ckEditor configuration to the parameters list when configuration is enabled (auto, true). For both
-     * settings the "egeloen/ckeditor-bundle" has to be installed and enabled.
-     *
-     * @param array            $config
-     * @param ContainerBuilder $container
-     *
-     * @throws \LogicException when configuration is enabled by true and "IvoryCKEditorBundle" is not enabled
-     */
-    protected function loadIvoryCKEditor(array $config, ContainerBuilder $container)
-    {
-        $configParameter = [];
-        if ($this->isConfigEnabled($container, $config)) {
-            $bundles = $container->getParameter('kernel.bundles');
-            if (true === $config['enabled'] && !isset($bundles['IvoryCKEditorBundle'])) {
-                $message = 'IvoryCKEditorBundle integration was explicitely enabled, but the bundle is not available';
-                if (class_exists(IvoryCKEditorBundle::class)) {
-                    $message .= ' (did you forget to register the bundle in the AppKernel?)';
-                }
-                throw new \LogicException($message.'.');
-            } elseif (isset($bundles['IvoryCKEditorBundle'])) {
-                $configParameter = ['config_name' => $config['config_name']];
-            }
-        }
-
-        $container->setParameter('cmf_sonata_phpcr_admin_integration.ivory_ckeditor.config', $configParameter);
     }
 
     /**

src/DependencyInjection/Configuration.php

@@ -41,20 +41,6 @@ public function getConfigTreeBuilder()
 
         $this->addBundlesSection($root);
 
-        $root
-            ->children()
-                ->arrayNode('ivory_ckeditor')
-                    ->addDefaultsIfNotSet()
-                    ->children()
-                        ->enumNode('enabled')
-                            ->values([true, false, 'auto'])
-                            ->defaultValue('auto')
-                        ->end()
-                        ->scalarNode('config_name')->isRequired()->end()
-                    ->end()
-                ->end()
-            ->end();
-
         return $treeBuilder;
     }
 

src/DependencyInjection/Factory/BlockAdminFactory.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\DependencyInjection\Factory;
 
+use Symfony\Cmf\Bundle\MenuBundle\CmfMenuBundle;
 use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
@@ -20,6 +21,8 @@
  */
 class BlockAdminFactory implements AdminFactoryInterface
 {
+    use IsConfigEnabledTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -70,9 +73,11 @@ public function create(array $config, ContainerBuilder $container, XmlFileLoader
 
         $bundles = $container->getParameter('kernel.bundles');
 
-        if (true === $config['enable_menu']
-            || ('auto' === $config['enable_menu'] && isset($bundles['CmfMenuBundle']))
-        ) {
+        $message = 'CmfMenuBundle integration was explicitely enabled, but the bundle is not available.';
+        if (class_exists(CmfMenuBundle::class)) {
+            $message .= ' (did you forget to register the bundle in the AppKernel?)';
+        }
+        if ($this->isConfigEnabledAuto($container, $config['enable_menu'], 'CmfMenuBundle', $message)) {
             $loader->load('block-menu.xml');
         }
     }

src/DependencyInjection/Factory/ContentAdminFactory.php

@@ -11,7 +11,9 @@
 
 namespace Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\DependencyInjection\Factory;
 
+use Ivory\CKEditorBundle\IvoryCKEditorBundle;
 use Symfony\Component\Config\Definition\Builder\NodeBuilder;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
@@ -20,6 +22,8 @@
  */
 class ContentAdminFactory implements AdminFactoryInterface
 {
+    use IsConfigEnabledTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -33,6 +37,22 @@ public function getKey()
      */
     public function addConfiguration(NodeBuilder $builder)
     {
+        $builder
+            ->arrayNode('ivory_ckeditor')
+                ->treatFalseLike(['enabled' => false])
+                ->treatTrueLike(['enabled' => true])
+                ->treatNullLike(['enabled' => 'auto'])
+                ->addDefaultsIfNotSet()
+                ->ignoreExtraKeys()
+                ->children()
+                    ->enumNode('enabled')
+                        ->values([true, false, 'auto'])
+                        ->defaultValue('auto')
+                    ->end()
+                    ->scalarNode('config_name')->end()
+                ->end()
+            ->end()
+        ;
     }
 
     /**
@@ -41,5 +61,23 @@ public function addConfiguration(NodeBuilder $builder)
     public function create(array $config, ContainerBuilder $container, XmlFileLoader $loader)
     {
         $loader->load('content.xml');
+
+        $message = 'IvoryCKEditorBundle integration was explicitely enabled, but the bundle is not available.';
+        if (class_exists(IvoryCKEditorBundle::class)) {
+            $message .= ' (did you forget to register the bundle in the AppKernel?)';
+        }
+
+        $ckeditorConfig = [];
+        if ($this->isConfigEnabledAuto($container, $config['ivory_ckeditor']['enabled'], 'IvoryCKEditorBundle', $message)) {
+            if (!isset($config['ivory_ckeditor']['config_name'])) {
+                throw new InvalidConfigurationException('The cmf_sonata_phpcr_admin_integration.bundles.content.ivory_ckeditor.config_name setting has to be defined when IvoryCKEditorBundle integration is enabled.');
+            }
+
+            unset($config['ivory_ckeditor']['enabled']);
+
+            $ckeditorConfig = $config['ivory_ckeditor'];
+        }
+
+        $container->setParameter('cmf_sonata_phpcr_admin_integration.content.ivory_ckeditor', $ckeditorConfig);
     }
 }

src/DependencyInjection/Factory/IsConfigEnabledTrait.php

@@ -24,4 +24,22 @@ public function isConfigEnabled(ContainerBuilder $container, array $config)
 
         return (bool) $container->getParameterBag()->resolveValue($config['enabled']);
     }
+
+    public function isConfigEnabledAuto(ContainerBuilder $container, $enabled, $requiredBundle, $message = null)
+    {
+        $enabled = $container->getParameterBag()->resolveValue($enabled);
+        $bundleExists = array_key_exists($requiredBundle, $container->getParameter('kernel.bundles'));
+
+        if ('auto' === $enabled) {
+            $enabled = $bundleExists;
+        } elseif (true === $enabled && !$bundleExists) {
+            if (null === $message) {
+                $message = $bundleName.' integration was explicitely enabled, but the bundle is not available.';
+            }
+
+            throw new \LogicException($message);
+        }
+
+        return $enabled;
+    }
 }

src/Resources/config/content.xml

@@ -28,7 +28,7 @@
             </call>
 
             <call method="setCkEditorConfig">
-                <argument>%cmf_sonata_phpcr_admin_integration.ivory_ckeditor.config%</argument>
+                <argument>%cmf_sonata_phpcr_admin_integration.content.ivory_ckeditor%</argument>
             </call>
         </service>
     </services>

src/Resources/config/schema/sonata-phpcr-admin-integration.xsd

@@ -9,7 +9,6 @@
     <xsd:complexType name="config">
         <xsd:sequence>
             <xsd:element name="bundles" type="bundles" minOccurs="0" maxOccurs="1" />
-            <xsd:element name="ivory_ckeditor" type="ivory_ckeditor" minOccurs="0" maxOccurs="1" />
         </xsd:sequence>
     </xsd:complexType>
 
@@ -19,17 +18,4 @@
         </xsd:sequence>
     </xsd:complexType>
 
-    <xsd:complexType name="ivory_ckeditor">
-        <xsd:attribute name="enabled" type="enabled" default="auto" />
-        <xsd:attribute name="config_name" type="xsd:string"/>
-    </xsd:complexType>
-
-    <xsd:simpleType name="enabled">
-        <xsd:restriction base="xsd:string">
-            <xsd:enumeration value="true"/>
-            <xsd:enumeration value="false"/>
-            <xsd:enumeration value="auto"/>
-        </xsd:restriction>
-    </xsd:simpleType>
-
 </xsd:schema>

tests/Resources/Fixtures/config/config.php

@@ -18,7 +18,4 @@
             'enabled' => true,
         ],
     ],
-    'ivory_ckeditor' => [
-        'config_name' => 'cmf_sonata_phpcr_admin_integration',
-    ],
 ]);

tests/Resources/Fixtures/config/config.xml

@@ -7,6 +7,5 @@
         <bundles>
             <seo enabled="true" />
         </bundles>
-        <ivory_ckeditor config_name="cmf_sonata_phpcr_admin_integration" />
     </config>
 </container>