Merge pull request #1494 from JHertz5/issue-1491

Issue#1491: New rules to handle whitespace around range keywords

Author: JHertz5

docs/configuring_whitespace_rules.rst

@@ -212,6 +212,8 @@ Rules Enforcing Whitespace
 * `if_004 <if_rules.html#if-004>`_
 * `if_005 <if_rules.html#if-005>`_
 * `if_015 <if_rules.html#if-015>`_
+* `index_subtype_definition_100 <index_subtype_definition_rules.html#index-subtype-definition-100>`_
+* `index_subtype_definition_101 <index_subtype_definition_rules.html#index-subtype-definition-101>`_
 * `instantiation_002 <instantiation_rules.html#instantiation-002>`_
 * `instantiation_003 <instantiation_rules.html#instantiation-003>`_
 * `instantiation_032 <instantiation_rules.html#instantiation-032>`_
@@ -249,6 +251,8 @@ Rules Enforcing Whitespace
 * `process_014 <process_rules.html#process-014>`_
 * `process_024 <process_rules.html#process-024>`_
 * `process_025 <process_rules.html#process-025>`_
+* `range_constraint_100 <range_constraint_rules.html#range-constraint-100>`_
+* `range_constraint_101 <range_constraint_rules.html#range-constraint-101>`_
 * `record_type_definition_100 <record_type_definition_rules.html#record-type-definition-100>`_
 * `record_type_definition_101 <record_type_definition_rules.html#record-type-definition-101>`_
 * `report_statement_100 <report_statement_rules.html#report-statement-100>`_

docs/index_subtype_definition_rules.rst

@@ -3,6 +3,48 @@
 Index Subtype Definition Rules
 ------------------------------
 
+index_subtype_definition_100
+############################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **range** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type my_array is array (natural     range <>) of integer;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type my_array is array (natural range <>) of integer;
+
+index_subtype_definition_101
+############################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **range** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type my_array is array (natural range     <>) of integer;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type my_array is array (natural range <>) of integer;
+
 index_subtype_definition_500
 ############################
 

docs/range_constraint_rules.rst

@@ -3,6 +3,48 @@
 Range Constraint Rules
 ----------------------
 
+range_constraint_100
+####################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **range** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+  subtype my_range is natural     range 0 to 7;
+
+**Fix**
+
+.. code-block:: vhdl
+
+  subtype my_range is natural range 0 to 7;
+
+range_constraint_101
+####################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **range** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+  subtype my_range is natural range     0 to 7;
+
+**Fix**
+
+.. code-block:: vhdl
+
+  subtype my_range is natural range 0 to 7;
+
 range_constraint_500
 ####################
 

docs/rule_groups/whitespace_rule_group.rst

@@ -106,6 +106,8 @@ Rules Enforcing Whitespace Rule Group
 * `if_004 <../if_rules.html#if-004>`_
 * `if_005 <../if_rules.html#if-005>`_
 * `if_015 <../if_rules.html#if-015>`_
+* `index_subtype_definition_100 <../index_subtype_definition_rules.html#index-subtype-definition-100>`_
+* `index_subtype_definition_101 <../index_subtype_definition_rules.html#index-subtype-definition-101>`_
 * `instantiation_002 <../instantiation_rules.html#instantiation-002>`_
 * `instantiation_003 <../instantiation_rules.html#instantiation-003>`_
 * `instantiation_032 <../instantiation_rules.html#instantiation-032>`_
@@ -146,6 +148,8 @@ Rules Enforcing Whitespace Rule Group
 * `process_014 <../process_rules.html#process-014>`_
 * `process_024 <../process_rules.html#process-024>`_
 * `process_025 <../process_rules.html#process-025>`_
+* `range_constraint_100 <../range_constraint_rules.html#range-constraint-100>`_
+* `range_constraint_101 <../range_constraint_rules.html#range-constraint-101>`_
 * `record_type_definition_100 <../record_type_definition_rules.html#record-type-definition-100>`_
 * `record_type_definition_101 <../record_type_definition_rules.html#record-type-definition-101>`_
 * `report_statement_100 <../report_statement_rules.html#report-statement-100>`_

tests/index_subtype_definition/rule_100_test_input.fixed.vhd

@@ -0,0 +1,14 @@
+
+architecture RTL of FIFO is
+
+  -- Passing
+
+  type my_array is array (natural range <>) of std_logic_vector(7 downto 0);
+
+  -- Violation below
+
+  type my_array is array (natural range <>) of std_logic_vector(7 downto 0);
+
+begin
+
+end architecture RTL;

tests/index_subtype_definition/rule_100_test_input.vhd

@@ -0,0 +1,14 @@
+
+architecture RTL of FIFO is
+
+  -- Passing
+
+  type my_array is array (natural range <>) of std_logic_vector(7 downto 0);
+
+  -- Violation below
+
+  type my_array is array (natural        range <>) of std_logic_vector(7 downto 0);
+
+begin
+
+end architecture RTL;

tests/index_subtype_definition/rule_101_test_input.fixed.vhd

@@ -0,0 +1,14 @@
+
+architecture RTL of FIFO is
+
+  -- Passing
+
+  type my_array is array (natural range <>) of std_logic_vector(7 downto 0);
+
+  -- Violation below
+
+  type my_array is array (natural range <>) of std_logic_vector(7 downto 0);
+
+begin
+
+end architecture RTL;

tests/index_subtype_definition/rule_101_test_input.vhd

@@ -0,0 +1,14 @@
+
+architecture RTL of FIFO is
+
+  -- Passing
+
+  type my_array is array (natural range <>) of std_logic_vector(7 downto 0);
+
+  -- Violation below
+
+  type my_array is array (natural range        <>) of std_logic_vector(7 downto 0);
+
+begin
+
+end architecture RTL;

tests/index_subtype_definition/test_rule_100.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+
+from tests import utils
+from vsg import vhdlFile
+from vsg.rules import index_subtype_definition
+
+sTestDir = os.path.dirname(__file__)
+
+lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_100_test_input.vhd"))
+
+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)
+
+    def test_rule_100(self):
+        oRule = index_subtype_definition.rule_100()
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "index_subtype_definition")
+        self.assertEqual(oRule.identifier, "100")
+
+        lExpected = [10]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
+
+    def test_fix_rule_100(self):
+        oRule = index_subtype_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/index_subtype_definition/test_rule_101.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+
+from tests import utils
+from vsg import vhdlFile
+from vsg.rules import index_subtype_definition
+
+sTestDir = os.path.dirname(__file__)
+
+lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_101_test_input.vhd"))
+
+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)
+
+    def test_rule_101(self):
+        oRule = index_subtype_definition.rule_101()
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "index_subtype_definition")
+        self.assertEqual(oRule.identifier, "101")
+
+        lExpected = [10]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
+
+    def test_fix_rule_101(self):
+        oRule = index_subtype_definition.rule_101()
+
+        oRule.fix(self.oFile)
+
+        lActual = self.oFile.get_lines()
+
+        self.assertEqual(lExpected, lActual)
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(oRule.violations, [])