Merge pull request #50 from amireh/3.0

3.0

Author: amireh

.busted

@@ -0,0 +1,11 @@
+return {
+  _all = {
+    coverage = false
+  },
+  default = {
+    coverage = false,
+    verbose = true,
+    ROOT = {"spec"},
+    lpath = "src/?.lua;src/cliargs/?.lua;spec/?.lua;"
+  }
+}

.env

@@ -1,3 +1,4 @@
 GITHUB_USER="amireh"
 GITHUB_REPO="lua_cliargs"
-GITHUB_TOKEN=
+GITHUB_TOKEN=
+LUAROCKS_API_KEY=

.gitignore

@@ -2,4 +2,7 @@
 /luacov.stats.out
 /.env.local
 /*.rock
-**/.*.swp
+.swp
+/.luacheckcache
+/doc/compiled
+/doc/node_modules

.luacheckrc

@@ -0,0 +1,6 @@
+std = "min"
+cache = false
+
+files["spec"] = {
+  std = "+busted"
+}

.travis.yml

@@ -14,5 +14,8 @@ install:
   - sudo apt-get install luajit
   - sudo apt-get install luarocks
   - sudo luarocks install busted 2.0rc10-1
+  - sudo luarocks install dkjson
+  - sudo luarocks install yaml
+  - sudo luarocks install inifile
 
 script: "busted spec"

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Ahmad Amireh
+Copyright (c) 2012-2015 Ahmad Amireh
 
 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:
 

README.md

@@ -1,38 +1,32 @@
-# cliargs
+# lua_cliargs
 
 [![travis-ci status](https://secure.travis-ci.org/amireh/lua_cliargs.png)](http://travis-ci.org/#!/amireh/lua_cliargs/builds)
 
 cliargs is a command-line argument parser for Lua. It supports several types of arguments:
 
 1. required arguments
-1. optional arguments with different notations: `-short-key VALUE` and/or `--expanded-key=VALUE`
-2. optional arguments with multiple-values that get appended to a list
-1. optional "flag" arguments (on/off options) with notations: `-short-key` and/or `--expanded-key`
-1. a single optional "splat" argument which can be repeated (must be the last argument)
+2. optional arguments with different notations: `-short-key VALUE` and/or `--expanded-key=VALUE`
+3. optional arguments with multiple-values that get appended to a list
+4. optional "flag" arguments (on/off options) with notations: `-short-key` and/or `--expanded-key`
+5. a single optional "splat" argument which can be repeated (must be the last argument)
 
 Optional arguments can have default values (strings), flags always default to 'true'.
 
-## Usage Example
-See `example.lua` for an example on how to use the parser.
-Try it with the following sample command lines;
+## Usage Examples
 
-```
-example.lua --help
-example.lua -o myfile -d --compress=gzip inputfile
-example.lua --__DUMP__ -o myfile -d --compress=gzip inputfile
-```
-
-**Accessing arguments**
+See the examples under the `examples/` directory.
 
-All types of arguments must specify a *key*. In the case of required arguments, the keys are only used in the help listings. However, for optional arguments, they are mandatory (either *--key* or *--extended-key* must be specified, the other is optional).
+## API
 
-The `parse()`  method will parse the command line and return a table with results. Accessing argument or option values in this table can be done using the key with the leading dashes omitted (`-` or `--`). When defining an option (or a flag) , you can access it using either key or expanded-key; they'll both be defined.
+See http://lua-cliargs.netlify.com/ for the API docs.
 
 ## Help listings `--help`
 
-A help listing will be automatically generated and accessed using the `--help` argument. You can also force its display in the code using `cli:print_help()`.
+A help listing will be automatically generated and accessed using the `--help` argument. When such an option is encountered, `cli:parse()` will abort and return `nil, string` with the help message; you are free to print it to the screen using `print()` if you want.
 
-This is the result for our example (see examples/00_general.lua):
+You can also force its display in the code using `cli:print_help()`.
+
+This is the result for our example (see `examples/00_general.lua`):
 
 ```
 Usage: cli_example.lua [OPTIONS]  INPUT  [OUTPUT-1 [OUTPUT-2 [...]]]
@@ -110,35 +104,67 @@ Many thanks to everyone who reported bugs, provided fixes, and added entirely ne
 
 *If I missed you, don't hesitate to update this file or just email me.*
 
-## Reference
+## Changelog
+
+### Changes from 2.5.x 3.0
 
-A function reference was generated using [LunaDoc](http://jgm.github.com/lunamark/lunadoc.1.html) which can be found [here](http://lua-cliargs.docs.mxvt.net).
+This major version release contains BREAKING API CHANGES. See the UPGRADE guide for help in updating your code to make use of it.
 
-## Changelog
+**More flexible parsing**
+
+- options can occur anywhere now even after arguments (unless the `--` indicator is specified, then no options are parsed afterwards.) Previously, options were accepted only before arguments.
+- options using the short-key notation can be specified using `=` as a value delimiter as well as a space (e.g. `-c=lzma` and `-c lzma`)
+- the library is now more flexible with option definitions (notations like `-key VALUE`, `--key=VALUE`, `-k=VALUE` are all treated equally)
+- `--help` or `-h` will now cause the help listing to be displayed no matter where they are. Previously, this only happened if they were supplied as the first option.
+
+**Basic command support**
+
+You may now define commands with custom handlers. A command may be invoked by supplying its name as the first argument (options can still come before or afterwards). lua_cliargs will forward the rest of the options to that command to handle, which can be in a separate file.
+
+See `examples/04_commands--git.lua` for an example.
+
+**Re-defining defaults**
+
+It is now possible to pass a table containing default values (and override any 
+existing defaults).
+
+The function for doing this is called `cli:load_defaults().`.
+
+This makes it possible to load run-time defaults from a configuration file, for example.
+
+**Reading configuration files**
+
+`cliargs` now exposes some convenience helpers for loading configuration from files (and a separate hook, `cli:load_defaults()` to inject this config if you want) found in `cli:read_defaults()`. This method takes a file-path and an optional file format and it will parse it for you, provided you have the necessary libraries installed.
+
+See the API docs for using this hook.
+
+**Other changes**
+
+- internal code changes and more comprehensive test-coverage
 
-Changes from 2.5.1 to 2.5.2
+### Changes from 2.5.1 to 2.5.2
 
 - No longer tracking the (legacy) tarballs in git or the luarocks package. Instead, we use the GitHub release tarballs for each version.
 
-Changes in 2.4.0 from 2.3-4
+### Changes in 2.4.0 from 2.3-4
 
 1. All arguments now accept a callback that will be invoked when parsing of those arguments was successful
 2. (**POSSIBLY BREAKING**) Default value for flags is now `nil` instead of `false`. This will only affect existing behavior if you were explicitly testing unset flags to equal `false` (i.e. `if flag == false then`) as opposed to `if flag then` (or `if not flag then`).
 3. Minor bugfixes
 
-Changes in 2.3.0
+### Changes in 2.3.0
 
 1. the parser will now understand `--` to denote the end of optional arguments and will map whatever comes after it to required/splat args
 2. `-short VALUE` is now properly supported, so is `-short=VALUE`
 3. short-key options can now officially be composed of more than 1 character
 4. the parser now accepts callbacks that will be invoked as soon as options are parsed so that you can bail out of parsing preemptively (like for `--version` or `--help` options)
 5. options can now accept multiple values via multiple invocations if a table was provided as a default value (passed-in values will be appended to that list)
 
-Changes in 2.2-0 from 2.1-2
+### Changes in 2.2-0 from 2.1-2
 
 1. the `=` that separates keys from values in the `--expanded-key` notation is no longer mandatory; using either a space or a `=` will map the value to the key (e.g., `--compress lzma` is equal to `--compress=lzma`)
 
-Changes in 2.0.0 from 1.x.x
+### Changes in 2.0.0 from 1.x.x
 
 1. added the 'splat' argument, an optional repetitive argument for which a maximum number of occurrences can be set
 1. removed the reference, arguments are now solely returned by their key/expanded-key (BREAKING!)
@@ -152,7 +178,7 @@ Changes in 2.0.0 from 1.x.x
 
 The code is released under the MIT terms. Feel free to use it in both open and closed software as you please.
 
-Copyright (c) 2011-2012 Ahmad Amireh
+Copyright (c) 2011-2015 Ahmad Amireh
 
 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:
 

UPGRADE.md

@@ -0,0 +1,37 @@
+## Upgrading from 2.x to 3.0
+
+- `cli._VERSION` has been renamed to `cli.VERSION`
+
+**Function renames**
+
+The functions for defining arguments of all types have been renamed to drop the
+`_add` prefix from their names. This affects the following functions:
+
+- `cli:add_argument` has been renamed to `cli:argument`
+- `cli:add_option` has been renamed to `cli:option`
+- `cli:add_flag` has been renamed to `cli:flag`
+- `cli:optarg` has been renamed to `cli:splat`
+
+**Function alias removals**
+
+- `cli:add_opt` has been removed. Use `cli:option` instead
+- `cli:add_arg` has been removed. Use `cli:argument` instead
+- `cli:parse_args` has been removed. Use `cli:parse` instead
+
+**`cli:parse()` invocation changes**
+
+`cli:parse()` no longer accepts the auxiliary arguments `noprint` and `dump` as the second and third arguments; only one argument is now accepted and that is a custom arguments table. If left unspecified, we use the global `_G['arg']` program argument table as usual.
+
+So, the new signature is:
+
+`cli:parse(args: table) -> table`
+
+- to make the parser silent, use `cli:set_silent(true)` before invoking the parser
+- to generate the internal state dump, a runtime argument `--__DUMP__` must be passed as the first argument
+
+**Private function are now hidden**
+
+Hopefully you weren't relying on any of these because they are no longer exposed, and they weren't documented. The affected previous exports are:
+
+- `cli:__lookup()`
+- `cli:__add_opt()`

bin/coverage

@@ -8,7 +8,23 @@
 #   $ ./bin/coverage
 #   $ cat luacov.report.out
 
+which luacov &> /dev/null
+
+if [ $? -ne 0 ]; then
+  echo "You must have luacov installed."
+  echo "Run 'luarocks install luacov' then try again".
+  exit 1
+fi
+
+which busted &> /dev/null
+
+if [ $? -ne 0 ]; then
+  echo "You must have luacov installed."
+  echo "Run 'luarocks install busted' then try again".
+  exit 1
+fi
+
 busted -c
-luacov src/cliargs.lua
+luacov src/
 rm luacov.stats.out
 grep -zPo "(?s)={10,}\nSummary\n={10,}.+" luacov.report.out

bin/docs

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+if [ ! -d "doc" ]; then
+  echo "Must be run from lua_cliargs root"
+  exit 1
+fi
+
+which npm &> /dev/null
+
+if [ $? -ne 0 ]; then
+  echo "You must have npm (node.js) installed."
+  exit 1
+fi
+
+cd doc
+
+npm install
+
+./node_modules/tinydoc/cli/tinydoc run
+
+echo "Docs compiled successfully. Open doc/compiled/index.html in a browser."

bin/lint

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+which luacheck &> /dev/null
+
+if [ $? -ne 0 ]; then
+  echo "You must have luacheck installed."
+  echo "Run 'luarocks install luacheck' then try again".
+  exit 1
+fi
+
+if [ ! -d src ]; then
+  echo "You must run $0 from lua_cliargs root."
+  exit 1
+fi
+
+luacheck .

bin/release

@@ -24,8 +24,7 @@ function confirm {
 
 VERSION=$1
 SRC_FILE="src/cliargs.lua"
-# VERSION=$(grep "version" lua_cliargs-*.rockspec | cut -d' ' -f3 | sed 's/"//g')
-SRC_VERSION=$(grep "_VERSION" src/cliargs.lua | sed -e 's/.*=//' -e 's/.* //' -e 's/"//g')
+SRC_VERSION=$(grep "VERSION" src/cliargs.lua | sed -e 's/.*=//' -e 's/.* //' -e 's/"//g')
 
 NEW_ROCKSPEC="lua_cliargs-${VERSION}.rockspec"
 OLD_ROCKSPEC="lua_cliargs-${SRC_VERSION}.rockspec"

bin/watch-tests.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+#
+# Watches spec files and re-runs the busted suite when a spec or source file
+# changes.
+#
+# Usage:
+#
+#     $0 [--focus]
+#
+# If --focus is passed, only the last spec file that has changed will be run
+# when a _source_ file changes. Otherwise, all specs will run on source changes.
+#
+# Requires inotify-tools[1].
+#
+# [1] http://linux.die.net/man/1/inotifywait
+
+if [ ! -d spec ]; then
+  echo "Must be run from lua_cliargs root."
+  exit 1
+fi
+
+LAST_FILE="spec/"
+
+inotifywait -rm --format '%w %f' -e close_write -e create src/ spec/ | while read dir file; do
+  FILEPATH="${dir}${file}"
+
+  if [[ $FILEPATH =~ src\/ ]]; then
+    busted $@ "${LAST_FILE}"
+  else
+    if [[ $1 =~ "focus" ]]; then
+      LAST_FILE=$FILEPATH
+    fi
+
+    busted $@ "${FILEPATH}"
+  fi
+done