Fix separators count bug on names with hardcoded separators (#58)

* Fix separators count for names with hardcoded values which already include separators

Author: xiancg

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vfxnaming"
-version = "1.5.7-beta"
+version = "1.5.8-beta"
 authors = [
   { name="Chris Granados", email="info@chrisgranados.com" },
 ]

src/vfxnaming/rules.py

@@ -35,6 +35,7 @@ class Rule(Serializable):
     """
 
     __FIELDS_REGEX = re.compile(r"{(.+?)}")
+    __EXTRACT_FIELDS_REGEX = re.compile(r"(\{.+?(?::.+?)?\})")
     __PATTERN_SEPARATORS_REGEX = re.compile(
         r"(}[_\-\.:\|/\\]{|[_\-\.:\|/\\]{|}[_\-\.:\|/\\])"
     )
@@ -134,7 +135,11 @@ def parse(self, name: AnyStr) -> Union[Dict, None]:
             dict: A dictionary with keys as tokens and values as given name parts.
             e.g.: {'side':'C', 'part':'helmet', 'number': 1, 'type':'MSH'}
         """
-        expected_separators = self.__PATTERN_SEPARATORS_REGEX.findall(self._pattern)
+        extract_tokens = self.__EXTRACT_FIELDS_REGEX.findall(self._pattern)
+        pattern_wout_tokens = self._pattern
+        for each in extract_tokens:
+            pattern_wout_tokens = pattern_wout_tokens.replace(each, "XYZ")
+        expected_separators = self.__SEPARATORS_REGEX.findall(pattern_wout_tokens)
         if len(expected_separators) <= 0:
             logger.warning(
                 f"No separators used for rule '{self.name}', parsing is not possible."
@@ -186,7 +191,11 @@ def validate(self, name: AnyStr, strict: bool = False, **validate_values) -> boo
         Returns:
             bool: True if name matches the rule pattern, False otherwise.
         """
-        expected_separators = self.__PATTERN_SEPARATORS_REGEX.findall(self._pattern)
+        extract_tokens = self.__EXTRACT_FIELDS_REGEX.findall(self._pattern)
+        pattern_wout_tokens = self._pattern
+        for each in extract_tokens:
+            pattern_wout_tokens = pattern_wout_tokens.replace(each, "XYZ")
+        expected_separators = self.__SEPARATORS_REGEX.findall(pattern_wout_tokens)
         if len(expected_separators) <= 0:
             logger.warning(
                 f"No separators used for rule '{self.name}', parsing is not possible."

tests/naming_test.py

@@ -230,6 +230,10 @@ def setup(self):
         )
         tokens.add_token("type", lighting="LGT", animation="ANI", default="lighting")
         rules.add_rule("lights", "{category}_{function}_{whatAffects}_{digits}_{type}")
+        rules.add_rule(
+            "lights_extra",
+            "With_extra_{category}_{function}_{whatAffects}_{digits}_{type}",
+        )
 
     @pytest.mark.parametrize(
         "name,expected",
@@ -261,6 +265,7 @@ def setup(self):
         ],
     )
     def test_valid(self, name: str, expected: int):
+        rules.set_active_rule("lights")
         validated = n.validate(name)
         assert len(validated) == expected
 
@@ -290,9 +295,28 @@ def test_valid(self, name: str, expected: int):
         ],
     )
     def test_valid_with_tokens(self, name: str, validate_values: dict, expected: int):
+        rules.set_active_rule("lights")
         validated = n.validate(name, **validate_values)
         assert len(validated) == expected
 
+    @pytest.mark.parametrize(
+        "name,expected",
+        [
+            (
+                "With_extra_dramatic_bounce_chars_001_LGT",
+                1,
+            ),
+            (
+                "Withextra_dramatic_bounce_chars_001_LGT",
+                0,
+            ),
+        ],
+    )
+    def test_valid_with_hardcoded(self, name: str, expected: int):
+        rules.set_active_rule("lights_extra")
+        validated = n.validate(name)
+        assert len(validated) == expected
+
 
 class Test_ValidateHarcodedValues:
     @pytest.fixture(autouse=True)