feat: melange-decoders

actionshrimp · actionshrimp · commit 3157a3a6075c · 2023-10-04T13:37:39.000+01:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -72,3 +72,40 @@ jobs:
       - run: npm ci
       - run: npm run build
       - run: npm test
+
+  build-melange:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        ocaml-compiler:
+          - 4.14.x
+        package:
+          - melange-decoders
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'npm'
+
+      - run: npm ci
+
+      - name: Use OCaml ${{ matrix.ocaml-compiler }}
+        uses: ocaml/setup-ocaml@v2
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+          opam-depext-flags: --with-test
+          opam-local-packages: |
+            decoders.opam
+            ${{ matrix.package }}.opam
+
+      - run: opam install "${{ matrix.package }}" --with-test
+      - run: opam exec -- dune build @melange
+      - run: npx jest
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 .PHONY: all
-all: build test build-bs test-bs
+all: build test build-bs test-bs test-mel
 
 .PHONY: clean-all
 clean-all: clean clean-bs
@@ -34,7 +34,7 @@ clean:
 
 _opam:
 	opam switch create . --empty
-	opam install -y ocaml-base-compiler.4.12.0 utop ocaml-lsp-server
+	opam switch set-invariant ocaml-base-compiler.4.14.1
 
 install-dependencies: _opam
 	opam install . --deps-only --with-test
@@ -61,11 +61,11 @@ build-bs:
 test-bs:
 	npm test
 
-watch-build-bs:
-	npm run build-watch
-
-watch-test-bs:
-	npm run test-watch
-
 clean-bs:
 	npm run clean
+
+build-mel:
+	dune build @melange
+
+test-mel:
+	npx jest _build/default/out/
diff --git a/__tests__/decoders_js_json_test.ml b/__tests__/decoders_js_json_test.ml
@@ -1,5 +1,5 @@
 open Jest
-open Bs_json
+open Js_json
 
 external parse_int : string -> int = "parseInt" [@@bs.scope "window"] [@@bs.val]
 
diff --git a/__tests__/decoders_js_xml_test.ml b/__tests__/decoders_js_xml_test.ml
@@ -1,5 +1,5 @@
 open Jest
-open Bs_xml
+open Js_xml
 
 let () =
   describe
diff --git a/__tests__/dune b/__tests__/dune
@@ -0,0 +1,11 @@
+(subdir
+  melange
+ (library
+ (name decoders_tests_melange)
+ (modes melange)
+ (libraries decoders_mel melange-jest.jest)
+ (preprocess (pps melange.ppx))
+ (flags -open Decoders_mel)
+ (wrapped false))
+ (copy_files# "../*.ml")
+ (copy_files# "../*.re"))
diff --git a/bsconfig.json b/bsconfig.json
@@ -18,7 +18,10 @@
       "xml.ml"
     ]
   }, {
-    "dir" : "src-bs"
+    "dir" : "src-js",
+    "files": {
+        "excludes": ["decoders_mel.ml"]
+    }
   }, {
     "dir": "__tests__",
     "type": "dev"
diff --git a/decoders-bencode.opam b/decoders-bencode.opam
@@ -10,7 +10,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "decoders" {= version}
   "bencode" {>= "2.0"}
diff --git a/decoders-cbor.opam b/decoders-cbor.opam
@@ -10,7 +10,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "decoders" {= version}
   "cbor"
diff --git a/decoders-ezjsonm.opam b/decoders-ezjsonm.opam
@@ -10,7 +10,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "decoders" {= version}
   "ezjsonm" {>= "0.4.0"}
diff --git a/decoders-ezxmlm.opam b/decoders-ezxmlm.opam
@@ -10,7 +10,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "decoders" {= version}
   "ezxmlm" {>= "1.1.0"}
diff --git a/decoders-jsonaf.opam b/decoders-jsonaf.opam
@@ -12,7 +12,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.10.0"}
   "decoders" {= version}
   "jsonaf" {>= "0.15.0"}
diff --git a/decoders-jsonm.opam b/decoders-jsonm.opam
@@ -10,7 +10,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "decoders" {= version}
   "jsonm"
diff --git a/decoders-msgpck.opam b/decoders-msgpck.opam
@@ -12,7 +12,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "decoders" {= version}
   "msgpck" {>= "1.3"}
diff --git a/decoders-sexplib.opam b/decoders-sexplib.opam
@@ -10,7 +10,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "decoders" {= version}
   "sexplib0"
diff --git a/decoders-yojson.opam b/decoders-yojson.opam
@@ -10,7 +10,7 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "decoders" {= version}
   "yojson" {>= "1.6.0"}
diff --git a/decoders.opam b/decoders.opam
@@ -10,9 +10,10 @@ homepage: "https://github.com/mattjbray/ocaml-decoders"
 doc: "https://mattjbray.github.io/ocaml-decoders/"
 bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
 depends: [
-  "dune" {>= "3.1"}
+  "dune" {>= "3.8"}
   "ocaml" {>= "4.03.0"}
   "odoc" {with-doc}
+  "melange"
   "containers" {with-test & >= "0.16"}
 ]
 build: [
diff --git a/dune b/dune
@@ -1 +1,6 @@
-(dirs :standard \ node_modules)
+(dirs :standard __tests__ \ node_modules)
+
+(melange.emit
+ (target out)
+ (preprocess (pps melange.ppx))
+ (libraries decoders_mel decoders_tests_melange))
diff --git a/dune-project b/dune-project
@@ -1,4 +1,5 @@
-(lang dune 3.1)
+(lang dune 3.8)
+(using melange 0.1)
 (name decoders)
 (generate_opam_files true)
 (license ISC)
@@ -135,4 +136,21 @@
  (depends
   (ocaml (>= 4.03.0))
   (odoc :with-doc)
+   melange
   (containers (and :with-test (>= 0.16)))))
+
+;; melange lib convention is to put `melange-` as the prefix, rather than the
+;; suffix, which unfortunately contradicts the `decoders-` prefix convention
+(package
+ (name melange-decoders)
+ (synopsis "Melange backend for decoders")
+ (description
+   "A combinator library for \"decoding\" JSON-like values into your own Ocaml types, inspired by Elm's `Json.Decode` and `Json.Encode`.")
+ (depends
+  (ocaml (>= 4.14.1))
+  (odoc :with-doc)
+  (decoders (= :version))
+   melange
+  (melange-fetch :with-test)
+  (melange-jest :with-test)
+  (melange-webapi :with-test)))
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -0,0 +1,11 @@
+{
+  inputs = {
+    nixpkgs.url = "nixpkgs/nixos-22.11";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }@attrs:
+    flake-utils.lib.eachDefaultSystem (system:
+      let pkgs = nixpkgs.legacyPackages.${system};
+      in { devShells.default = import ./shell.nix { inherit pkgs; }; });
+}
diff --git a/melange-decoders.opam b/melange-decoders.opam
@@ -0,0 +1,50 @@
+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+synopsis: "Melange backend for decoders"
+description:
+  "A combinator library for \"decoding\" JSON-like values into your own Ocaml types, inspired by Elm's `Json.Decode` and `Json.Encode`."
+maintainer: ["Matt Bray <mattjbray@gmail.com>"]
+authors: ["Matt Bray <mattjbray@gmail.com>"]
+license: "ISC"
+homepage: "https://github.com/mattjbray/ocaml-decoders"
+doc: "https://mattjbray.github.io/ocaml-decoders/"
+bug-reports: "https://github.com/mattjbray/ocaml-decoders/issues"
+depends: [
+  "dune" {>= "3.8"}
+  "ocaml" {>= "4.14.1"}
+  "odoc" {with-doc}
+  "decoders" {= version}
+  "melange"
+  "melange-fetch" {with-test}
+  "melange-jest" {with-test}
+  "melange-webapi" {with-test}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+]
+dev-repo: "git+https://github.com/mattjbray/ocaml-decoders.git"
+pin-depends: [
+  [
+    "melange-fetch.dev"
+    "git+https://github.com/melange-community/melange-fetch.git#d2183ec245cbf5c7a8f99f8c41d2de0758c8cda7"
+  ]
+  [
+    "melange-jest.~dev"
+    "git+https://github.com/melange-community/melange-jest.git#9cd5449738ab6387880ad0ec7a31b78e08f4476d"
+  ]
+  [
+    "melange-webapi.~dev"
+    "git+https://github.com/melange-community/melange-webapi.git#6052d83efa2f29a295d83fb93a6121a232701033"
+  ]
+]
diff --git a/melange-decoders.opam.template b/melange-decoders.opam.template
@@ -0,0 +1,14 @@
+pin-depends: [
+  [
+    "melange-fetch.dev"
+    "git+https://github.com/melange-community/melange-fetch.git#d2183ec245cbf5c7a8f99f8c41d2de0758c8cda7"
+  ]
+  [
+    "melange-jest.~dev"
+    "git+https://github.com/melange-community/melange-jest.git#9cd5449738ab6387880ad0ec7a31b78e08f4476d"
+  ]
+  [
+    "melange-webapi.~dev"
+    "git+https://github.com/melange-community/melange-webapi.git#6052d83efa2f29a295d83fb93a6121a232701033"
+  ]
+]
diff --git a/package.json b/package.json
@@ -10,7 +10,6 @@
     "build": "bsb -make-world",
     "build-watch": "bsb -make-world -w",
     "test": "bsb -make-world && jest",
-    "test-watch": "jest --watch",
     "clean": "bsb -clean-world"
   },
   "repository": {
diff --git a/shell.nix b/shell.nix
diff --git a/src-js/dune b/src-js/dune
diff --git a/src-js/js_json.ml b/src-js/js_json.ml
diff --git a/src-js/js_json.mli b/src-js/js_json.mli
diff --git a/src-js/js_xml.ml b/src-js/js_xml.ml
diff --git a/src-js/js_xml.mli b/src-js/js_xml.mli
diff --git a/src-js/shims_let_ops_.ml b/src-js/shims_let_ops_.ml
diff --git a/src-js/util.ml b/src-js/util.ml
diff --git a/src-js/util.mli b/src-js/util.mli
diff --git a/src/dune b/src/dune
