Adding rule interface_incomplete_type_declaration_501.

Author: jeremiah-c-leary

docs/configuring_uppercase_and_lowercase_rules.rst

@@ -417,6 +417,7 @@ Rules Enforcing Case
 * `instantiation_500 <instantiation_rules.html#instantiation-500>`_
 
 * `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
+* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
 
 * `iteration_scheme_500 <iteration_scheme_rules.html#iteration-scheme-500>`_
 * `iteration_scheme_501 <iteration_scheme_rules.html#iteration-scheme-501>`_

docs/interface_incomplete_type_declaration_rules.rst

@@ -25,3 +25,26 @@ This rule checks the **type** keyword has proper case.
 
    generic (
      type generic_data_type
+
+interface_incomplete_type_declaration_501
+#########################################
+
+|phase_6| |error| |case| |case_name|
+
+This rule checks the type name has proper case.
+
+|configuring_uppercase_and_lowercase_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   generic (
+     type GENERIC_DATA_TYPE
+
+**Fix**
+
+.. code-block:: vhdl
+
+   generic (
+     type generic_data_type

docs/rule_groups/case_name_rule_group.rst

@@ -32,6 +32,9 @@ Rules Enforcing Case::Name Rule Group
 * `instantiation_009 <../instantiation_rules.html#instantiation-009>`_
 * `instantiation_028 <../instantiation_rules.html#instantiation-028>`_
 * `instantiation_500 <../instantiation_rules.html#instantiation-500>`_
+
+* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
+
 * `library_500 <../library_rules.html#library-500>`_
 * `package_008 <../package_rules.html#package-008>`_
 * `package_010 <../package_rules.html#package-010>`_

docs/rule_groups/case_rule_group.rst

@@ -145,7 +145,10 @@ Rules Enforcing Case Rule Group
 * `instantiation_028 <../instantiation_rules.html#instantiation-028>`_
 * `instantiation_031 <../instantiation_rules.html#instantiation-031>`_
 * `instantiation_500 <../instantiation_rules.html#instantiation-500>`_
+
 * `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
+* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
+
 * `iteration_scheme_500 <../iteration_scheme_rules.html#iteration-scheme-500>`_
 * `iteration_scheme_501 <../iteration_scheme_rules.html#iteration-scheme-501>`_
 * `library_004 <../library_rules.html#library-004>`_

tests/interface_incomplete_type_declaration/rule_501_test_input.fixed_lower.vhd

@@ -0,0 +1,36 @@
+
+entity fifo is
+  generic (
+    type generic_data_type;
+    type generic_data_type;
+    type generic_data_type
+  );
+  port (
+    data_in : generic_data_type
+  );
+end entity fifo;
+
+architecture rtl of fifo is
+
+  component buffer is
+    generic (
+      type generic_data_type;
+      type generic_data_type;
+      type generic_data_type
+    );
+    port (
+        data_in : generic_data_type
+    );
+  end component buffer;
+
+begin
+
+  buf1 : buffer
+    generic map (
+        generic_data_type => std_logic
+    )
+    port map (
+        data_in => '0'
+    );
+
+end architecture rtl;

tests/interface_incomplete_type_declaration/rule_501_test_input.fixed_upper.vhd

@@ -0,0 +1,36 @@
+
+entity fifo is
+  generic (
+    type GENERIC_DATA_TYPE;
+    type GENERIC_DATA_TYPE;
+    type GENERIC_DATA_TYPE
+  );
+  port (
+    data_in : generic_data_type
+  );
+end entity fifo;
+
+architecture rtl of fifo is
+
+  component buffer is
+    generic (
+      type GENERIC_DATA_TYPE;
+      type GENERIC_DATA_TYPE;
+      type GENERIC_DATA_TYPE
+    );
+    port (
+        data_in : generic_data_type
+    );
+  end component buffer;
+
+begin
+
+  buf1 : buffer
+    generic map (
+        generic_data_type => std_logic
+    )
+    port map (
+        data_in => '0'
+    );
+
+end architecture rtl;

tests/interface_incomplete_type_declaration/rule_501_test_input.vhd

@@ -0,0 +1,36 @@
+
+entity fifo is
+  generic (
+    type generic_data_type;
+    type Generic_Data_Type;
+    type GENERIC_DATA_TYPE
+  );
+  port (
+    data_in : generic_data_type
+  );
+end entity fifo;
+
+architecture rtl of fifo is
+
+  component buffer is
+    generic (
+      type generic_data_type;
+      type Generic_Data_Type;
+      type GENERIC_DATA_TYPE
+    );
+    port (
+        data_in : generic_data_type
+    );
+  end component buffer;
+
+begin
+
+  buf1 : buffer
+    generic map (
+        generic_data_type => std_logic
+    )
+    port map (
+        data_in => '0'
+    );
+
+end architecture rtl;

tests/interface_incomplete_type_declaration/test_rule_501.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+
+from tests import utils
+from vsg import vhdlFile
+from vsg.rules import interface_incomplete_type_declaration
+
+sTestDir = os.path.dirname(__file__)
+
+lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_501_test_input.vhd"))
+
+
+class test_rule(unittest.TestCase):
+    def setUp(self):
+        self.oFile = vhdlFile.vhdlFile(lFile)
+        self.assertIsNone(eError)
+
+    def test_rule_501_lower(self):
+        oRule = interface_incomplete_type_declaration.rule_501()
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "interface_incomplete_type_declaration")
+        self.assertEqual(oRule.identifier, "501")
+
+        lExpected = [5, 6, 18, 19]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(utils.extract_violation_lines_from_violation_object(oRule.violations), lExpected)
+
+    def test_fix_rule_501_lower(self):
+        oRule = interface_incomplete_type_declaration.rule_501()
+
+        oRule.fix(self.oFile)
+
+        lExpected = []
+        lExpected.append("")
+        utils.read_file(os.path.join(sTestDir, "rule_501_test_input.fixed_lower.vhd"), lExpected)
+
+        lActual = self.oFile.get_lines()
+
+        self.assertEqual(lExpected, lActual)
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(oRule.violations, [])
+
+    def test_rule_501_upper(self):
+        oRule = interface_incomplete_type_declaration.rule_501()
+        oRule.case = "upper"
+
+        lExpected = [4, 5, 17, 18]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(utils.extract_violation_lines_from_violation_object(oRule.violations), lExpected)
+
+    def test_fix_rule_501_upper(self):
+        oRule = interface_incomplete_type_declaration.rule_501()
+        oRule.case = "upper"
+
+        oRule.fix(self.oFile)
+
+        lExpected = []
+        lExpected.append("")
+        utils.read_file(os.path.join(sTestDir, "rule_501_test_input.fixed_upper.vhd"), lExpected)
+
+        lActual = self.oFile.get_lines()
+
+        self.assertEqual(lExpected, lActual)
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(oRule.violations, [])

vsg/rules/interface_incomplete_type_declaration/__init__.py

@@ -1,3 +1,4 @@
 # -*- coding: utf-8 -*-
 
 from .rule_500 import rule_500
+from .rule_501 import rule_501

vsg/rules/interface_incomplete_type_declaration/rule_501.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+
+from vsg import token
+from vsg.rules import token_case_with_prefix_suffix
+
+lTokens = []
+lTokens.append(token.interface_incomplete_type_declaration.identifier)
+
+
+class rule_501(token_case_with_prefix_suffix):
+    """
+    This rule checks the type name has proper case.
+
+    |configuring_uppercase_and_lowercase_rules_link|
+
+    **Violation**
+
+    .. code-block:: vhdl
+
+       generic (
+         type GENERIC_DATA_TYPE
+
+    **Fix**
+
+    .. code-block:: vhdl
+
+       generic (
+         type generic_data_type
+    """
+
+    def __init__(self):
+        super().__init__(lTokens)
+        self.groups.append("case::name")