gabr 2.0.13 → 2.1.1

package/modules/bats-core/man/bats.7.ronn

@@ -1,156 +0,0 @@
-bats(7) -- Bats test file format
-================================
-
-
-DESCRIPTION
------------
-
-A Bats test file is a Bash script with special syntax for defining
-test cases. Under the hood, each test case is just a function with a
-description.
-
-    #!/usr/bin/env bats
-
-    @test "addition using bc" {
-      result="$(echo 2+2 | bc)"
-      [ "$result" -eq 4 ]
-    }
-
-    @test "addition using dc" {
-      result="$(echo 2 2+p | dc)"
-      [ "$result" -eq 4 ]
-    }
-
-
-Each Bats test file is evaluated n+1 times, where _n_ is the number of
-test cases in the file. The first run counts the number of test cases,
-then iterates over the test cases and executes each one in its own
-process.
-
-
-THE RUN HELPER
---------------
-
-Many Bats tests need to run a command and then make assertions about
-its exit status and output. Bats includes a `run` helper that invokes
-its arguments as a command, saves the exit status and output into
-special global variables, and then returns with a `0` status code so
-you can continue to make assertions in your test case.
-
-For example, let's say you're testing that the `foo` command, when
-passed a nonexistent filename, exits with a `1` status code and prints
-an error message.
-
-    @test "invoking foo with a nonexistent file prints an error" {
-      run foo nonexistent_filename
-      [ "$status" -eq 1 ]
-      [ "$output" = "foo: no such file 'nonexistent_filename'" ]
-    }
-
-The `$status` variable contains the status code of the command, and
-the `$output` variable contains the combined contents of the command's
-standard output and standard error streams.
-
-A third special variable, the `$lines` array, is available for easily
-accessing individual lines of output. For example, if you want to test
-that invoking `foo` without any arguments prints usage information on
-the first line:
-
-    @test "invoking foo without arguments prints usage" {
-      run foo
-      [ "$status" -eq 1 ]
-      [ "${lines[0]}" = "usage: foo <filename>" ]
-    }
-
-
-THE LOAD COMMAND
-----------------
-
-You may want to share common code across multiple test files. Bats
-includes a convenient `load` command for sourcing a Bash source file
-relative to the location of the current test file. For example, if you
-have a Bats test in `test/foo.bats`, the command
-
-    load test_helper
-
-will source the script `test/test_helper.bash` in your test file. This
-can be useful for sharing functions to set up your environment or load
-fixtures.
-
-
-THE SKIP COMMAND
-----------------
-
-Tests can be skipped by using the `skip` command at the point in a
-test you wish to skip.
-
-    @test "A test I don't want to execute for now" {
-      skip
-      run foo
-      [ "$status" -eq 0 ]
-    }
-
-Optionally, you may include a reason for skipping:
-
-    @test "A test I don't want to execute for now" {
-      skip "This command will return zero soon, but not now"
-      run foo
-      [ "$status" -eq 0 ]
-    }
-
-Or you can skip conditionally:
-
-    @test "A test which should run" {
-      if [ foo != bar ]; then
-        skip "foo isn't bar"
-      fi
-
-      run foo
-      [ "$status" -eq 0 ]
-    }
-
-
-SETUP AND TEARDOWN FUNCTIONS
-----------------------------
-
-You can define special `setup` and `teardown` functions which run
-before and after each test case, respectively. Use these to load
-fixtures, set up your environment, and clean up when you're done.
-
-
-CODE OUTSIDE OF TEST CASES
---------------------------
-
-You can include code in your test file outside of `@test` functions.
-For example, this may be useful if you want to check for dependencies
-and fail immediately if they're not present. However, any output that
-you print in code outside of `@test`, `setup` or `teardown` functions
-must be redirected to `stderr` (`>&2`). Otherwise, the output may
-cause Bats to fail by polluting the TAP stream on `stdout`.
-
-
-SPECIAL VARIABLES
------------------
-
-There are several global variables you can use to introspect on Bats
-tests:
-
-* `$BATS_TEST_FILENAME` is the fully expanded path to the Bats test
-file.
-* `$BATS_TEST_DIRNAME` is the directory in which the Bats test file is
-located.
-* `$BATS_TEST_NAMES` is an array of function names for each test case.
-* `$BATS_TEST_NAME` is the name of the function containing the current
-test case.
-* `$BATS_TEST_DESCRIPTION` is the description of the current test
-case.
-* `$BATS_TEST_NUMBER` is the (1-based) index of the current test case
-in the test file.
-* `$BATS_TMPDIR` is the location to a directory that may be used to
-store temporary files.
-
-
-SEE ALSO
---------
-
-`bash`(1), `bats`(1)

package/modules/shdoc/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017 Stanislav Seletskiy
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-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.

package/modules/shdoc/README.md

@@ -1,93 +0,0 @@
-# shdoc
-
-Converts comments to function to reference markdown documentation.
-
-# Usage
-
-## Global Script tags
-
-shdoc will match comments in the following form on top of a script file:
-```sh
-#!/bin/bash
-#
-# @file Title of file script
-# @brief Small description of the script.
-```
-
-Will produce following output:
-
-# Title of file script
-
-Small description of the script.
-
-## Function tags
-
-shdoc will match comments in the following form before function definitions:
-
-```sh
-# @description Multiline description goes here and
-# there
-#
-# @example
-#   some:other:func a b c
-#   echo 123
-#
-# @arg $1 string Some arg.
-# @arg $@ any Rest of arguments.
-#
-# @noargs
-#
-# @exitcode 0  If successfull.
-# @exitcode >0 On failure
-# @exitcode 5  On some error.
-#
-# @stdout Path to something.
-#
-# @see some:other:func()
-some:first:func() {
-```
-
-`shdoc.awk` has no args and expects shell script with comments as described
-above on the stdin and will markdown output result on the stdout.
-
-Will produce following output:
-
-## some:first:func()
-
-Multiline description goes here and
-there
-
-#### Example
-
-```bash
-some:other:func a b c
-echo 123
-```
-
-### Arguments
-
-* **$1** (string): Some arg.
-* **...** (any): Rest of arguments.
-
-_Function has no arguments._
-
-### Exit codes
-
-* **0**:  If successfull.
-* >**0**: On failure
-* **5**:  On some error.
-
-### Output on stdout
-
-* Path to something.
-
-#### See also
-
-* [some:other:func()](#some:other:func())
-
-# Examples
-
-See example documentation on:
-
-* [tests.sh](https://github.com/reconquest/tests.sh/blob/master/REFERENCE.md)
-* [coproc.bash](https://github.com/reconquest/coproc.bash/blob/master/REFERENCE.md)

package/modules/shdoc/shdoc

@@ -1,174 +0,0 @@
-#!/usr/bin/awk -f
-
-BEGIN {
-    if (! style) {
-        style = "github"
-    }
-
-    styles["github", "h1", "from"] = ".*"
-    styles["github", "h1", "to"] = "# &"
-
-    styles["github", "h2", "from"] = ".*"
-    styles["github", "h2", "to"] = "## &"
-
-    styles["github", "h3", "from"] = ".*"
-    styles["github", "h3", "to"] = "### &"
-
-    styles["github", "code", "from"] = ".*"
-    styles["github", "code", "to"] = "```&"
-
-    styles["github", "/code", "to"] = "```"
-
-    styles["github", "argN", "from"] = "^(\\$[0-9]) (\\S+)"
-    styles["github", "argN", "to"] = "**\\1** (\\2):"
-
-    styles["github", "arg@", "from"] = "^\\$@ (\\S+)"
-    styles["github", "arg@", "to"] = "**...** (\\1):"
-
-    styles["github", "li", "from"] = ".*"
-    styles["github", "li", "to"] = "* &"
-
-    styles["github", "i", "from"] = ".*"
-    styles["github", "i", "to"] = "_&_"
-
-    styles["github", "anchor", "from"] = ".*"
-    styles["github", "anchor", "to"] = "[&](#&)"
-
-    styles["github", "exitcode", "from"] = "([>!]?[0-9]{1,3}) (.*)"
-    styles["github", "exitcode", "to"] = "**\\1**: \\2"
-}
-
-function render(type, text) {
-    return gensub( \
-        styles[style, type, "from"],
-        styles[style, type, "to"],
-        "g",
-        text \
-    )
-}
-
-/^[[:space:]]*# @file/ {
-    sub(/^[[:space:]]*# @file /, "")
-    filedoc = render("h1", $1) "\n"
-}
-
-/^[[:space:]]*# @brief/ {
-    sub(/^[[:space:]]*# @brief /, "")
-    filedoc = filedoc "\n" $0
-}
-
-/^[[:space:]]*# @description/ {
-    in_description = 1
-    in_example = 0
-
-    has_example = 0
-    has_args = 0
-    has_exitcode = 0
-    has_stdout = 0
-
-    docblock = ""
-}
-
-in_description {
-    if (/^[^[[:space:]]*#]|^[[:space:]]*# @[^d]/) {
-        in_description = 0
-    } else {
-        sub(/^[[:space:]]*# @description /, "")
-        sub(/^[[:space:]]*# /, "")
-        sub(/^[[:space:]]*#$/, "")
-
-        docblock = docblock "\n" $0
-    }
-}
-
-in_example {
-    if (! /^[[:space:]]*#[ ]{3}/) {
-        in_example = 0
-
-        docblock = docblock "\n" render("/code") "\n"
-    } else {
-        sub(/^[[:space:]]*#[ ]{3}/, "")
-
-        docblock = docblock "\n" $0
-    }
-}
-
-/^[[:space:]]*# @example/ {
-    in_example = 1
-
-    docblock = docblock "\n" render("h3", "Example")
-    docblock = docblock "\n\n" render("code", "bash")
-}
-
-/^[[:space:]]*# @arg/ {
-    if (!has_args) {
-        has_args = 1
-
-        docblock = docblock "\n" render("h3", "Arguments") "\n\n"
-    }
-
-    sub(/^[[:space:]]*# @arg /, "")
-
-    $0 = render("argN", $0)
-    $0 = render("arg@", $0)
-
-    docblock = docblock render("li", $0) "\n"
-}
-
-/^[[:space:]]*# @noargs/ {
-    docblock = docblock "\n" render("i", "Function has no arguments.") "\n"
-}
-
-/^[[:space:]]*# @exitcode/ {
-    if (!has_exitcode) {
-        has_exitcode = 1
-
-        docblock = docblock "\n" render("h3", "Exit codes") "\n\n"
-    }
-
-    sub(/^[[:space:]]*# @exitcode /, "")
-
-    $0 = render("exitcode", $0)
-
-    docblock = docblock render("li", $0) "\n"
-}
-
-/^[[:space:]]*# @see/ {
-    sub(/[[:space:]]*# @see /, "")
-
-    $0 = render("anchor", $0)
-    $0 = render("li", $0)
-
-    docblock = docblock "\n" render("h4", "See also") "\n\n" $0 "\n"
-}
-
-/^[[:space:]]*# @stdout/ {
-    has_stdout = 1
-
-    sub(/^[[:space:]]*# @stdout /, "")
-
-    docblock = docblock "\n" render("h3", "Output on stdout")
-    docblock = docblock "\n\n" render("li", $0) "\n"
-}
-
-/^[[:space:]]*(function )?[[:space:]]*([a-zA-Z0-9_:.-]+)(\(\))? \{/ && docblock != "" {
-    sub(/^[[:space:]]*function /, "")
-
-    doc = doc "\n" render("h2", $1) "\n" docblock
-
-    url = $1
-    gsub(/\W/, "", url)
-
-    toc = toc "\n" "* [" $1 "](#" url ")"
-
-    docblock = ""
-}
-
-END {
-    if (filedoc != "") {
-        print filedoc
-    }
-    print toc
-    print ""
-    print doc
-}