Merge pull request #72 from hit9/D-Walther-test-fuzzy-type-match

merging #70

Author: hit9

changes.rst

@@ -5,7 +5,10 @@ Version 1.2.1 (Pending)
 
 .. _version-1.2.1:
 
+Warning: May break some existing projects's generated names:
+
 - Bugfix: `pascal_case` formatter. ISSUE #68, PR #69.
+- Bugfix: Fixed naming style of generated code such as IntegerConstant (style lookup supports inheritance). ISSUE #70 PR #70
 
 
 Version 1.2.0

compiler/bitproto/renderer/formatter.py

@@ -11,7 +11,9 @@
 from typing import (
     Callable,
     Dict,
+    Iterator,
     List,
+    Mapping,
     Optional,
     Tuple,
     Type as T,
@@ -59,8 +61,33 @@
 
 CaseStyleConverter = Callable[[str], str]
 
-# Dict[DefinitionType => One or tuple of CaseStyle name OR CaseStyleConverter]
-CaseStyleMapping = Dict[T[Definition], Union[str, Tuple[str, ...], CaseStyleConverter]]
+
+class CaseStyleMapping(Mapping):
+    """Maps DefinitionType's to one or tuple of CaseStyle-name OR CaseStyleConverter, while accounting for inheritance.
+
+    >>> CaseStyleMapping({Base: "upper"}).get(Derived, "keep") == "upper"
+    """
+
+    def __init__(
+        self,
+        entries: Dict[T[Definition], Union[str, Tuple[str, ...], CaseStyleConverter]],
+    ):
+        self._dict = entries
+
+    def __getitem__(
+        self, key: T[Definition]
+    ) -> Union[str, Tuple[str, ...], CaseStyleConverter]:
+        for t in key.mro():
+            value = self._dict.get(t, None)
+            if value is not None:
+                return value
+        raise KeyError()  # @IgnoreException
+
+    def __iter__(self) -> Iterator[T[Definition]]:
+        return self._dict.__iter__()
+
+    def __len__(self) -> int:
+        return len(self._dict)
 
 
 @unique

compiler/bitproto/renderer/impls/c/formatter.py

@@ -34,13 +34,15 @@ class CFormatter(Formatter):
 
     @override(Formatter)
     def case_style_mapping(self) -> CaseStyleMapping:
-        return {
-            Constant: "upper",
-            Alias: "pascal",
-            Enum: "pascal",
-            EnumField: ("snake", "upper"),
-            Message: "pascal",
-        }
+        return CaseStyleMapping(
+            {
+                Constant: "upper",
+                Alias: "pascal",
+                Enum: "pascal",
+                EnumField: ("snake", "upper"),
+                Message: "pascal",
+            }
+        )
 
     @override(Formatter)
     def indent_character(self) -> str:

compiler/bitproto/renderer/impls/go/formatter.py

@@ -34,13 +34,15 @@ class GoFormatter(Formatter):
 
     @override(Formatter)
     def case_style_mapping(self) -> CaseStyleMapping:
-        return {
-            Alias: "pascal",
-            Constant: "upper",
-            EnumField: ("snake", "upper"),
-            Message: "pascal",
-            MessageField: "pascal",
-        }
+        return CaseStyleMapping(
+            {
+                Alias: "pascal",
+                Constant: "upper",
+                EnumField: ("snake", "upper"),
+                Message: "pascal",
+                MessageField: "pascal",
+            }
+        )
 
     @override(Formatter)
     def indent_character(self) -> str:

compiler/bitproto/renderer/impls/py/formatter.py

@@ -28,10 +28,12 @@ class PyFormatter(Formatter):
 
     @override(Formatter)
     def case_style_mapping(self) -> CaseStyleMapping:
-        return {
-            Constant: "upper",
-            EnumField: ("snake", "upper"),
-        }
+        return CaseStyleMapping(
+            {
+                Constant: "upper",
+                EnumField: ("snake", "upper"),
+            }
+        )
 
     @override(Formatter)
     def indent_character(self) -> str:

tests/test_compiler/test_formatter.py

@@ -0,0 +1,46 @@
+from bitproto._ast import Constant, IntegerConstant, Alias, Enum, EnumField, Message
+from bitproto.renderer.formatter import CaseStyleMapping
+from bitproto.parser import parse_string
+from bitproto.renderer.impls import renderer_registry
+
+
+def test_case_style_mapping():
+    d = CaseStyleMapping(
+        {
+            Constant: "upper",
+            Alias: "pascal",
+            Enum: "pascal",
+            EnumField: ("snake", "upper"),
+            Message: "pascal",
+        }
+    )
+
+    assert d[Constant] == "upper"
+    assert d[IntegerConstant] == "upper"
+    assert d[Message] == "pascal"
+
+
+def test_issue_70():
+    proto_string = """
+    proto example
+    option c.name_prefix = "lowercase"
+    const my_const = 42;
+    """
+    proto = parse_string(proto_string)
+
+    for lang, expect in [
+        ("c", "LOWERCASEMY_CONST"),
+        ("go", "MY_CONST"),  # before this fix: my_const
+        ("py", "MY_CONST"),  # before this fix: my_const
+    ]:
+        render_class_s = renderer_registry[lang]
+
+        found = False
+        for render_class in render_class_s:
+            renderer = render_class(proto)
+            out_string = renderer.render_string()
+            if expect in out_string:
+                found = True
+                break
+
+        assert found