Merge pull request #1499 from JHertz5/issue-1488

Issue#1488: New rule to handle whitespace before array constraints and index constraints

Author: JHertz5

docs/array_constraint_rules.rst

@@ -3,6 +3,27 @@
 Array Constraint Rules
 ----------------------
 
+array_constraint_100
+####################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for whitespace before the opening parenthesis.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+  subtype my_array3 is my_array2       (open)(7 downto 0);
+
+**Fix**
+
+.. code-block:: vhdl
+
+  subtype my_array3 is my_array2(open)(7 downto 0);
+
 array_constraint_500
 ####################
 

docs/configuring_whitespace_rules.rst

@@ -122,6 +122,7 @@ Rules Enforcing Whitespace
 * `architecture_031 <architecture_rules.html#architecture-031>`_
 * `architecture_032 <architecture_rules.html#architecture-032>`_
 * `architecture_033 <architecture_rules.html#architecture-033>`_
+* `array_constraint_100 <array_constraint_rules.html#array-constraint-100>`_
 * `assert_100 <assert_rules.html#assert-100>`_
 * `assert_101 <assert_rules.html#assert-101>`_
 * `assert_102 <assert_rules.html#assert-102>`_
@@ -212,6 +213,7 @@ 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_constraint_100 <index_constraint_rules.html#index-constraint-100>`_
 * `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>`_

docs/index_constraint_rules.rst

@@ -0,0 +1,25 @@
+.. include:: includes.rst
+
+Index Constraint Rules
+----------------------
+
+index_constraint_100
+####################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for whitespace before the opening parenthesis.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+  subtype my_array3 is my_array2(open)         (7 downto 0);
+
+**Fix**
+
+.. code-block:: vhdl
+
+  subtype my_array3 is my_array2(open)(7 downto 0);

docs/rule_groups/whitespace_rule_group.rst

@@ -15,6 +15,7 @@ Rules Enforcing Whitespace Rule Group
 * `architecture_031 <../architecture_rules.html#architecture-031>`_
 * `architecture_032 <../architecture_rules.html#architecture-032>`_
 * `architecture_033 <../architecture_rules.html#architecture-033>`_
+* `array_constraint_100 <../array_constraint_rules.html#array-constraint-100>`_
 * `assert_100 <../assert_rules.html#assert-100>`_
 * `assert_101 <../assert_rules.html#assert-101>`_
 * `assert_102 <../assert_rules.html#assert-102>`_
@@ -106,6 +107,7 @@ 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_constraint_100 <../index_constraint_rules.html#index-constraint-100>`_
 * `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>`_
@@ -195,7 +197,6 @@ Rules Enforcing Whitespace Rule Group
 * `whitespace_005 <../whitespace_rules.html#whitespace-005>`_
 * `whitespace_006 <../whitespace_rules.html#whitespace-006>`_
 * `whitespace_007 <../whitespace_rules.html#whitespace-007>`_
-* `whitespace_008 <../whitespace_rules.html#whitespace-008>`_
 * `whitespace_010 <../whitespace_rules.html#whitespace-010>`_
 * `whitespace_011 <../whitespace_rules.html#whitespace-011>`_
 * `whitespace_013 <../whitespace_rules.html#whitespace-013>`_

docs/whitespace_rules.rst

@@ -157,23 +157,7 @@ This rule checks for spaces after a comma.
 whitespace_008
 ##############
 
-|phase_2| |error| |whitespace|
-
-This rule checks for spaces after the **std_logic_vector** keyword.
-
-**Violation**
-
-.. code-block:: vhdl
-
-   signal data    : std_logic_vector (7 downto 0);
-   signal counter : std_logic_vector    (7 downto 0);
-
-**Fix**
-
-.. code-block:: vhdl
-
-   signal data    : std_logic_vector(7 downto 0);
-   signal counter : std_logic_vector(7 downto 0);
+This rule has been deprecated and replaced with rule `index_constraint_100 <index_constraint_rules.html#index_constraint-100>`_.
 
 whitespace_010
 ##############

tests/array_constraint/rule_100_test_input.fixed.vhd

@@ -0,0 +1,10 @@
+
+architecture rtl of fifo is
+
+  subtype t_my_array is t_array(open)(t_range);
+  subtype t_my_array is t_array(open)(t_range);
+  subtype t_my_array is t_array(open)(t_range);
+
+begin
+
+end architecture rtl;

tests/array_constraint/rule_100_test_input.vhd

@@ -0,0 +1,10 @@
+
+architecture rtl of fifo is
+
+  subtype t_my_array is t_array      (open)(t_range);
+  subtype t_my_array is t_array (open)(t_range);
+  subtype t_my_array is t_array(open)(t_range);
+
+begin
+
+end architecture rtl;

tests/array_constraint/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 array_constraint
+
+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 = array_constraint.rule_100()
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "array_constraint")
+        self.assertEqual(oRule.identifier, "100")
+
+        lExpected = [4, 5]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))
+
+    def test_fix_rule_100(self):
+        oRule = array_constraint.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_constraint/__init__.py

@@ -0,0 +1,19 @@
+
+entity fifo is
+  port (
+    i_data : in  signed(15 downto 0);
+    i_data : in  signed(15 downto 0);
+    i_data : in  signed(15 downto 0)
+  );
+end entity fifo;
+
+
+architecture rtl of fifo is
+
+  subtype t_my_array is t_array(open)(t_range);
+  subtype t_my_array is t_array(open)(t_range);
+  subtype t_my_array is t_array(open)(t_range);
+
+begin
+
+end architecture rtl;