Merge pull request #38 from avsm/dune-port

Dune port + opam metadata 2 + mustache-unix package

.gitignore

@@ -1,4 +1,5 @@
 _build/
 TAGS
 *.install
-.merlin
+.merlin
+.*.swp

.travis.yml

@@ -7,11 +7,10 @@ script: bash -ex ./.travis-docker.sh
 env:
   global:
   - PACKAGE="mustache"
-  - PINS="mustache:."
+  - PINS="mustache-unix:. mustache:."
   matrix:
-  - DISTRO="debian-stable" OCAML_VERSION="4.02.3"
-  - DISTRO="debian-testing" OCAML_VERSION="4.03.0"
-  - DISTRO="debian-unstable" OCAML_VERSION="4.04.0"
-  - DISTRO="ubuntu-16.04" OCAML_VERSION="4.05.0"
-  - DISTRO="alpine-3.5" OCAML_VERSION="4.04.0"
-  - DISTRO="fedora-25" OCAML_VERSION="4.03.0"
+  - DISTRO="debian-stable" OCAML_VERSION="4.03"
+  - DISTRO="debian-testing" OCAML_VERSION="4.04"
+  - DISTRO="fedora" OCAML_VERSION="4.05"
+  - DISTRO="ubuntu-lts" OCAML_VERSION="4.06"
+  - DISTRO="alpine" OCAML_VERSION="4.07"

CHANGES.md

@@ -1,3 +1,11 @@
+### 3.1.0
+
+* Add a `mustache-unix` package under which `mustache-cli` is installed. (@avsm)
+* Update opam metadata to 2.0 format (@avsm)
+* Port build to Dune (@avsm)
+* Fix ocamldoc syntax to be compatible with odoc (@avsm)
+* Test OCaml 4.06 and 4.07 as well (@avsm)
+
 ### 3.0.2 (08-05-2017)
 
 * Add .descr file to repository

Makefile

@@ -1,28 +1,15 @@
-JBUILDER ?= jbuilder
-
 all:
-	@$(JBUILDER) build @install @DEFAULT
+	dune build
 
 test:
-	@$(JBUILDER) runtest
+	dune runtest
 
 check: test
 
 clean:
-	@$(JBUILDER) clean
-
-.PHONY: check test all clean
-
-REPO=../opam-repository
-PACKAGES=$(REPO)/packages
+	@dune clean
 
-pkg-%:
-	topkg opam pkg -n $*
-	mkdir -p $(PACKAGES)/$*
-	cp -r _build/$*.* $(PACKAGES)/$*/
-	rm -f $(PACKAGES)/$*/$*.opam
-	cd $(PACKAGES) && git add $*
+doc:
+	dune build @doc
 
-PKGS=$(basename $(wildcard *.opam))
-opam-pkg:
-	$(MAKE) $(PKGS:%=pkg-%)
+.PHONY: check test all clean doc

bin/dune

@@ -0,0 +1,7 @@
+(executable
+ (name mustache_cli)
+ (public_name mustache-cli)
+ (modules mustache_cli)
+ (package mustache-unix)
+ (libraries mustache ezjsonm))
+

examples/mustache_cli.ml → bin/mustache_cli.ml

@@ -20,7 +20,7 @@ let run json_filename template_filename =
   apply_mustache j t
 
 let usage () =
-  print_endline "Usage: $0 json_filename template_filename"
+  print_endline "Usage: mustache-cli json_filename template_filename"
 
 let () =
   match Sys.argv with

dune-project

@@ -0,0 +1,3 @@
+(lang dune 1.0)
+(name mustache)
+(using menhir 2.0)

examples/dune

@@ -0,0 +1,5 @@
+(executable
+ (name mustache_example)
+ (modules mustache_example)
+ (libraries mustache ezjsonm))
+

lib/dune

@@ -0,0 +1,11 @@
+(ocamllex mustache_lexer)
+
+(menhir
+ (modules mustache_parser))
+
+(library
+ (name mustache)
+ (public_name mustache)
+ (synopsis "Mustache.js templates in OCaml")
+ (libraries menhirLib)
+ (wrapped false))

lib/mustache.ml

@@ -19,7 +19,8 @@
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
    IN THE SOFTWARE. }}}*)
-open MoreLabels
+
+[@@@warning "-6"]
 include Mustache_types
 
 module List = ListLabels
@@ -272,7 +273,7 @@ module Without_locations = struct
     in
 
     let print_indent indent =
-      for i = 0 to indent - 1 do
+      for _ = 0 to indent - 1 do
         Format.pp_print_char fmt ' '
       done
     in
@@ -331,7 +332,7 @@ module Without_locations = struct
         | None, true -> raise (Missing_partial name)
         end
 
-      | Comment c -> ()
+      | Comment _c -> ()
 
       | Concat templates ->
         List.iter (fun x -> render' indent x js) templates

lib/mustache.mli

@@ -63,8 +63,8 @@ val to_string : t -> string
 
     For each partial [p], if [partials p] is [Some t] then the partial is
     substituted by [t]. Otherwise, the partial is substituted by the empty
-    string is [strict] is [false]. If [strict] is [true], the [Missing_partial
-    p] exception is raised. *)
+    string is [strict] is [false]. If [strict] is [true], the
+    {!Missing_partial} exception is raised. *)
 val render_fmt :
   ?strict:bool ->
   ?partials:(name -> t option) ->
@@ -186,8 +186,8 @@ module With_locations : sig
 
       For each partial [p], if [partials p] is [Some t] then the partial is
       substituted by [t]. Otherwise, the partial is substituted by the empty
-      string is [strict] is [false]. If [strict] is [true], the [Missing_partial
-      p] exception is raised. *)
+      string is [strict] is [false]. If [strict] is [true], the {!Missing_partial}
+      exception is raised. *)
   val render_fmt :
     ?strict:bool ->
     ?partials:(name -> t option) ->

lib/mustache_lexer.mll

@@ -22,7 +22,6 @@
 {
   open Lexing
   open Mustache_parser
-  open Mustache_types
 
   let tok_arg f lexbuf =
     let start_p = lexbuf.Lexing.lex_start_p in
@@ -106,7 +105,7 @@ and mustache = parse
        let loc_end = get_loc () in
        (tok, loc_start, loc_end)
      in
-     let rec slurp_line () =
+     let slurp_line () =
        let rec loop acc =
          let tok = get_tok () in
          match tok with
@@ -124,7 +123,7 @@ and mustache = parse
        done;
        !ret
      in
-     let rec skip_blanks l =
+     let skip_blanks l =
        let rec loop skipped = function
          | (RAW s, _, _) :: toks when is_blank s ->
            loop (skipped + String.length s) toks

lib_test/dune

@@ -0,0 +1,14 @@
+(executables
+ (names test_mustache spec_mustache)
+ (libraries mustache oUnit ezjsonm))
+
+(alias
+ (name runtest)
+ (deps test_mustache.exe ../specs/comments.json ../specs/interpolation.json
+   ../specs/partials.json ../specs/sections.json ../specs/inverted.json)
+ (action (run ./test_mustache.exe)))
+
+(alias
+ (name runtest)
+ (deps spec_mustache.exe)
+ (action (run %{deps})))

lib_test/test_mustache.ml

@@ -1,3 +1,4 @@
+[@@@warning "-6"]
 open OUnit2
 open Mustache
 

mustache-unix.opam

@@ -0,0 +1,23 @@
+opam-version: "2.0"
+maintainer: "rudi.grinberg@gmail.com"
+authors: ["Rudi Grinberg" "Armaël Guéneau"]
+license: "MIT"
+homepage: "https://github.com/rgrinberg/ocaml-mustache"
+doc: "http://rgrinberg.github.io/mustache/"
+bug-reports: "https://github.com/rgrinberg/ocaml-mustache/issues"
+depends: [
+  "ocaml" {>= "4.03"}
+  "dune" {build}
+  "base-unix"
+  "mustache"
+]
+build: [
+  ["dune" "subst"] {pinned}
+  ["dune" "build" "-p" name "-j" jobs]
+]
+dev-repo: "git+https://github.com/rgrinberg/ocaml-mustache.git"
+synopsis: "Unix utilitie for Mustache logic-less templates in OCaml"
+description: """
+Contains the `mustache-cli` command line utility for driving
+Mustache logic-less templates.
+"""

mustache.opam

@@ -1,25 +1,24 @@
-opam-version: "1.2"
+opam-version: "2.0"
 maintainer: "rudi.grinberg@gmail.com"
 authors: ["Rudi Grinberg" "Armaël Guéneau"]
 license: "MIT"
-
 homepage: "https://github.com/rgrinberg/ocaml-mustache"
+doc: "http://rgrinberg.github.io/mustache/"
 bug-reports: "https://github.com/rgrinberg/ocaml-mustache/issues"
-dev-repo: "https://github.com/rgrinberg/ocaml-mustache.git"
-doc: "http://mustache.github.io/mustache.5.html"
-
-build: [
-  ["jbuilder" "subst" "-n" name] {pinned}
-  ["jbuilder" "build" "-p" name "-j" jobs]
-]
-
-build-test: [["jbuilder" "runtest" "-p" name "-j" jobs]]
-
 depends: [
-  "jbuilder" {build}
+  "ocaml" {>= "4.03"}
+  "dune" {build}
   "menhir"
-  "ounit" {test}
-  "ezjsonm" {test}
+  "ounit" {with-test}
+  "ezjsonm" {with-test}
+]
+build: [
+  ["dune" "subst"] {pinned}
+  ["dune" "build" "-p" name "-j" jobs]
+  ["dune" "runtest" "-p" name "-j" jobs] {with-test}
 ]
-
-available: [ocaml-version >= "4.02.3"]
+dev-repo: "git+https://github.com/rgrinberg/ocaml-mustache.git"
+synopsis: "Mustache logic-less templates in OCaml"
+description: """
+Read and write mustache templates, and render them by providing a json object.
+"""