Issue#1402: Adding rule interface_incomplete_type_declaration_500

Author: jeremiah-c-leary

docs/configuring_uppercase_and_lowercase_rules.rst

@@ -416,6 +416,8 @@ Rules Enforcing Case
 * `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>`_
+
 * `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

@@ -0,0 +1,27 @@
+.. include:: includes.rst
+
+Interface Incomplete Type Declaration Rules
+-------------------------------------------
+
+interface_incomplete_type_declaration_500
+#########################################
+
+|phase_6| |error| |case| |case_keyword|
+
+This rule checks the **type** keyword 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_keyword_rule_group.rst

@@ -105,6 +105,7 @@ Rules Enforcing Case::Keyword Rule Group
 * `index_subtype_definition_500 <../index_subtype_definition_rules.html#index-subtype-definition-500>`_
 * `instantiation_027 <../instantiation_rules.html#instantiation-027>`_
 * `instantiation_031 <../instantiation_rules.html#instantiation-031>`_
+* `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
 * `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>`_

docs/rule_groups/case_rule_group.rst

@@ -145,6 +145,7 @@ 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>`_
 * `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>`_

docs/rules.rst

@@ -55,6 +55,7 @@ The rules are divided into categories depending on the part of the VHDL code bei
    if_generate_statement_rules.rst
    index_subtype_definition_rules.rst
    instantiation_rules.rst
+   interface_incomplete_type_declaration_rules.rst
    iteration_scheme_rules.rst
    length_rules.rst
    library_rules.rst

tests/interface_incomplete_type_declaration/rule_500_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_500_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_500_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_500.py

@@ -0,0 +1,73 @@
+# -*- 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_500_test_input.vhd"))
+
+
+class test_rule(unittest.TestCase):
+    def setUp(self):
+        self.oFile = vhdlFile.vhdlFile(lFile)
+        self.assertIsNone(eError)
+
+    def test_rule_500_lower(self):
+        oRule = interface_incomplete_type_declaration.rule_500()
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "interface_incomplete_type_declaration")
+        self.assertEqual(oRule.identifier, "500")
+
+        lExpected = [5, 6, 18, 19]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(utils.extract_violation_lines_from_violation_object(oRule.violations), lExpected)
+
+    def test_rule_500_upper(self):
+        oRule = interface_incomplete_type_declaration.rule_500()
+        oRule.case = "upper"
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "interface_incomplete_type_declaration")
+        self.assertEqual(oRule.identifier, "500")
+
+        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_500_lower(self):
+        oRule = interface_incomplete_type_declaration.rule_500()
+
+        oRule.fix(self.oFile)
+
+        lActual = self.oFile.get_lines()
+
+        lExpected = []
+        lExpected.append("")
+        utils.read_file(os.path.join(sTestDir, "rule_500_test_input.fixed_lower.vhd"), lExpected)
+
+        self.assertEqual(lExpected, lActual)
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(oRule.violations, [])
+
+    def test_fix_rule_500_upper(self):
+        oRule = interface_incomplete_type_declaration.rule_500()
+        oRule.case = "upper"
+
+        oRule.fix(self.oFile)
+
+        lActual = self.oFile.get_lines()
+
+        lExpected = []
+        lExpected.append("")
+        utils.read_file(os.path.join(sTestDir, "rule_500_test_input.fixed_upper.vhd"), lExpected)
+
+        self.assertEqual(lExpected, lActual)
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(oRule.violations, [])

tests/rule_doc/test_rule_doc.py

@@ -363,6 +363,11 @@ def test_instantiation_rules_doc(self):
 
         self.assertEqual(lExpected, lActual)
 
+    def test_interface_incomplete_type_declaration_rules_doc(self):
+        lExpected, lActual = self.compare_files("interface_incomplete_type_declaration")
+
+        self.assertEqual(lExpected, lActual)
+
     def test_iteration_scheme_doc(self):
         lExpected, lActual = self.compare_files("iteration_scheme")