[FrameworkBundle] Improve the sorting of tagged services

Kr42 · Kr42 · commit 9f2aa3aafb9e · 2019-10-14T09:29:16.000+04:00
diff --git a/Console/Descriptor/Descriptor.php b/Console/Descriptor/Descriptor.php
@@ -286,6 +286,25 @@ protected function sortTaggedServicesByPriority(array $services): array
         return array_keys($maxPriority);
     }
 
+    protected function sortTagsByPriority(array $tags): array
+    {
+        $sortedTags = [];
+        foreach ($tags as $tagName => $tag) {
+            $sortedTags[$tagName] = $this->sortByPriority($tag);
+        }
+
+        return $sortedTags;
+    }
+
+    protected function sortByPriority(array $tag): array
+    {
+        usort($tag, function ($a, $b) {
+            return ($b['priority'] ?? 0) <=> ($a['priority'] ?? 0);
+        });
+
+        return $tag;
+    }
+
     /**
      * Gets class description from a docblock.
      */
diff --git a/Console/Descriptor/JsonDescriptor.php b/Console/Descriptor/JsonDescriptor.php
@@ -270,7 +270,7 @@ private function getContainerDefinitionData(Definition $definition, bool $omitTa
 
         if (!$omitTags) {
             $data['tags'] = [];
-            foreach ($definition->getTags() as $tagName => $tagData) {
+            foreach ($this->sortTagsByPriority($definition->getTags()) as $tagName => $tagData) {
                 foreach ($tagData as $parameters) {
                     $data['tags'][] = ['name' => $tagName, 'parameters' => $parameters];
                 }
diff --git a/Console/Descriptor/MarkdownDescriptor.php b/Console/Descriptor/MarkdownDescriptor.php
@@ -233,7 +233,7 @@ protected function describeContainerDefinition(Definition $definition, array $op
         }
 
         if (!(isset($options['omit_tags']) && $options['omit_tags'])) {
-            foreach ($definition->getTags() as $tagName => $tagData) {
+            foreach ($this->sortTagsByPriority($definition->getTags()) as $tagName => $tagData) {
                 foreach ($tagData as $parameters) {
                     $output .= "\n".'- Tag: `'.$tagName.'`';
                     foreach ($parameters as $name => $value) {
diff --git a/Console/Descriptor/TextDescriptor.php b/Console/Descriptor/TextDescriptor.php
@@ -238,7 +238,7 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
             $styledServiceId = $rawOutput ? $serviceId : sprintf('<fg=cyan>%s</fg=cyan>', OutputFormatter::escape($serviceId));
             if ($definition instanceof Definition) {
                 if ($showTag) {
-                    foreach ($definition->getTag($showTag) as $key => $tag) {
+                    foreach ($this->sortByPriority($definition->getTag($showTag)) as $key => $tag) {
                         $tagValues = [];
                         foreach ($tagsNames as $tagName) {
                             $tagValues[] = isset($tag[$tagName]) ? $tag[$tagName] : '';
diff --git a/Console/Descriptor/XmlDescriptor.php b/Console/Descriptor/XmlDescriptor.php
@@ -371,7 +371,7 @@ private function getContainerDefinitionDocument(Definition $definition, string $
         }
 
         if (!$omitTags) {
-            if ($tags = $definition->getTags()) {
+            if ($tags = $this->sortTagsByPriority($definition->getTags())) {
                 $serviceXML->appendChild($tagsXML = $dom->createElement('tags'));
                 foreach ($tags as $tagName => $tagData) {
                     foreach ($tagData as $parameters) {
diff --git a/Tests/Fixtures/Descriptor/builder_priority_tag.json b/Tests/Fixtures/Descriptor/builder_priority_tag.json
@@ -14,16 +14,16 @@
                 {
                     "name": "tag1",
                     "parameters": {
-                        "attr1": "val1",
-                        "attr2": "val2",
-                        "priority": 0
+                        "attr3": "val3",
+                        "priority": 40
                     }
                 },
                 {
                     "name": "tag1",
                     "parameters": {
-                        "attr3": "val3",
-                        "priority": 40
+                        "attr1": "val1",
+                        "attr2": "val2",
+                        "priority": 0
                     }
                 }
             ]
@@ -87,4 +87,4 @@
     },
     "aliases": [],
     "services": []
-}
+}
diff --git a/Tests/Fixtures/Descriptor/builder_priority_tag.md b/Tests/Fixtures/Descriptor/builder_priority_tag.md
@@ -15,13 +15,13 @@ Definitions
 - Autowired: no
 - Autoconfigured: no
 - File: `/path/to/file`
+- Tag: `tag1`
+    - Attr3: val3
+    - Priority: 40
 - Tag: `tag1`
     - Attr1: val1
     - Attr2: val2
     - Priority: 0
-- Tag: `tag1`
-    - Attr3: val3
-    - Priority: 40
 
 ### definition_1
 
diff --git a/Tests/Fixtures/Descriptor/builder_priority_tag.txt b/Tests/Fixtures/Descriptor/builder_priority_tag.txt
@@ -5,8 +5,8 @@
  -------------- ------- ------- ---------- ------- ----------------------- 
  [32m Service ID   [39m [32m attr1 [39m [32m attr2 [39m [32m priority [39m [32m attr3 [39m [32m Class name            [39m 
  -------------- ------- ------- ---------- ------- ----------------------- 
-  definition_3   val1    val2    0                  Full\Qualified\Class3  
-    "                            40         val3                           
+  definition_3                   40         val3    Full\Qualified\Class3  
+    "            val1    val2    0                                         
   definition_1   val1            30                 Full\Qualified\Class1  
     "                    val2                                              
   definition_2   val1    val2    -20                Full\Qualified\Class2  
diff --git a/Tests/Fixtures/Descriptor/builder_priority_tag.xml b/Tests/Fixtures/Descriptor/builder_priority_tag.xml
@@ -2,15 +2,15 @@
 <container>
   <definition id="definition_3" class="Full\Qualified\Class3" public="true" synthetic="true" lazy="false" shared="true" abstract="false" autowired="false" autoconfigured="false" file="/path/to/file">
     <tags>
+      <tag name="tag1">
+        <parameter name="attr3">val3</parameter>
+        <parameter name="priority">40</parameter>
+      </tag>
       <tag name="tag1">
         <parameter name="attr1">val1</parameter>
         <parameter name="attr2">val2</parameter>
         <parameter name="priority">0</parameter>
       </tag>
-      <tag name="tag1">
-        <parameter name="attr3">val3</parameter>
-        <parameter name="priority">40</parameter>
-      </tag>
     </tags>
   </definition>
   <definition id="definition_1" class="Full\Qualified\Class1" public="true" synthetic="true" lazy="false" shared="true" abstract="false" autowired="false" autoconfigured="false" file="/path/to/file">

Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,7 @@ private function getContainerDefinitionData(Definition $definition, bool $omitTa`
`270`	`270`
`271`	`271`	`if (!$omitTags) {`
`272`	`272`	`$data['tags'] = [];`
`273`		`- foreach ($definition->getTags() as $tagName => $tagData) {`
	`273`	`+ foreach ($this->sortTagsByPriority($definition->getTags()) as $tagName => $tagData) {`
`274`	`274`	`foreach ($tagData as $parameters) {`
`275`	`275`	`$data['tags'][] = ['name' => $tagName, 'parameters' => $parameters];`
`276`	`276`	`}`
Original file line number	Diff line number	Diff line change
`@@ -233,7 +233,7 @@ protected function describeContainerDefinition(Definition $definition, array $op`
`233`	`233`	`}`
`234`	`234`
`235`	`235`	`if (!(isset($options['omit_tags']) && $options['omit_tags'])) {`
`236`		`- foreach ($definition->getTags() as $tagName => $tagData) {`
	`236`	`+ foreach ($this->sortTagsByPriority($definition->getTags()) as $tagName => $tagData) {`
`237`	`237`	`foreach ($tagData as $parameters) {`
`238`	`238`	$output .= "\n".'- Tag: `'.$tagName.'`';
`239`	`239`	`foreach ($parameters as $name => $value) {`
Original file line number	Diff line number	Diff line change
`@@ -371,7 +371,7 @@ private function getContainerDefinitionDocument(Definition $definition, string $`
`371`	`371`	`}`
`372`	`372`
`373`	`373`	`if (!$omitTags) {`
`374`		`- if ($tags = $definition->getTags()) {`
	`374`	`+ if ($tags = $this->sortTagsByPriority($definition->getTags())) {`
`375`	`375`	`$serviceXML->appendChild($tagsXML = $dom->createElement('tags'));`
`376`	`376`	`foreach ($tags as $tagName => $tagData) {`
`377`	`377`	`foreach ($tagData as $parameters) {`
Original file line number	Diff line number	Diff line change
`@@ -14,16 +14,16 @@`
`14`	`14`	`{`
`15`	`15`	`"name": "tag1",`
`16`	`16`	`"parameters": {`
`17`		`- "attr1": "val1",`
`18`		`- "attr2": "val2",`
`19`		`- "priority": 0`
	`17`	`+ "attr3": "val3",`
	`18`	`+ "priority": 40`
`20`	`19`	`}`
`21`	`20`	`},`
`22`	`21`	`{`
`23`	`22`	`"name": "tag1",`
`24`	`23`	`"parameters": {`
`25`		`- "attr3": "val3",`
`26`		`- "priority": 40`
	`24`	`+ "attr1": "val1",`
	`25`	`+ "attr2": "val2",`
	`26`	`+ "priority": 0`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	`]`
`@@ -87,4 +87,4 @@`
`87`	`87`	`},`
`88`	`88`	`"aliases": [],`
`89`	`89`	`"services": []`
`90`		`-}`
	`90`	`+}`