ADD the empty converter type

Adds a new "empty" type to get a converter without the
core extension. It is useful to use extensions that
*replace* the core one (like InlinesOnly).

Author: AymDev

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.0] - 2020-10-25
+### Added
+ - New `empty` converter type
+
 ## [1.1.1] - 2020-10-24
 ### Fixed
  - the converter `options` configuration key is not ignored anymore
@@ -18,7 +22,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
  - Bundle base
 
-[Unreleased]: https://github.com/AymDev/CommonMarkBundle/compare/v1.1.1...HEAD
+[Unreleased]: https://github.com/AymDev/CommonMarkBundle/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/AymDev/CommonMarkBundle/compare/v1.1.1...v1.2.0
 [1.1.1]: https://github.com/AymDev/CommonMarkBundle/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/AymDev/CommonMarkBundle/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/AymDev/CommonMarkBundle/releases/tag/v1.0.0

README.md

@@ -49,6 +49,7 @@ The `type` key can be used to choose between a *CommonMark* or a *GitHub* conver
 
  - `commonmark` (default): `CommonMarkConverter`
  - `github`: `GithubFlavoredMarkdownConverter`
+ - `empty`: creates a `CommonMarkConverter` without the `CommonMarkCoreExtension` (e.g. to use `InlinesOnlyExtension`)
 
 ### Converter options
 

src/DependencyInjection/Compiler/ConvertersPass.php

@@ -3,6 +3,8 @@
 namespace Aymdev\CommonmarkBundle\DependencyInjection\Compiler;
 
 use League\CommonMark\CommonMarkConverter;
+use League\CommonMark\Environment;
+use League\CommonMark\Extension\InlinesOnly\InlinesOnlyExtension;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -32,7 +34,11 @@ public function process(ContainerBuilder $container)
     private function registerConverters(array $converterConfig, ContainerBuilder $container): array
     {
         // Create environment definition
-        $environment = new ChildDefinition('aymdev_commonmark.environment');
+        if ($converterConfig['type'] === 'empty') {
+            $environment = new Definition(Environment::class);
+        } else {
+            $environment = new ChildDefinition('aymdev_commonmark.environment');
+        }
 
         // Register and add extensions
         foreach ($converterConfig['extensions'] as $extensionName) {
@@ -52,6 +58,7 @@ private function registerConverters(array $converterConfig, ContainerBuilder $co
         $converterDefinition
             ->addArgument($converterConfig['options'] ?? [])
             ->addArgument(new Reference($environmentId))
+            ->setPublic(true)
         ;
 
         $converterId = 'aymdev_commonmark.converter.' . $converterConfig['name'];

src/DependencyInjection/Configuration.php

@@ -18,7 +18,7 @@ public function getConfigTreeBuilder()
                     ->arrayPrototype()
                         ->children()
                             ->enumNode('type')
-                                ->values(['commonmark', 'github'])
+                                ->values(['commonmark', 'github', 'empty'])
                                 ->defaultValue('commonmark')
                             ->end()
                             ->variableNode('options')->end()

src/Resources/config/services.xml

@@ -15,6 +15,7 @@
         <!-- Converters -->
         <service id="aymdev_commonmark.converter.type.commonmark" class="League\CommonMark\CommonMarkConverter" />
         <service id="aymdev_commonmark.converter.type.github" class="League\CommonMark\GithubFlavoredMarkdownConverter" />
+        <service id="aymdev_commonmark.converter.type.empty" alias="aymdev_commonmark.converter.type.commonmark" />
 
         <!-- Twig extension -->
         <service id="aymdev_commonmark.twig_extension" class="Aymdev\CommonmarkBundle\Twig\CommonMarkExtension">

tests/DependencyInjection/Compiler/ConvertersPassTest.php

@@ -7,6 +7,7 @@
 use Aymdev\CommonmarkBundle\DependencyInjection\Compiler\ConvertersPass;
 use Aymdev\CommonmarkBundle\Twig\CommonMarkExtension;
 use League\CommonMark\CommonMarkConverter;
+use League\CommonMark\Extension\InlinesOnly\InlinesOnlyExtension;
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Bundle\TwigBundle\TwigBundle;
@@ -102,6 +103,33 @@ public function testTwigExtensionRegistration()
         $html = trim($html);
         self::assertSame($expectedOutput, $html);
     }
+
+    /**
+     * Test empty environment
+     * The InlinesOnlyExtension needs to be added to an empty environment
+     * It must not be combined with the CommonMarkCoreExtension
+     */
+    public function testEmptyEnvironmentSetup()
+    {
+        $kernel = new AymdevCommonmarkTestKernel([
+            'converters' => [
+                'my_converter' => [
+                    'type' => 'empty',
+                    'extensions' => [
+                        InlinesOnlyExtension::class,
+                    ]
+                ],
+            ]
+        ]);
+        $kernel->boot();
+        $container = $kernel->getContainer();
+
+        /** @var CommonMarkConverter $converter */
+        $converter = $container->get('aymdev_commonmark.converter.my_converter');
+
+        // converting works correctly
+        self::assertSame('# test', trim($converter->convertToHtml('# test')));
+    }
 }
 
 class AymdevCommonmarkTestKernel extends Kernel