Apply all matching rules to a field

Author: snejus

beetsplug/rewrite.py

@@ -48,11 +48,9 @@ def _(value: list[str], pat: re.Pattern[str], repl: str) -> list[str]:
 def apply_rewrite_rules(
     value: T, rules: list[tuple[re.Pattern[str], str]]
 ) -> T:
-    """Apply the first matching rewrite rule to the given value."""
+    """Apply all matching rewrite rules to the given value."""
     for pattern, replacement in rules:
-        if (new_value := rewrite_value(value, pattern, replacement)) != value:
-            # Rewrite activated.
-            return new_value
+        value = rewrite_value(value, pattern, replacement)
     # Not activated; return original value.
     return value
 

docs/changelog.rst

@@ -82,7 +82,8 @@ Bug fixes
   sources configuration is empty. :bug:`6336`
 - :doc:`plugins/rewrite` :doc:`plugins/advancedrewrite`: Fix rewriting
   multi-valued fields such as ``genres`` by applying rules to each matching list
-  entry. :bug:`6515`
+  entry. Additionally, apply rewrite rules in config order, so that multiple
+  rules can be applied to the same field. :bug:`6515`
 
 For plugin developers
 ~~~~~~~~~~~~~~~~~~~~~

docs/plugins/rewrite.rst

@@ -39,6 +39,18 @@ unchanged:
     rewrite:
         genres rock: Classic Rock
 
+Rules are applied in the order they appear in the config. This means a
+multi-valued field can have several entries rewritten by different rules:
+
+::
+
+    rewrite:
+        genres rock: Classic Rock
+        genres pop: Pop
+
+With this configuration, a ``genres`` value such as ``rock; pop; techno`` is
+rewritten to ``Classic Rock; Pop; techno``.
+
 As a convenience, the plugin applies patterns for the ``artist`` field to the
 ``albumartist`` field as well. (Otherwise, you would probably want to duplicate
 every rule for ``artist`` and ``albumartist``.)

test/plugins/test_rewrite.py

@@ -52,7 +52,6 @@ def test_rewrite_is_case_insensitive_and_leaves_non_matches_unchanged(
             assert matching_item.artist == "LOONA / ODD EYE CIRCLE"
             assert other_item.artist == "ARTMS"
 
-    @pytest.mark.xfail(reason="only the first pattern applied")
     def test_rewrite_applied_to_all_list_values(self):
         with self.configure_plugin(
             {"genres rock": "Classic Rock", "genres pop": "Pop"}