Merge pull request #6 from samoht/rename

Rename ocaml-cram to craml

Author: samoht

README.md

@@ -1,12 +1,12 @@
-## ocaml-cram: CRAM testing framework
+## craml: A CRAM-testing framework for testing shell scripts
 
 CRAM is a is functional testing framework for command line
-applications. `ocaml-cram` is freely inspired by the [Python
+applications. `craml` is freely inspired by the [Python
 tool](https://bitheap.org/cram/), which was itself based on
 Mercurial's [unified test
 format](https://www.selenic.com/blog/?p=663).
 
-Ocaml-cram is released as a single binary (called `cram`) and
+`craml` is released as a single binary (called `craml`) and
 supports the following syntax:
 
 - Lines beginning with two spaces, a dollar sign, and a space are
@@ -30,48 +30,48 @@ supports the following syntax:
   in the middle of an output as it is not clear what should be done
   to them when the output changes.
 
-To run the tests described in a `<file>`, use `cram <file>`. This will
+To run the tests described in a `<file>`, use `craml <file>`. This will
 run all the commands in sequence and will generated `<file>.corrected`
 if one of the output do not match the expected command outputs.
 
 ### Non-deterministic Outputs
 
-Ocaml-cram supports non-deterministic outputs:
+`craml` supports non-deterministic outputs:
 
 ```
 <-- non-deterministic
   $ <command>
   <output>
 ```
 
-In that case, `cram <file>` will run the command but will not
+In that case, `craml <file>` will run the command but will not
 generate `<file>.corrected` if the new output differs from the one
-described in the file. Use `cram --non-deterministic <file>` to come
+described in the file. Use `craml --non-deterministic <file>` to come
 back to the default behaviour.
 
 ### Non-deterministic Commands
 
-Ocaml-cram supports non-deterministic outputs:
+`craml` supports non-deterministic outputs:
 
 ```
 <-- non-deterministic [skip]
   $ <command>
   <output>
 ```
 
-In that case, `cram <file>` will *not* run the command. Use `cram
+In that case, `craml <file>` will *not* run the command. Use `craml
 --non-deterministic <file>` to come back to the default behaviour.
 
 ### Exit Codes
 
-Ocaml-cram tests exit codes:
+`craml` tests exit codes:
 
 ```
   $ <command>
   <output>
 --> exit 10
 ```
 
-If `<command>` does not exit with code 10, then `cram <file>` will
+If `<command>` does not exit with code 10, then `craml <file>` will
 generate `<file>.corrected` with the right exit code. Note that `@@
 exit 0` will not be displayed.

bin/convert.ml

@@ -2,8 +2,6 @@
 
 (executable
  ((name        main)
-  (public_name cram)
+  (public_name craml)
   (modules     (main))
-  (libraries   (fmt cram unix cmdliner logs.cli logs.fmt fmt.cli fmt.tty))))
-
-(executable ((name convert) (modules convert)))
+  (libraries   (fmt craml unix cmdliner logs.cli logs.fmt fmt.cli fmt.tty))))

bin/jbuild

@@ -35,13 +35,13 @@ let ansi_color_strip str =
 
 (* http://tldp.org/LDP/abs/html/here-docs.html *)
 let use_heredoc t =
-  String.cut (List.hd t.Cram.command) ~sep:"<<" <> None
+  String.cut (List.hd t.Craml.command) ~sep:"<<" <> None
 
 let command_of_test t =
   if not (use_heredoc t) then
-    String.concat ~sep:" " t.Cram.command
+    String.concat ~sep:" " t.Craml.command
   else
-    String.concat ~sep:"\n" t.Cram.command
+    String.concat ~sep:"\n" t.Craml.command
 
 let run_test temp_file t =
   let cmd = command_of_test t in
@@ -54,36 +54,36 @@ let run_test temp_file t =
   | _ -> 255
 
 let run () non_deterministic expect_test =
-  Cram.run expect_test ~f:(fun file_contents items ->
+  Craml.run expect_test ~f:(fun file_contents items ->
       let temp_file = Filename.temp_file "cram" ".output" in
       at_exit (fun () -> Sys.remove temp_file);
       let buf = Buffer.create (String.length file_contents + 1024) in
       let ppf = Format.formatter_of_buffer buf in
       List.iter (function
-          | Cram.Line l -> Cram.pp_line ppf l
-          | Cram.Test t ->
-            match non_deterministic, t.Cram.non_deterministic with
+          | Craml.Line l -> Craml.pp_line ppf l
+          | Craml.Test t ->
+            match non_deterministic, t.Craml.non_deterministic with
             | false, `Command ->
               (* the command is non-deterministic so skip everything *)
-              List.iter (Cram.pp_line ppf) t.Cram.lines
+              List.iter (Craml.pp_line ppf) t.Craml.lines
             | false, `Output ->
               (* the command's output is non-deterministic; run it but
                  keep the old output. *)
               let _ = run_test temp_file t in
-              List.iter (Cram.pp_line ppf) t.Cram.lines
+              List.iter (Craml.pp_line ppf) t.Craml.lines
             | _ ->
               let n = run_test temp_file t in
               let lines = read_lines temp_file in
               let output =
                 let output = List.map (fun x -> `Output x) lines in
-                if Cram.equal_output output t.output then t.output else output
+                if Craml.equal_output output t.output then t.output else output
               in
-              Fmt.pf ppf "  $ %a\n" Cram.pp_command t.Cram.command;
+              Fmt.pf ppf "  $ %a\n" Craml.pp_command t.Craml.command;
               List.iter (function
                   | `Ellipsis    -> Fmt.pf ppf "  ...\n"
                   | `Output line -> Fmt.pf ppf "  %s\n" (ansi_color_strip line)
                 ) output;
-              Cram.pp_exit_code ppf n
+              Craml.pp_exit_code ppf n
         ) items;
       Format.pp_print_flush ppf ();
       Buffer.contents buf)

bin/main.ml

@@ -1,13 +1,13 @@
 opam-version: "1.2"
 maintainer: "Thomas Gazagnaire <[email protected]>"
 authors: ["Thomas Gazagnaire <[email protected]"]
-homepage: "https://github.com/realworldocaml/ocaml-cram"
+homepage: "https://github.com/realworldocaml/craml"
 license: "ISC"
-dev-repo: "https://github.com/realworldocaml/ocaml-cram.git"
-bug-reports: "https://github.com/realworldocaml/ocaml-cram/issues"
+dev-repo: "https://github.com/realworldocaml/craml.git"
+bug-reports: "https://github.com/realworldocaml/craml/issues"
 
 build: [
- ["jbuilder" "subst"] {pinned}
+ ["jbuilder" "subst" "-p" name] {pinned}
  ["jbuilder" "build" "-p" name "-j" jobs]
 ]
 build-test: ["jbuilder" "runtest" "-p" name]

cram.opam craml.opam

@@ -1,8 +1,8 @@
 (jbuild_version 1)
 
 (library
- ((name        cram)
-  (public_name cram)
+ ((name        craml)
+  (public_name craml)
   (libraries  (fmt astring logs))))
 
 (ocamllex (lexer))