ATDD : ATDgen backend to generate dlang code

.circleci/setup-system

@@ -25,6 +25,10 @@ sudo apt-get install -y \
 # For JSON Schema and atdpy testing
 pip install jsonschema pytest mypy flake8
 
+# To get latest ldc version
+source $(curl https://dlang.org/install.sh | bash -s ldc -a)
+echo "source $(~/dlang/install.sh ldc -a)" >> "$BASH_ENV"
+
 ###### Sanity checks ######
 
 echo 'check opam'
@@ -56,3 +60,6 @@ node --version
 
 echo 'check npm'
 npm --version
+
+echo 'check ldc2 (dlang)'
+ldc2 --version

CHANGES.md

@@ -2,6 +2,7 @@ Unreleased
 -------------------
 
 * atdts: Stop compiler errors on generated typescript (#348)
+* atdd: Add `dlang` backend to generate D code from ATD definitions (#349)
 
 2.12.0 (2023-05-12)
 -------------------

Makefile

@@ -10,6 +10,7 @@ DUNE ?= dune
 .PHONY: all
 all:
 	$(MAKE) -C atdpy clean-for-dune
+	$(MAKE) -C atdd clean-for-dune
 	$(MAKE) -C atdts clean-for-dune
 	$(DUNE) build
 
@@ -43,12 +44,13 @@ docker-build:
 # to support all the target languages.
 .PHONY: test
 test:
-	$(MAKE) test-ts
 	$(MAKE) test-ocaml
 	$(MAKE) test-scala
 	$(MAKE) test-java
 	$(MAKE) test-python
 	$(MAKE) test-ts
+	$(MAKE) test-d
+
 
 # Test the OCaml code used by all the backends
 test-common:
@@ -86,6 +88,11 @@ test-ts:
 	$(MAKE) test-common
 	$(MAKE) -C atdts test
 
+.PHONY: test-d
+test-d:
+	$(MAKE) test-common
+	$(MAKE) -C atdd test
+
 ############################################################################
 
 .PHONY: js

README.md

@@ -13,6 +13,7 @@ Target languages currently supported:
 * Python: [atdpy](atdpy)
 * Scala: [atds](atds)
 * TypeScript: [atdts](atdts)
+* DLang: [atdd](atdd)
 
 All can installed with opam e.g.
 ```

atdd.opam

@@ -0,0 +1,84 @@
+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+synopsis: "DLang code generation for ATD APIs"
+description: "DLang code generation for ATD APIs"
+maintainer: [
+  "Louis Roché <louis@louisroche.net>"
+  "Martin Jambon <martin@mjambon.com>"
+  "Rudi Grinberg <me@rgrinberg.com>"
+]
+authors: [
+  "Martin Jambon <martin@mjambon.com>"
+  "Rudi Grinberg <rudi.grinberg@gmail.com>"
+  "Martin Jambon <martin@r2c.dev>"
+  "Martin Jambon <github@mjambon.com>"
+  "Ivan Jager <aij+git@mrph.org>"
+  "oleksiy <oleksiy.golovko@ahrefs.com>"
+  "David Sheets <sheets@alum.mit.edu>"
+  "Rudi Grinberg <me@rgrinberg.com>"
+  "Martin Jambon <martin@esper.com>"
+  "Jeff Meister <nanaki@gmail.com>"
+  "Caio Wakamatsu <caio.wakamatsu@ahrefs.com>"
+  "Carmelo Piccione <carmelo.piccione@gmail.com>"
+  "Daniel Weil <danweil68@gmail.com>"
+  "Egor Chemokhonenko <egor.chemohonenko@ahrefs.com>"
+  "Gabriel Scherer <gabriel.scherer@gmail.com>"
+  "Raman Varabets <roman.vorobets@gmail.com>"
+  "tzm <frank@boldsolutions.de>"
+  "Mathieu Baudet <mathieubaudet@fb.com>"
+  "Oleksiy Golovko <alexei.golovko@gmail.com>"
+  "Rauan Mayemir <rauan@mayemir.io>"
+  "Carmelo Piccione <cep1@solvuu.com>"
+  "John Billings <john@monkeynut.org>"
+  "Louis Roché <louis@louisroche.net>"
+  "Brendan Long <self@brendanlong.com>"
+  "Chris Yocum <cyocum@gmail.com>"
+  "Louis Roché (Ahrefs) <louis.roche@ahrefs.com>"
+  "Louis Roché <louis.roche@ahrefs.com>"
+  "Pavel Antoshkin <pavel.antoshkin@ahrefs.com>"
+  "Pierre Boutillier <pierre.boutillier@laposte.net>"
+  "Shon Feder <shon.feder@key.me>"
+  "Anurag Soni <anuragsoni.13@gmail.com>"
+  "Arjun Ravi Narayan <arjunravinarayan@gmail.com>"
+  "Asya-kawai <kawai-toshiki@aintek.xyz>"
+  "Christophe Troestler <christophe.Troestler@umons.ac.be>"
+  "Damien Doligez <ddoligez@janestreet.com>"
+  "Daniel M <dan.mntg@gmail.com>"
+  "Ding Xiang Fei <dingxiangfei2009@protonmail.ch>"
+  "François Pottier <francois.pottier@inria.fr>"
+  "Javier Chavarri <javier.chavarri@gmail.com>"
+  "Kate <kit.ty.kate@disroot.org>"
+  "Louis <louis.roche@ahrefs.com>"
+  "Louis Roché <louis@cryptosense.com>"
+  "Raman Varabets <raman+git@ahrefs.com>"
+  "Stephane Legrand <slegrand45@gmail.com>"
+  "Vincent Bernardoff <vb@luminar.eu.org>"
+  "haoyang <haoyang@esper.co>"
+  "pmundkur <prashanth.mundkur@gmail.com>"
+  "ygrek <ygrek@autistici.org>"
+]
+license: "MIT"
+homepage: "https://github.com/ahrefs/atd"
+bug-reports: "https://github.com/ahrefs/atd/issues"
+depends: [
+  "dune" {>= "2.8"}
+  "ocaml" {>= "4.08"}
+  "atd" {>= "2.11.0"}
+  "cmdliner" {>= "1.1.0"}
+  "re"
+  "odoc" {with-doc}
+]
+dev-repo: "git+https://github.com/ahrefs/atd.git"
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@doc" {with-doc}
+  ]
+]

atdd/.gitignore

@@ -0,0 +1 @@
+/bin

atdd/Makefile

@@ -0,0 +1,33 @@
+#
+# Dlang/JSON backend
+#
+
+DUNE ?= dune
+
+.PHONY: build
+build:
+	rm -f bin/atdd
+	$(MAKE) clean-for-dune
+	$(DUNE) build @all
+	mkdir -p bin
+	ln -s ../../_build/install/default/bin/atdd bin/atdd
+
+# The symlink facilitates the development of test code that depends on the
+# generated code.
+.PHONY: test
+test:
+	$(MAKE) clean-for-dune
+	$(DUNE) runtest -f; status=$$?; \
+	  ln -s ../../../_build/default/atdd/test/dlang-tests/everything.d \
+	    test/dlang-tests/everything.d && \
+	  exit "$$status"
+
+.PHONY: clean-for-dune
+clean-for-dune:
+	rm -f test/dlang-tests/everything.d
+
+.PHONY: clean
+clean:
+	$(MAKE) clean-for-dune
+	$(DUNE) clean
+	rm -rf bin

atdd/README.md

@@ -0,0 +1,47 @@
+Atdd
+==
+
+Atdd takes type definitions in the ATD format and derives `dlang`
+classes that can read and write JSON data. This saves the developer the
+labor writing boilerplate that converts between dicts and classes.
+
+This allows safe interoperability with other languages supported by
+ATD such as OCaml, Java, Python or Scala.
+
+See the sample input type definitions
+[everything.atd](test/atd-input/everything.atd) and
+the D output [everything.d](test/dlang-expected/everything.d).
+
+Requirements
+--
+
+Requirements for building and testing `atdd`:
+* Opam and dependencies installed from the [`atd` project root](..)
+  with `make setup`.
+* ldc >= 1.27.0
+
+Requirements for generating D code:
+* the `atdd` executable
+
+Requirements for compiling the generated D code:
+* ldc >= 1.27.0
+
+Documentation
+--
+
+* TODO
+
+Development notes
+--
+
+Build or rebuild with `make`. Test with `make test`. This requires
+ldc2.
+
+Running the tests is done from the `atdd/` main folder with `make
+test`.
+
+We have two kinds of tests for atdd:
+* code generation and D tests:
+  * they generate D code from ATD files and compare the D output
+    against the [expectations](dlang-expected).
+  * the generated code is executed by some tests.

atdd/src/bin/Atdd_main.ml

@@ -0,0 +1,134 @@
+(*
+   Entry point to the atdd command.
+*)
+
+open Printf
+open Cmdliner
+
+type conf = {
+  input_files: string list;
+  version: bool;
+}
+
+let run conf =
+  if conf.version then (
+    print_endline Atdd.Version.version;
+    exit 0
+  )
+  else
+    conf.input_files
+    |> List.iter (fun atd_file ->
+      Atdd.Codegen.run_file atd_file
+    )
+
+(***************************************************************************)
+(* Command-line processing *)
+(***************************************************************************)
+
+let error msg =
+  eprintf "Error: %s\n%!" msg;
+  exit 1
+
+let input_files_term =
+  let info =
+    Arg.info []  (* list must be empty for anonymous arguments *)
+      ~docv:"PATH"
+      ~doc:"Input file in the ATD format with the '.atd' extension"
+  in
+  let default = [] in
+  Arg.value (Arg.pos_all Arg.file default info)
+
+let version_term =
+  let info =
+    Arg.info ["version"]
+      ~doc:"Prints the version of atdd and exits"
+  in
+  Arg.value (Arg.flag info)
+
+let doc =
+  "Type-safe JSON serializers for D"
+
+(*
+   The structure of the help page.
+*)
+let man = [
+  (* 'NAME' and 'SYNOPSIS' sections are inserted here by cmdliner. *)
+
+  `S Manpage.s_description;  (* standard 'DESCRIPTION' section *)
+  `P "atdd turns a file containing type definitions into D classes \
+      that read, write, and validate JSON data. The generated code \
+      can be type-checked statically upon compilation to ensure user code agrees \
+      with the ATD interface.";
+
+  (* 'ARGUMENTS' and 'OPTIONS' sections are inserted here by cmdliner. *)
+
+  `S Manpage.s_examples; (* standard 'EXAMPLES' section *)
+  `P "The following is a sample ATD file. 'sample.atd' becomes 'sample.d' \
+      with the command 'atdd sample.atd'.";
+  `Pre "\
+(* Sample ATD file sample.atd *)
+
+type foo = {
+  name: string;                 (* required field *)
+  ?description: string option;  (* optional field *)
+  ~tags: string list;           (* optional with implicit default *)
+  ~price <dlang default=\"0.99\">: float;  (* explicit default *)
+  items: bar list;
+}
+
+(* sum type *)
+type bar = [
+  | Thing <json name=\"thing\"> of int
+  | Nothing <json name=\"nothing\">
+]
+";
+
+  `S Manpage.s_authors;
+  `P "Martin Jambon <martin@r2c.dev>";
+
+  `S Manpage.s_bugs;
+  `P "Report issues at https://github.com/ahrefs/atd";
+
+  `S Manpage.s_see_also;
+  `P "atdgen, atdj, atds, atdts"
+]
+
+let cmdline_term run =
+  let combine input_files version =
+    run {
+      input_files;
+      version;
+    }
+  in
+  Term.(const combine
+        $ input_files_term
+        $ version_term
+       )
+
+let parse_command_line_and_run run =
+  let info =
+    Cmd.info
+      ~doc
+      ~man
+      "atdd"
+  in
+  Cmd.v info (cmdline_term run) |> Cmd.eval |> exit
+
+let safe_run conf =
+  try run conf
+  with
+  (* for other exceptions, we show a backtrace *)
+  | Failure msg -> error msg
+  | Atd.Ast.Atd_error msg -> error msg
+  | e ->
+      let trace = Printexc.get_backtrace () in
+      eprintf "Error: exception %s\n%s%!"
+        (Printexc.to_string e)
+        trace
+
+let main () =
+  Printexc.record_backtrace true;
+  let conf = parse_command_line_and_run safe_run in
+  safe_run conf
+
+let () = main ()

atdd/src/bin/dune

@@ -0,0 +1,10 @@
+(executable
+ (name Atdd_main)
+ (public_name atdd)
+ (package atdd)
+ (libraries
+   cmdliner
+   atdd
+   atd
+ )
+)