Issue#1479: Modified architecture_025 to accept regular expressions as names (#1487)

* Issue#1479: Modified architecture_025 to accept regular expressions as names.

* Issue#1479: Corrected error by resetting regexp names.

* Issue#1479: Modified test for architecture_025 to test regular expressions as names.

* Issue#1479: Modified docs for architecture_025.

* Issue#1479: Formatting.

* Issue#1479: Code improvement.

* Issue#1479: Formatting.

Author: JHertz5

docs/architecture_rules.rst

@@ -516,6 +516,7 @@ architecture_025
 This rule checks for valid names for the architecture.
 Typical architecture names are:  RTL, EMPTY, and BEHAVE.
 This rule allows the user to restrict what can be used for an architecture name.
+Note that regular expressions are accepted in the **names** field.
 
 .. NOTE:: This rule is disabled by default.
    You can enable and configure the names using the following configuration.
@@ -531,6 +532,7 @@ This rule allows the user to restrict what can be used for an architecture name.
             - rtl
             - empty
             - behave
+            - my_pattern.*
 
 **Violation**
 

tests/architecture/test_rule_025.py

@@ -28,54 +28,68 @@ def test_rule_025(self):
         lExpected = [3, 10, 17, 24]
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
-        self.assertEqual("Architecture identifier must be from this list: ", oRule._get_solution(None))
+        self.assertEqual("Architecture identifier must match a name from this list: ", oRule._get_solution(None))
 
         oRule.violations = []
         oRule.names = []
         oRule.names.append("rtl")
         lExpected = [10, 17, 24]
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
-        self.assertEqual("Architecture identifier must be from this list: rtl", oRule._get_solution(None))
+        self.assertEqual("Architecture identifier must match a name from this list: rtl", oRule._get_solution(None))
 
         oRule.violations = []
         oRule.names = ["ENTITY1"]
         lExpected = [3, 17, 24]
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
-        self.assertEqual("Architecture identifier must be from this list: ENTITY1", oRule._get_solution(None))
+        self.assertEqual("Architecture identifier must match a name from this list: ENTITY1", oRule._get_solution(None))
 
         oRule.violations = []
         oRule.names = ["BLUE"]
         lExpected = [3, 10, 24]
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
-        self.assertEqual("Architecture identifier must be from this list: BLUE", oRule._get_solution(None))
+        self.assertEqual("Architecture identifier must match a name from this list: BLUE", oRule._get_solution(None))
 
         oRule.violations = []
         oRule.names = ["CDC"]
         lExpected = [3, 10, 17]
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
-        self.assertEqual("Architecture identifier must be from this list: CDC", oRule._get_solution(None))
+        self.assertEqual("Architecture identifier must match a name from this list: CDC", oRule._get_solution(None))
 
         oRule.violations = []
         oRule.names = ["rtl", "CDC"]
         lExpected = [10, 17]
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
-        self.assertEqual("Architecture identifier must be from this list: rtl, CDC", oRule._get_solution(None))
+        self.assertEqual("Architecture identifier must match a name from this list: rtl, CDC", oRule._get_solution(None))
 
         oRule.violations = []
         oRule.names = ["rtl", "cdc", "blue"]
         lExpected = [10]
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
-        self.assertEqual("Architecture identifier must be from this list: rtl, cdc, blue", oRule._get_solution(None))
+        self.assertEqual("Architecture identifier must match a name from this list: rtl, cdc, blue", oRule._get_solution(None))
 
         oRule.violations = []
         oRule.names = ["rtl", "cdc", "blue", "entity1"]
         lExpected = []
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
-        self.assertEqual("Architecture identifier must be from this list: rtl, cdc, blue, entity1", oRule._get_solution(None))
+        self.assertEqual("Architecture identifier must match a name from this list: rtl, cdc, blue, entity1", oRule._get_solution(None))
+
+        oRule.violations = []
+        oRule.names = [".ntit\w\d"]
+        lExpected = [3, 17, 24]
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
+        self.assertEqual("Architecture identifier must match a name from this list: .ntit\w\d", oRule._get_solution(None))
+
+        oRule.violations = []
+        oRule.names = ["\w\w\w", "b...", ".ntit\w\d"]
+        lExpected = []
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
+        self.assertEqual("Architecture identifier must match a name from this list: \w\w\w, b..., .ntit\w\d", oRule._get_solution(None))

vsg/rules/__init__.py

@@ -32,7 +32,7 @@
 from .insert_token_next_to_token_if_it_does_not_exist_between_tokens_using_value_from_token import (
     insert_token_next_to_token_if_it_does_not_exist_between_tokens_using_value_from_token,
 )
-from .is_token_value_one_of import is_token_value_one_of
+from .does_token_value_match_one_of import does_token_value_match_one_of
 from .align_tokens_in_region_between_tokens import align_tokens_in_region_between_tokens
 from .align_tokens_in_region_between_tokens_unless_between_tokens import align_tokens_in_region_between_tokens_unless_between_tokens
 from .align_tokens_in_region_between_tokens_when_between_tokens_unless_between_tokens import (

vsg/rules/architecture/rule_025.py

@@ -1,14 +1,15 @@
 # -*- coding: utf-8 -*-
 
-from vsg.rules import is_token_value_one_of
+from vsg.rules import does_token_value_match_one_of
 from vsg.token import architecture_body as token
 
 
-class rule_025(is_token_value_one_of):
+class rule_025(does_token_value_match_one_of):
     """
     This rule checks for valid names for the architecture.
     Typical architecture names are:  RTL, EMPTY, and BEHAVE.
     This rule allows the user to restrict what can be used for an architecture name.
+    Note that regular expressions are accepted in the **names** field.
 
     .. NOTE:: This rule is disabled by default.
        You can enable and configure the names using the following configuration.
@@ -24,6 +25,7 @@ class rule_025(is_token_value_one_of):
                 - rtl
                 - empty
                 - behave
+                - my_pattern.*
 
     **Violation**
 
@@ -40,4 +42,4 @@ def __init__(self):
         super().__init__(token.identifier)
 
     def _get_solution(self, iLineNumber):
-        return "Architecture identifier must be from this list: " + ", ".join(self.names)
+        return "Architecture identifier must match a name from this list: " + ", ".join(self.names)

vsg/rules/is_token_value_one_of.py …g/rules/does_token_value_match_one_of.pyvsg/rules/is_token_value_one_of.py renamed to vsg/rules/does_token_value_match_one_of.py vsg/rules/is_token_value_one_of.py renamed to vsg/rules/does_token_value_match_one_of.py

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
 
+import re
 
 from vsg import violation
 from vsg.rule_group import naming
 
 
-class is_token_value_one_of(naming.Rule):
+class does_token_value_match_one_of(naming.Rule):
     """
-    Checks if a token value is in a list of provided values.
+    Checks if a token value matches one of provided regex patterns.
     """
 
     def __init__(self, token):
@@ -24,11 +25,15 @@ def _get_tokens_of_interest(self, oFile):
 
     def _analyze(self, lToi):
         self.solution = self._get_solution(None)
-        lower_names = []
-        for sName in self.names:
-            lower_names.append(sName.lower())
+        lRegexNames = [re.compile(name, re.IGNORECASE) for name in self.names]
 
         for oToi in lToi:
             lTokens = oToi.get_tokens()
-            if not lTokens[0].get_lower_value() in lower_names:
+            if self._check_for_violation(lTokens[0].get_lower_value(), lRegexNames):
                 self.add_violation(violation.New(oToi.get_line_number(), oToi, self.solution))
+
+    def _check_for_violation(self, sToken, lRegexNames):
+        for regex in lRegexNames:
+            if regex.fullmatch(sToken) is not None:
+                return False
+        return True