Swift: add doc name override

Author: redsun82

swift/codegen/generators/qlgen.py

@@ -74,23 +74,23 @@ def get_ql_property(cls: schema.Class, prop: schema.Property, prev_child: str =
             singular=inflection.camelize(prop.name),
             tablename=inflection.tableize(cls.name),
             tableparams=["this"] + ["result" if p is prop else "_" for p in cls.properties if p.is_single],
-            doc_name=_humanize(prop.name),
+            doc_name=_humanize(prop.doc_name or prop.name),
         )
     elif prop.is_repeated:
         args.update(
             singular=inflection.singularize(inflection.camelize(prop.name)),
             plural=inflection.pluralize(inflection.camelize(prop.name)),
             tablename=inflection.tableize(f"{cls.name}_{prop.name}"),
             tableparams=["this", "index", "result"],
-            doc_name=_humanize(inflection.singularize(prop.name)),
-            doc_name_plural=_humanize(inflection.pluralize(prop.name))
+            doc_name=_humanize(inflection.singularize(prop.doc_name or prop.name)),
+            doc_name_plural=_humanize(inflection.pluralize(prop.doc_name or prop.name))
         )
     elif prop.is_optional:
         args.update(
             singular=inflection.camelize(prop.name),
             tablename=inflection.tableize(f"{cls.name}_{prop.name}"),
             tableparams=["this", "result"],
-            doc_name=_humanize(prop.name),
+            doc_name=_humanize(prop.doc_name or prop.name),
         )
     elif prop.is_predicate:
         args.update(

swift/codegen/lib/schema/defs.py

@@ -1,5 +1,4 @@
-from typing import Callable as _Callable, Union as _Union
-from functools import singledispatch as _singledispatch
+from typing import Callable as _Callable
 from swift.codegen.lib import schema as _schema
 import inspect as _inspect
 from dataclasses import dataclass as _dataclass
@@ -12,6 +11,16 @@ def modify(self, prop: _schema.Property):
         prop.is_child = True
 
 
+@_dataclass
+class _DocnameModifier(_schema.PropertyModifier):
+    doc_name: str
+
+    def modify(self, prop: _schema.Property):
+        if prop.is_predicate:
+            raise _schema.Error("Predicates cannot have a doc name")
+        prop.doc_name = self.doc_name
+
+
 @_dataclass
 class _DescModifier(_schema.PropertyModifier):
     description: str
@@ -106,6 +115,7 @@ def f(cls: type) -> type:
 list = _TypeModifier(_Listifier())
 
 child = _ChildModifier()
+docname = _DocnameModifier
 desc = _DescModifier
 
 qltest = _Namespace(

swift/codegen/test/test_qlgen.py

@@ -649,5 +649,40 @@ def test_property_doc(generate_classes):
     }
 
 
+def test_property_doc_name_override(generate_classes):
+    assert generate_classes([
+        schema.Class("MyObject", properties=[
+            schema.SingleProperty("foo", "bar", doc_name="baz")]),
+    ]) == {
+        "MyObject.qll": (ql.Stub(name="MyObject", base_import=gen_import_prefix + "MyObject"),
+                         ql.Class(name="MyObject", final=True,
+                                  properties=[
+                                      ql.Property(singular="Foo", type="bar", tablename="my_objects",
+                                                  tableparams=["this", "result"], doc_name="baz"),
+                                  ])),
+    }
+
+
+def test_repeated_property_doc_name_override(generate_classes):
+    assert generate_classes([
+        schema.Class("MyObject", properties=[
+            schema.RepeatedProperty("x", "int", doc_name="children"),
+            schema.RepeatedOptionalProperty("y", "int", doc_name="child")]),
+    ]) == {
+        "MyObject.qll": (ql.Stub(name="MyObject", base_import=gen_import_prefix + "MyObject"),
+                         ql.Class(name="MyObject", final=True,
+                                  properties=[
+                                      ql.Property(singular="X", plural="Xes", type="int",
+                                                  tablename="my_object_xes",
+                                                  tableparams=["this", "index", "result"],
+                                                  doc_name="child", doc_name_plural="children"),
+                                      ql.Property(singular="Y", plural="Ys", type="int",
+                                                  tablename="my_object_ies", is_optional=True,
+                                                  tableparams=["this", "index", "result"],
+                                                  doc_name="child", doc_name_plural="children"),
+                                  ])),
+    }
+
+
 if __name__ == '__main__':
     sys.exit(pytest.main([__file__] + sys.argv[1:]))

swift/codegen/test/test_schema.py

@@ -542,5 +542,25 @@ class A:
     }
 
 
+def test_property_doc_name_override():
+    @schema.load
+    class data:
+        class A:
+            x: int | defs.docname("y")
+
+    assert data.classes == {
+        'A': schema.Class('A', properties=[
+            schema.SingleProperty('x', 'int', doc_name="y")]),
+    }
+
+
+def test_predicate_cannot_have_doc_name_override():
+    with pytest.raises(schema.Error):
+        @schema.load
+        class data:
+            class A:
+                x: defs.predicate | defs.docname("y")
+
+
 if __name__ == '__main__':
     sys.exit(pytest.main([__file__] + sys.argv[1:]))