allow to configure a priority per namespace

Author: nehlsen

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.0.0
+
+- Changed configuration format to allow setting a priority per mapping
+
 ## 1.0.0
 
 - Initial Version

README.md

@@ -28,7 +28,7 @@ jms_serializer:
     directories:
       my_bundle:
         path: '@MyBundle/../config/serializer'
-        namespace_prefix: 'my-bundle'
+        namespace_prefix: 'my_bundle'
       app:
         path: '%kernel.project_dir%/config/serializer'
         namespace_prefix: 'app'
@@ -38,8 +38,32 @@ jms_serializer:
 
 neusta_jms_serializer_extension:
   non_prefixed_namespaces:
-    - 'my-bundle'
-    - 'app'
+    my_bundle: ~
+    app: ~
+```
+
+### Overriding load priority
+
+It is possible to provide a `priority` per namespace. If no priority is given, `0` is assumed. When multiple configuration files for a class are found, the one with the highest priority is used.
+
+For example, consider the following configuration. If a configuration file for a given class is found in both `my_bundle` and `another_bundle`, the configuration from `my_bundle` is used because it has a higher priority.
+
+```yaml
+jms_serializer:
+  metadata:
+    directories:
+      my_bundle:
+        path: '@MyBundle/../config/serializer'
+        namespace_prefix: 'my_bundle'
+      another_bundle:
+        namespace_prefix: "Company\\Thing\\CoolBundle"
+        path: "@CompanyThingCoolBundle/../config/serializer"
+
+neusta_jms_serializer_extension:
+  non_prefixed_namespaces:
+    my_bundle:
+      priority: 10
+    another_bundle: ~
 ```
 
 ## Contribution

src/DependencyInjection/Configuration.php

@@ -16,7 +16,12 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->children()
                 ->arrayNode('non_prefixed_namespaces')
                     ->info('namespace names which should be ignored')
-                    ->prototype('scalar')->end()
+                    ->useAttributeAsKey('name')
+                    ->prototype('array')
+                        ->children()
+                            ->scalarNode('priority')->defaultNull()->end()
+                        ->end()
+                    ->end()
                 ->end()
             ->end()
         ;

src/Serializer/FileLocator.php

@@ -18,8 +18,10 @@ public function __construct(OriginalFileLocator $fileLocator, private readonly a
 
     public function findFileForClass(\ReflectionClass $class, string $extension): ?string
     {
+        $possibleMatches = [];
+
         foreach ($this->dirs as $prefix => $dir) {
-            $nonPrefixed = \in_array($prefix, $this->non_prefixed_namespaces, true);
+            $nonPrefixed = \array_key_exists($prefix, $this->non_prefixed_namespaces);
             if (!$nonPrefixed && !str_starts_with($class->getNamespaceName(), $prefix)) {
                 continue;
             }
@@ -31,10 +33,38 @@ public function findFileForClass(\ReflectionClass $class, string $extension): ?s
                 ) . '.' . $extension;
 
             if (file_exists($path)) {
-                return $path;
+                $possibleMatches[$prefix] = $path;
             }
         }
 
+        if (!empty($possibleMatches)) {
+            $possibleMatchesSorted = $this->sortPossibleMatchesByPrefixPriority($possibleMatches);
+            // return last one -> the highest priority
+            end($possibleMatchesSorted);
+            return current($possibleMatchesSorted);
+        }
+
         return null;
     }
+
+    /**
+     * @param array<string, string> $possibleMatches prefix => file
+     * @return array<string, string> same as input but ordered by prefix priority
+     */
+    private function sortPossibleMatchesByPrefixPriority(array $possibleMatches): array
+    {
+        uksort($possibleMatches, function (string $prefix_a, string $prefix_b) {
+            $getPrio = function (string $prefix): int {
+                if (array_key_exists($prefix, $this->non_prefixed_namespaces) && array_key_exists('priority', $this->non_prefixed_namespaces[$prefix])) {
+                    return (int) $this->non_prefixed_namespaces[$prefix]['priority'];
+                }
+
+                return 0;
+            };
+
+            return $getPrio($prefix_a) <=> $getPrio($prefix_b);
+        });
+
+        return $possibleMatches;
+    }
 }