Merge pull request #1495 from JHertz5/issue-1492

Issue#1492: New rules to handle whitespace in array definitions

Author: JHertz5

docs/configuring_whitespace_rules.rst

@@ -161,6 +161,8 @@ Rules Enforcing Whitespace
 * `constant_010 <constant_rules.html#constant-010>`_
 * `constant_100 <constant_rules.html#constant-100>`_
 * `constant_101 <constant_rules.html#constant-101>`_
+* `constrained_array_definition_100 <constrained_array_definition_rules.html#constrained-array-definition-100>`_
+* `constrained_array_definition_101 <constrained_array_definition_rules.html#constrained-array-definition-101>`_
 * `context_002 <context_rules.html#context-002>`_
 * `context_017 <context_rules.html#context-017>`_
 * `context_018 <context_rules.html#context-018>`_
@@ -285,6 +287,9 @@ Rules Enforcing Whitespace
 * `type_006 <type_rules.html#type-006>`_
 * `type_007 <type_rules.html#type-007>`_
 * `type_100 <type_rules.html#type-100>`_
+* `unbounded_array_definition_100 <unbounded_array_definition_rules.html#unbounded-array-definition-100>`_
+* `unbounded_array_definition_101 <unbounded_array_definition_rules.html#unbounded-array-definition-101>`_
+* `unbounded_array_definition_102 <unbounded_array_definition_rules.html#unbounded-array-definition-102>`_
 * `variable_005 <variable_rules.html#variable-005>`_
 * `variable_006 <variable_rules.html#variable-006>`_
 * `variable_100 <variable_rules.html#variable-100>`_

docs/constrained_array_definition_rules.rst

@@ -3,6 +3,48 @@
 Constrained Array Definition Rules
 ----------------------------------
 
+constrained_array_definition_100
+################################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **of** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type t_u_array is array(1 downto 0)    of unsigned;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type t_u_array is array(1 downto 0) of unsigned;
+
+constrained_array_definition_101
+################################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **of** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type t_u_array is array(1 downto 0) of     unsigned;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type t_u_array is array(1 downto 0) of unsigned;
+
 constrained_array_definition_500
 ################################
 

docs/rule_groups/whitespace_rule_group.rst

@@ -55,6 +55,8 @@ Rules Enforcing Whitespace Rule Group
 * `constant_010 <../constant_rules.html#constant-010>`_
 * `constant_100 <../constant_rules.html#constant-100>`_
 * `constant_101 <../constant_rules.html#constant-101>`_
+* `constrained_array_definition_100 <../constrained_array_definition_rules.html#constrained-array-definition-100>`_
+* `constrained_array_definition_101 <../constrained_array_definition_rules.html#constrained-array-definition-101>`_
 * `context_002 <../context_rules.html#context-002>`_
 * `context_017 <../context_rules.html#context-017>`_
 * `context_018 <../context_rules.html#context-018>`_
@@ -182,6 +184,9 @@ Rules Enforcing Whitespace Rule Group
 * `type_006 <../type_rules.html#type-006>`_
 * `type_007 <../type_rules.html#type-007>`_
 * `type_100 <../type_rules.html#type-100>`_
+* `unbounded_array_definition_100 <../unbounded_array_definition_rules.html#unbounded-array-definition-100>`_
+* `unbounded_array_definition_101 <../unbounded_array_definition_rules.html#unbounded-array-definition-101>`_
+* `unbounded_array_definition_102 <../unbounded_array_definition_rules.html#unbounded-array-definition-102>`_
 * `variable_005 <../variable_rules.html#variable-005>`_
 * `variable_006 <../variable_rules.html#variable-006>`_
 * `variable_100 <../variable_rules.html#variable-100>`_

docs/unbounded_array_definition_rules.rst

@@ -3,6 +3,71 @@
 Unbounded Array Definition Rules
 --------------------------------
 
+unbounded_array_definition_100
+##############################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for whitespace after the **array** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type t_u_array_unconstrained is array (natural range <>) of unsigned;
+   type t_u_array_unconstrained is array     (natural range <>) of unsigned;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type t_u_array_unconstrained is array(natural range <>) of unsigned;
+   type t_u_array_unconstrained is array(natural range <>) of unsigned;
+
+unbounded_array_definition_101
+##############################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **of** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type t_u_array_unconstrained is array(natural range <>)       of unsigned;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type t_u_array_unconstrained is array(natural range <>) of unsigned;
+
+unbounded_array_definition_102
+##############################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **of** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type t_u_array_unconstrained is array(natural range <>) of        unsigned;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type t_u_array_unconstrained is array(natural range <>) of unsigned;
+
 unbounded_array_definition_500
 ##############################
 

tests/constrained_array_definition/rule_100_test_input.fixed.vhd

@@ -0,0 +1,12 @@
+
+architecture RTL of FIFO is
+
+  type my_array is array(natural range 0 to 7) of std_logic_vector(7 downto 0);
+  type my_array is array(natural range 0 to 7) of std_logic_vector(7 downto 0);
+
+  type my_array is array(0 to 7) of std_logic_vector(7 downto 0);
+  type my_array is array(0 to 7) of std_logic_vector(7 downto 0);
+
+begin
+
+end architecture RTL;

tests/constrained_array_definition/rule_100_test_input.vhd

@@ -0,0 +1,12 @@
+
+architecture RTL of FIFO is
+
+  type my_array is array(natural range 0 to 7)      of std_logic_vector(7 downto 0);
+  type my_array is array(natural range 0 to 7) of std_logic_vector(7 downto 0);
+
+  type my_array is array(0 to 7)      of std_logic_vector(7 downto 0);
+  type my_array is array(0 to 7) of std_logic_vector(7 downto 0);
+
+begin
+
+end architecture RTL;

tests/constrained_array_definition/rule_101_test_input.fixed.vhd

@@ -0,0 +1,12 @@
+
+architecture RTL of FIFO is
+
+  type my_array is array(natural range 0 to 7) of std_logic_vector(7 downto 0);
+  type my_array is array(natural range 0 to 7) of std_logic_vector(7 downto 0);
+
+  type my_array is array(0 to 7) of std_logic_vector(7 downto 0);
+  type my_array is array(0 to 7) of std_logic_vector(7 downto 0);
+
+begin
+
+end architecture RTL;

tests/constrained_array_definition/rule_101_test_input.vhd

@@ -0,0 +1,12 @@
+
+architecture RTL of FIFO is
+
+  type my_array is array(natural range 0 to 7) of        std_logic_vector(7 downto 0);
+  type my_array is array(natural range 0 to 7) of std_logic_vector(7 downto 0);
+
+  type my_array is array(0 to 7) of        std_logic_vector(7 downto 0);
+  type my_array is array(0 to 7) of std_logic_vector(7 downto 0);
+
+begin
+
+end architecture RTL;

tests/constrained_array_definition/test_rule_100.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+
+from tests import utils
+from vsg import vhdlFile
+from vsg.rules import constrained_array_definition
+
+sTestDir = os.path.dirname(__file__)
+
+lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_100_test_input.vhd"))
+
+dIndentMap = utils.read_indent_file()
+
+lExpected = []
+lExpected.append("")
+utils.read_file(os.path.join(sTestDir, "rule_100_test_input.fixed.vhd"), lExpected)
+
+
+class test_rule(unittest.TestCase):
+    def setUp(self):
+        self.oFile = vhdlFile.vhdlFile(lFile)
+        self.assertIsNone(eError)
+        self.oFile.set_indent_map(dIndentMap)
+
+    def test_rule_100(self):
+        oRule = constrained_array_definition.rule_100()
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "constrained_array_definition")
+        self.assertEqual(oRule.identifier, "100")
+
+        lExpected = [4, 7]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
+
+    def test_fix_rule_100(self):
+        oRule = constrained_array_definition.rule_100()
+
+        oRule.fix(self.oFile)
+
+        lActual = self.oFile.get_lines()
+
+        self.assertEqual(lExpected, lActual)
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(oRule.violations, [])

tests/constrained_array_definition/test_rule_101.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+
+from tests import utils
+from vsg import vhdlFile
+from vsg.rules import constrained_array_definition
+
+sTestDir = os.path.dirname(__file__)
+
+lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_101_test_input.vhd"))
+
+dIndentMap = utils.read_indent_file()
+
+lExpected = []
+lExpected.append("")
+utils.read_file(os.path.join(sTestDir, "rule_101_test_input.fixed.vhd"), lExpected)
+
+
+class test_rule(unittest.TestCase):
+    def setUp(self):
+        self.oFile = vhdlFile.vhdlFile(lFile)
+        self.assertIsNone(eError)
+        self.oFile.set_indent_map(dIndentMap)
+
+    def test_rule_101(self):
+        oRule = constrained_array_definition.rule_101()
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "constrained_array_definition")
+        self.assertEqual(oRule.identifier, "101")
+
+        lExpected = [4, 7]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
+
+    def test_fix_rule_101(self):
+        oRule = constrained_array_definition.rule_101()
+
+        oRule.fix(self.oFile)
+
+        lActual = self.oFile.get_lines()
+
+        self.assertEqual(lExpected, lActual)
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(oRule.violations, [])