Merge pull request #1498 from JHertz5/issue-1489

Issue#1489: Update `whitespace_005` to make ignoring of whitespace before numbers optional

Author: JHertz5

docs/whitespace_rules.rst

@@ -91,7 +91,8 @@ whitespace_005
 This rule checks for spaces after an open parenthesis.
 
 .. NOTE::
-   Spaces before numbers are allowed.
+   Spaces before numbers are ignored.
+   This can be disabled by setting the *'ignore_spaces_before_numbers'* attribute to *'False'*.
 
 **Violation**
 

tests/whitespace/rule_005_test_input.fixed_ignore_spaces_before_numbers_false.vhd

@@ -0,0 +1,16 @@
+
+architecture RTL of FIFO is
+
+  signal sig1 : std_logic_vector(31 downto 0);
+  signal sig2 : std_logic_vector(3 downto 0);
+  signal sig3 : std_logic_vector(c_width downto 0);
+
+  -- Violations
+
+  signal sig1 : std_logic_vector(31 downto 0);
+  signal sig2 : std_logic_vector(3 downto 0);
+  signal sig3 : std_logic_vector(c_width downto 0);
+
+begin
+
+end architecture RTL;

…whitespace/rule_005_test_input.fixed.vhd …ed_ignore_spaces_before_numbers_true.vhdtests/whitespace/rule_005_test_input.fixed.vhd renamed to tests/whitespace/rule_005_test_input.fixed_ignore_spaces_before_numbers_true.vhd tests/whitespace/rule_005_test_input.fixed.vhd renamed to tests/whitespace/rule_005_test_input.fixed_ignore_spaces_before_numbers_true.vhd

@@ -10,17 +10,35 @@
 sTestDir = os.path.dirname(__file__)
 
 lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_005_test_input.vhd"))
-lExpected = []
-lExpected.append("")
-utils.read_file(os.path.join(sTestDir, "rule_005_test_input.fixed.vhd"), lExpected)
+
+lExpected_ignore_spaces_before_numbers_false = []
+lExpected_ignore_spaces_before_numbers_false.append("")
+utils.read_file(os.path.join(sTestDir, "rule_005_test_input.fixed_ignore_spaces_before_numbers_false.vhd"), lExpected_ignore_spaces_before_numbers_false)
+
+lExpected_ignore_spaces_before_numbers_true = []
+lExpected_ignore_spaces_before_numbers_true.append("")
+utils.read_file(os.path.join(sTestDir, "rule_005_test_input.fixed_ignore_spaces_before_numbers_true.vhd"), lExpected_ignore_spaces_before_numbers_true)
 
 
 class test_rule(unittest.TestCase):
     def setUp(self):
         self.oFile = vhdlFile.vhdlFile(lFile)
         self.assertIsNone(eError)
 
-    def test_rule_005(self):
+    def test_rule_005_ignore_spaces_before_numbers_false(self):
+        oRule = whitespace.rule_005()
+        oRule.ignore_spaces_before_numbers = False
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "whitespace")
+        self.assertEqual(oRule.identifier, "005")
+        self.assertEqual(oRule.groups, ["whitespace"])
+
+        lExpected = [5, 10, 12]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
+
+    def test_rule_005_ignore_spaces_before_numbers_true(self):
         oRule = whitespace.rule_005()
         self.assertTrue(oRule)
         self.assertEqual(oRule.name, "whitespace")
@@ -32,14 +50,27 @@ def test_rule_005(self):
         oRule.analyze(self.oFile)
         self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
 
-    def test_fix_rule_005(self):
+    def test_fix_rule_005_ignore_spaces_before_numbers_false(self):
+        oRule = whitespace.rule_005()
+        oRule.ignore_spaces_before_numbers = False
+
+        oRule.fix(self.oFile)
+
+        lActual = self.oFile.get_lines()
+
+        self.assertEqual(lExpected_ignore_spaces_before_numbers_false, lActual)
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(oRule.violations, [])
+
+    def test_fix_rule_005_ignore_spaces_before_numbers_true(self):
         oRule = whitespace.rule_005()
 
         oRule.fix(self.oFile)
 
         lActual = self.oFile.get_lines()
 
-        self.assertEqual(lExpected, lActual)
+        self.assertEqual(lExpected_ignore_spaces_before_numbers_true, lActual)
 
         oRule.analyze(self.oFile)
         self.assertEqual(oRule.violations, [])

tests/whitespace/test_rule_005.py

@@ -13,7 +13,8 @@ class rule_005(whitespace.Rule):
     This rule checks for spaces after an open parenthesis.
 
     .. NOTE::
-       Spaces before numbers are allowed.
+       Spaces before numbers are ignored.
+       This can be disabled by setting the *'ignore_spaces_before_numbers'* attribute to *'False'*.
 
     **Violation**
 
@@ -38,6 +39,8 @@ def __init__(self):
         self.iSpaces = 0
         self.lTokens = [parser.open_parenthesis]
         self.configuration_documentation_link = None
+        self.ignore_spaces_before_numbers = True
+        self.configuration.append("ignore_spaces_before_numbers")
 
     def _get_tokens_of_interest(self, oFile):
         return oFile.get_n_tokens_before_and_after_tokens(2, self.lTokens)
@@ -49,7 +52,7 @@ def _analyze(self, lToi):
             oRight = lTokens[-2]
             if isinstance(oRight, parser.whitespace):
                 if not utils.token_is_whitespace_or_comment(lTokens[-1]):
-                    if not lTokens[-1].get_value().isnumeric():
+                    if not (lTokens[-1].get_value().isnumeric() and self.ignore_spaces_before_numbers):
                         oViolation = violation.New(iLine, oToi, self.solution)
                         self.add_violation(oViolation)