Use class names as service ids

MalteWunsch · MalteWunsch · commit 9fb7e0435b04 · 2020-04-29T16:41:19.000+02:00
Old service ids are aliasing the new services for backwards compatibility
diff --git a/DependencyInjection/Compiler/ShortcodeCompilerPass.php b/DependencyInjection/Compiler/ShortcodeCompilerPass.php
@@ -5,6 +5,8 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
+use Thunder\Shortcode\HandlerContainer\HandlerContainer;
+use Webfactory\ShortcodeBundle\Controller\GuideController;
 
 /**
  * CompilerPass that prepares the shortcode handler container and the GuideController (if configured).
@@ -16,22 +18,22 @@ public function process(ContainerBuilder $container)
         $shortcodeServices = $container->findTaggedServiceIds('webfactory.shortcode');
 
         // add services tagged with webfactory.shortcode as handlers to the short code handler container
-        $handlerContainer = $container->findDefinition('webfactory.shortcode.handler_container');
+        $handlerContainer = $container->findDefinition(HandlerContainer::class);
         foreach ($shortcodeServices as $id => $shortcodeTags) {
             foreach ($shortcodeTags as $shortcodeTag) {
                 $handlerContainer->addMethodCall('add', [$shortcodeTag['shortcode'], new Reference($id)]);
             }
         }
 
         // prepare the GuideController if it's configuration is imported
-        if ($container->has('webfactory.shortcode.guide.controller')) {
+        if ($container->has(GuideController::class)) {
             $allShortcodeTags = [];
             foreach ($shortcodeServices as $id => $shortcodeTags) {
                 $allShortcodeTags = array_merge($allShortcodeTags, $shortcodeTags);
             }
 
             $container
-                ->getDefinition('webfactory.shortcode.guide.controller')
+                ->getDefinition(GuideController::class)
                 ->setArgument(0, $allShortcodeTags);
         }
     }
diff --git a/Handler/EmbeddedShortcodeHandler.php b/Handler/EmbeddedShortcodeHandler.php
@@ -87,8 +87,9 @@ public function __invoke(ShortcodeInterface $shortcode)
                     .'attributes. This can happen e.g. when using Param Converters for your original controller '
                     .'action, as the request (containing the conversion result) is automatically passed to the call of '
                     .'the shortcode controller to allow context sensitive shortcodes. You could use '
-                    .'webfactory.shortcode.embed_inline_for_shortcode_handler as parent in your shortcode\'s service '
-                    .'defintion, so that the inline instead of ESI rendering strategy will be used.',
+                    .'Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.inline as parent in your '
+                    .'shortcode\'s service defintion, so that the inline instead of ESI rendering strategy will be '
+                    .'used.',
                     0,
                     $exception
                 );
diff --git a/README.md b/README.md
@@ -67,14 +67,14 @@ public function registerBundles()
 The easiest way is to add one anonymous service for each shortcode in your services definition:
 
 ```xml  
-<service parent="webfactory.shortcode.embed_esi_for_shortcode_handler">
+<service parent="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.esi">
     <argument index="1">reference-to-your-replacement-controller</argument>
     <tag name="webfactory.shortcode" shortcode="your-shortcode-name"/>
 </service>
 ```
 
-The parent ```webfactory.shortcode.embed_esi_for_shortcode_handler``` will use [ESI rendering](https://symfony.com/doc/current/http_cache/esi.html)
-(which may be nice for caching), while the parent ```webfactory.shortcode.embed_inline_for_shortcode_handler``` will use
+The parent ```Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.esi``` will use [ESI rendering](https://symfony.com/doc/current/http_cache/esi.html)
+(which may be nice for caching), while the parent ```Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.inline``` will use
 inline rendering.
 
 The ```reference-to-your-replacement-controller``` could be a string like ```AppBundle\Controller\EmbeddedImageController::showAction```
@@ -106,7 +106,7 @@ Then, write a service definition like this:
     
         <!-- ... -->
         
-        <service parent="webfactory.shortcode.embed_esi_for_shortcode_handler">
+        <service parent="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.esi">
             <argument index="1">app.controller.embedded_image:showAction</argument>
             <tag name="webfactory.shortcode" shortcode="image"/>
         </service>
@@ -207,7 +207,7 @@ Finally, enrich your shortcode tags with description and example attributes for
     <!-- import guide.xml -->
 
     <services>
-        <service parent="webfactory.shortcode.embed_esi_for_shortcode_handler">
+        <service parent="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.esi">
             <argument index="1">app.controller.embedded_image:showAction</argument>
             <tag
                 name="webfactory.shortcode"
@@ -289,7 +289,7 @@ definition of your shortcode:
 <?xml version="1.0" ?>
 <container xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://symfony.com/schema/dic/services" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
     <services>
-        <service parent="webfactory.shortcode.embed_esi_for_shortcode_handler">
+        <service parent="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.esi">
             <argument index="1">app.controller.embedded_image:showAction</argument>
             <tag name="webfactory.shortcode" ... />
             ...
diff --git a/Resources/config/guide-routing.xml b/Resources/config/guide-routing.xml
@@ -5,11 +5,11 @@
         http://symfony.com/schema/routing/routing-1.0.xsd">
 
     <route id="webfactory.shortcode.guide-list" path="/">
-        <default key="_controller">webfactory.shortcode.guide.controller:listAction</default>
+        <default key="_controller">Webfactory\ShortcodeBundle\Controller\GuideController:listAction</default>
     </route>
 
     <route id="webfactory.shortcode.guide-detail" path="/{shortcode}/">
-        <default key="_controller">webfactory.shortcode.guide.controller:detailAction</default>
+        <default key="_controller">Webfactory\ShortcodeBundle\Controller\GuideController:detailAction</default>
     </route>
 
 </routes>
diff --git a/Resources/config/guide.xml b/Resources/config/guide.xml
@@ -5,7 +5,7 @@
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
     <services>
 
-        <service id="webfactory.shortcode.guide.controller" class="Webfactory\ShortcodeBundle\Controller\GuideController">
+        <service id="Webfactory\ShortcodeBundle\Controller\GuideController">
             <argument><!-- shortcode description placeholder argument --></argument>
         </service>
 
diff --git a/Resources/config/shortcodes.xml b/Resources/config/shortcodes.xml
@@ -6,21 +6,19 @@
     <services>
 
         <!-- Definition of a Shortcode HandlerContainer instance. -->
-        <service id="webfactory.shortcode.handler_container" class="Thunder\Shortcode\HandlerContainer\HandlerContainer">
-        </service>
+        <service id="Thunder\Shortcode\HandlerContainer\HandlerContainer"/>
 
         <!-- Definition of a Shortcode RegularParser instance. -->
-        <service id="webfactory.shortcode.regular_parser" class="Thunder\Shortcode\Parser\RegularParser">
-        </service>
+        <service id="Thunder\Shortcode\Parser\RegularParser"/>
 
         <!-- Definition of a Shortcode Processor instance. -->
-        <service id="webfactory.shortcode.processor" class="Thunder\Shortcode\Processor\Processor">
-            <argument type="service" id="webfactory.shortcode.regular_parser" />
-            <argument type="service" id="webfactory.shortcode.handler_container" />
+        <service id="Thunder\Shortcode\Processor\Processor">
+            <argument type="service" id="Thunder\Shortcode\Parser\RegularParser" />
+            <argument type="service" id="Thunder\Shortcode\HandlerContainer\HandlerContainer" />
         </service>
 
         <!-- Definition of a Shortcode EventContainer instance. -->
-        <service id="webfactory.shortcode.event_container" class="Thunder\Shortcode\EventContainer\EventContainer">
+        <service id="Thunder\Shortcode\EventContainer\EventContainer">
             <!-- Event handler that removes <p>...</p> tag that directly wrap shortcodes. -->
             <call method="addListener">
                 <argument type="constant">\Thunder\Shortcode\Events::REPLACE_SHORTCODES</argument>
@@ -31,27 +29,33 @@
         </service>
 
         <!-- Base definition for the EmbedForShortcodeHandler with esi renderer. -->
-        <service abstract="true" id="webfactory.shortcode.embed_esi_for_shortcode_handler" class="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler" lazy="true">
+        <service abstract="true" id="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.esi" class="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler" lazy="true">
             <argument type="service" id="fragment.handler"/>
             <argument><!-- Controller name placeholder argument --></argument>
             <argument>esi</argument>
             <argument type="service" id="request_stack" />
             <argument type="service" id="logger" on-invalid="null" />
         </service>
 
+        <!-- alias for BC -->
+        <service id="webfactory.shortcode.embed_esi_for_shortcode_handler" alias="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.esi"/>
+
         <!-- Base definition for the EmbedForShortcodeHandler with inline renderer. -->
-        <service abstract="true" id="webfactory.shortcode.embed_inline_for_shortcode_handler" class="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler" lazy="true">
+        <service abstract="true" id="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.inline" class="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler" lazy="true">
             <argument type="service" id="fragment.handler"/>
             <argument><!-- Controller name placeholder argument --></argument>
             <argument>inline</argument>
             <argument type="service" id="request_stack" />
             <argument type="service" id="logger" on-invalid="null" />
         </service>
 
+        <!-- alias for BC -->
+        <service id="webfactory.shortcode.embed_inline_for_shortcode_handler" alias="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.inline"/>
+
         <!-- Twig extension providing the |shortcodes filter. The content will be passed to the Shortcode Processor. -->
         <service id="Webfactory\ShortcodeBundle\Twig\ShortcodeExtension" class="Webfactory\ShortcodeBundle\Twig\ShortcodeExtension">
-            <argument type="service" id="webfactory.shortcode.processor"/>
-            <argument type="service" id="webfactory.shortcode.event_container"/>
+            <argument type="service" id="Thunder\Shortcode\Processor\Processor"/>
+            <argument type="service" id="Thunder\Shortcode\EventContainer\EventContainer"/>
             <tag name="twig.extension"/>
         </service>
 
diff --git a/Tests/DependencyInjection/Compiler/ShortcodeCompilerPassTest.php b/Tests/DependencyInjection/Compiler/ShortcodeCompilerPassTest.php
@@ -6,6 +6,8 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
+use Thunder\Shortcode\HandlerContainer\HandlerContainer;
+use Webfactory\ShortcodeBundle\Controller\GuideController;
 use Webfactory\ShortcodeBundle\DependencyInjection\Compiler\ShortcodeCompilerPass;
 
 final class ShortcodeCompilerPassTest extends TestCase
@@ -58,7 +60,7 @@ public function tagged_services_are_added_as_handlers_to_handler_container()
 
         $this->containerBuilder->expects($this->once())
             ->method('findDefinition')
-            ->with('webfactory.shortcode.handler_container')
+            ->with(HandlerContainer::class)
             ->willReturn($mockedShortcodeHandlerContainer);
 
         $this->compilerPass->process($this->containerBuilder);
@@ -92,12 +94,12 @@ public function shortcode_guide_service_gets_configured_if_set()
 
         $this->containerBuilder->expects($this->once())
             ->method('findDefinition')
-            ->with('webfactory.shortcode.handler_container')
+            ->with(HandlerContainer::class)
             ->willReturn($this->createMock(Definition::class));
 
         $this->containerBuilder->expects($this->once())
             ->method('has')
-            ->with('webfactory.shortcode.guide.controller')
+            ->with(GuideController::class)
             ->willReturn(true);
 
         $mockedShortcodeGuideServiceDefinition = $this->createMock(Definition::class);
@@ -113,7 +115,7 @@ public function shortcode_guide_service_gets_configured_if_set()
 
         $this->containerBuilder->expects($this->once())
             ->method('getDefinition')
-            ->with('webfactory.shortcode.guide.controller')
+            ->with(GuideController::class)
             ->willReturn($mockedShortcodeGuideServiceDefinition);
 
         $this->compilerPass->process($this->containerBuilder);
@@ -130,7 +132,7 @@ public function missing_shortcode_guide_service_does_no_harm()
 
         $this->containerBuilder->expects($this->once())
             ->method('has')
-            ->with('webfactory.shortcode.guide.controller')
+            ->with(GuideController::class)
             ->willReturn(false);
 
         $this->compilerPass->process($this->containerBuilder);
diff --git a/Tests/Fixtures/config/test_shortcodes.xml b/Tests/Fixtures/config/test_shortcodes.xml
@@ -7,13 +7,13 @@
 
         <!-- Two shortcode handlers defined for tests -->
 
-        <service id="test_esi" parent="webfactory.shortcode.embed_esi_for_shortcode_handler">
+        <service id="test_esi" parent="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.esi">
             <argument index="1">test-esi-controller</argument>
             <argument index="4">null</argument><!-- Logger -->
             <tag name="webfactory.shortcode" shortcode="test-esi"/>
         </service>
 
-        <service id="test_inline" parent="webfactory.shortcode.embed_inline_for_shortcode_handler">
+        <service id="test_inline" parent="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.inline">
             <argument index="1">test-inline-controller</argument>
             <argument index="4">null</argument><!-- Logger -->
             <tag name="webfactory.shortcode" shortcode="test-inline"/>
