Update links in API document

Author: pyrmont

api.md

@@ -1,6 +1,5 @@
 # testament API
 
-
 [==](#), [assert-deep-equal](#assert-deep-equal), [assert-equal](#assert-equal), [assert-equivalent](#assert-equivalent), [assert-expr](#assert-expr), [assert-matches](#assert-matches), [assert-thrown](#assert-thrown), [assert-thrown-message](#assert-thrown-message), [deftest](#deftest), [each-is](#each-is), [exercise!](#exercise), [is](#is), [reset-all!](#reset-all), [reset-tests!](#reset-tests), [review](#review), [run-tests!](#run-tests), [set-on-result-hook](#set-on-result-hook), [set-report-printer](#set-report-printer), [set-results-printer](#set-results-printer)
 
 ## ==
@@ -23,6 +22,7 @@ function.
 
 [1]: lib/testament.janet#L62
 
+
 ## assert-deep-equal
 
 **macro**  | [source][2]
@@ -41,7 +41,8 @@ An optional `note` can be included that will be used in any failure result to
 identify the assertion. If no `note` is provided, the form
 `(deep= expect actual)` is used.
 
-[2]: lib/testament.janet#L460
+[2]: lib/testament.janet#L693
+
 
 ## assert-equal
 
@@ -61,7 +62,8 @@ An optional `note` can be included that will be used in any failure result to
 identify the assertion. If no `note` is provided, the form `(= expect actual)`
 is used.
 
-[3]: lib/testament.janet#L444
+[3]: lib/testament.janet#L677
+
 
 ## assert-equivalent
 
@@ -84,7 +86,8 @@ An optional `note` can be included that will be used in any failure result to
 identify the assertion. If no `note` is provided, the form `(== expect actual)`
 is used.
 
-[4]: lib/testament.janet#L476
+[4]: lib/testament.janet#L709
+
 
 ## assert-expr
 
@@ -101,7 +104,8 @@ The `assert-expr` macro provides a mechanism for creating a generic assertion.
 An optional `note` can be included that will be used in any failure result to
 identify the assertion. If no `note` is provided, the form of `expr` is used.
 
-[5]: lib/testament.janet#L431
+[5]: lib/testament.janet#L664
+
 
 ## assert-matches
 
@@ -120,7 +124,8 @@ An optional `note` can be included that will be used in any failure result to
 identify the assertion. If no `note` is provided, the form
 `(matches structure actual)` is used.
 
-[6]: lib/testament.janet#L495
+[6]: lib/testament.janet#L728
+
 
 ## assert-thrown
 
@@ -139,7 +144,8 @@ An optional `note` can be included that will be used in any failure result to
 identify the assertion. If no `note` is provided, the form `thrown? expr` is
 used.
 
-[7]: lib/testament.janet#L510
+[7]: lib/testament.janet#L743
+
 
 ## assert-thrown-message
 
@@ -159,7 +165,8 @@ An optional `note` can be included that will be used in any failure result to
 identify the assertion. If no `note` is provided, the form
 `thrown? expect expr` is used.
 
-[8]: lib/testament.janet#L526
+[8]: lib/testament.janet#L759
+
 
 ## deftest
 
@@ -196,7 +203,8 @@ test is called is not guaranteed.
 If `deftest` is called with no arguments or if the only argument is a symbol,
 an arity error is raised.
 
-[9]: lib/testament.janet#L657
+[9]: lib/testament.janet#L890
+
 
 ## each-is
 
@@ -210,7 +218,8 @@ Asserts that each element in `assertions` is true (with an optional `note`)
 
 This effectively calls `is` on each element in `assertions` using the optional note.
 
-[10]: lib/testament.janet#L607
+[10]: lib/testament.janet#L840
+
 
 ## exercise!
 
@@ -232,7 +241,8 @@ tuple.
 Please note that, like `run-tests!`, `exercise!` calls `os/exit` when there
 are failing tests unless the argument `:no-exit?` is set to `true`.
 
-[11]: lib/testament.janet#L775
+[11]: lib/testament.janet#L1008
+
 
 ## is
 
@@ -266,7 +276,8 @@ asserted expression.
 An optional `note` can be included that will be used in any failure result to
 identify the assertion.
 
-[12]: lib/testament.janet#L546
+[12]: lib/testament.janet#L779
+
 
 ## reset-all!
 
@@ -278,7 +289,8 @@ identify the assertion.
 
 Resets all reporting variables and settings
 
-[13]: lib/testament.janet#L643
+[13]: lib/testament.janet#L876
+
 
 ## reset-tests!
 
@@ -290,7 +302,8 @@ Resets all reporting variables and settings
 
 Resets all reporting variables
 
-[14]: lib/testament.janet#L629
+[14]: lib/testament.janet#L862
+
 
 ## review
 
@@ -307,7 +320,8 @@ the bindings as public. This is intended for situations where it is not
 desirable to make bindings public but the user would still like to be able to
 subject the bindings to testing.
 
-[15]: lib/testament.janet#L821
+[15]: lib/testament.janet#L1054
+
 
 ## run-tests!
 
@@ -348,7 +362,8 @@ Finally, if the dynamic binding `:testament/repl?` is set to `true`, this
 will also reset the test reports and empty the module/cache to provide a
 fresh run with the most up-to-date code.
 
-[16]: lib/testament.janet#L712
+[16]: lib/testament.janet#L945
+
 
 ## set-on-result-hook
 
@@ -380,7 +395,8 @@ The 'value' of the assertion depends on the kind of assertion:
 - `:thrown` either `true` or `false`; and
 - `:thrown-message` the error specified in the assertion.
 
-[17]: lib/testament.janet#L211
+[17]: lib/testament.janet#L444
+
 
 ## set-report-printer
 
@@ -404,6 +420,7 @@ to `true`.
 
 [18]: lib/testament.janet#L80
 
+
 ## set-results-printer
 
 **function**  | [source][19]

bundle.janet

@@ -1,16 +1,109 @@
+(def- seps {:windows "\\" :mingw "\\" :cygwin "\\"})
+(def- s (get seps (os/which) "/"))
+
+# used for splitting POSIX paths
+(def- posix-pathg ~{:main     (* (+ :abspath :relpath) (? :sep) -1)
+                    :abspath  (* :root (any :relpath))
+                    :relpath  (* :part (any (* :sep :part)))
+                    :root     (* "/" (constant ""))
+                    :sep      (some "/")
+                    :part     '(some (* (! :sep) 1))})
+
+# based on code from spork/declare-cc.janet
+(defn- add-bat-shim [manifest bin-name &opt chmod-mode]
+  (def binpath (string (dyn :syspath) s "bin"))
+  (def bin-dest (string binpath s bin-name))
+  (assert (= :file (os/stat bin-dest :mode)) "must call bundle/add-bin first")
+  (def bat-name (string bin-name ".bat"))
+  (def files (get manifest :files)) # guaranteed to be non-nil
+  (def dest (string binpath s bat-name))
+  (when (os/stat dest :mode)
+    (errorf "collision at %s, file already exists" dest))
+  (def bat (string "@echo off\r\n"
+                   "goto #_undefined_# 2>NUL || title %COMSPEC% & janet \""
+                   bin-dest
+                   "\" %*"))
+  (spit dest bat)
+  (def absdest (os/realpath dest))
+  (array/push files absdest)
+  (when chmod-mode
+    (os/chmod absdest chmod-mode))
+  (print "add " absdest))
+
+(defn- split-posix-path [path]
+  (peg/match posix-pathg path))
+
+(defn- add-path [paths dest &opt src]
+  (def bits (split-posix-path dest))
+  (assert bits "invalid path")
+  (def ks @[])
+  (each b bits
+    (array/push ks b)
+    (unless (get-in paths ks)
+      (put-in paths ks @{})))
+  (when src
+    (put-in paths ks (-> (split-posix-path src)
+                         (string/join s)))))
+
+(defn- install-libs [manifest &]
+  (def to-make @{})
+  (def libs (get-in manifest [:info :artifacts :libraries] []))
+  (each lib libs
+    (def ks @[])
+    (def prefix (get lib :prefix))
+    (when prefix (add-path to-make prefix))
+    (def paths (get lib :paths))
+    (each p paths
+      # use POSIX path separator to match info file
+      (add-path to-make (string (when prefix (string prefix "/")) p) p)))
+  (defn add-tree [tree path]
+    (eachp [k v] tree
+      (if (table? v)
+        (do
+          (def new-path (if (empty? path) k (string path s k)))
+          (bundle/add-directory manifest new-path)
+          (add-tree v new-path))
+        (bundle/add manifest v (string path s k)))))
+  (add-tree to-make ""))
+
+(defn- install-mans [manifest &]
+  (def mans (get-in manifest [:info :artifacts :manpages] []))
+  (each m mans
+    (def bits (split-posix-path m))
+    (var dir (dyn :syspath))
+    (each b (array/slice bits 0 -2)
+      (set dir (string dir s b))
+      (os/mkdir dir))
+    (bundle/add-file manifest (string/join bits s))))
+
+(defn- install-scrs [manifest &]
+  (def scrs (get-in manifest [:info :artifacts :scripts] []))
+  (each scr scrs
+    (def path (-> (get scr :path)
+                  (split-posix-path)
+                  (string/join s)))
+    (bundle/add-bin manifest path)
+    (when (= "\\" s)
+      (def bin-name (last (string/split s path)))
+      (add-bat-shim manifest bin-name))))
+
+(defn- set-version [manifest]
+  (def bundle-ver (get-in manifest [:info :version]))
+  (if (not= "DEVEL" bundle-ver)
+    (put manifest :version bundle-ver)
+    (do
+      (def src (get manifest :local-source))
+      (def [r w] (os/pipe))
+      (def [ok? res] (protect (os/execute ["git" "-C" src "describe" "--always" "--dirty"] :px {:out w :err w})))
+      (:close w)
+      (put manifest
+           :version
+           (if ok?
+             (string bundle-ver "-" (string/trim (ev/read r :all)))
+             bundle-ver)))))
+
 (defn install [manifest &]
-  (def seps {:windows "\\" :mingw "\\" :cygwin "\\"})
-  (def s (get seps (os/which) "/"))
-  (def manpages (get-in manifest [:info :manpage] []))
-  (os/mkdir (string (dyn :syspath) s "man"))
-  (os/mkdir (string (dyn :syspath) s "man" s "man1"))
-  (each mp manpages
-    (bundle/add-file manifest mp))
-  (def prefix (get-in manifest [:info :source :prefix]))
-  (def srcs (get-in manifest [:info :source :files] []))
-  (bundle/add-directory manifest prefix)
-  (each src srcs
-    (bundle/add manifest src (string prefix s src)))
-  (def bins (get-in manifest [:info :executable] []))
-  (each bin bins
-    (bundle/add-bin manifest bin)))
+  (install-libs manifest)
+  (install-mans manifest)
+  (install-scrs manifest)
+  (set-version manifest))

info.jdn

@@ -6,5 +6,6 @@
  :url "https://github.com/pyrmont/testament"
  :repo "git+https://github.com/pyrmont/testament"
 
- :source {:prefix "testament"
-          :files ["lib" "init.janet"]}}
+ :artifacts {:libraries [{:prefix "testament"
+                          :paths ["lib"
+                                  "init.janet"]}]}}