coa 0.3.9 → 0.4.0

package/.npmignore

@@ -1,5 +1,6 @@
 .idea
 *.iml
 node_modules/
+!node_modules/coa*.js
 lib-cov/
 html-report/

package/.travis.yml

@@ -1,10 +1,11 @@
 language: node_js
 
 node_js:
-  - 0.6
-  - 0.8
-  - 0.9
+  - "0.6"
+  - "0.8"
+  - "0.10"
+  - "0.11"
 
 matrix:
   allow_failures:
-    - node_js: 0.9
+    - node_js: 0.11

package/README.md

@@ -227,6 +227,11 @@ Default value passed through validation function as ordinary value.<br>
 **@param** *Object* `_def`<br>
 **@returns** *COA.Opt* `this` instance (for chainability)
 
+#### Opt.input
+Make option value inputting stream.
+It's add useful validation and shortcut for STDIN.
+**@returns** *{COA.Opt}* `this` instance (for chainability)
+
 #### Opt.output
 Make option value outputing stream.<br>
 It's add useful validation and shortcut for STDOUT.<br>

package/lib/arg.js

@@ -1,4 +1,4 @@
-// Generated by CoffeeScript 1.4.0
+// Generated by CoffeeScript 1.6.3
 var Arg, Cmd, Color, Opt;
 
 Color = require('./color').Color;

package/lib/cmd.js

@@ -1,4 +1,4 @@
-// Generated by CoffeeScript 1.4.0
+// Generated by CoffeeScript 1.6.3
 var Cmd, Color, PATH, Q, UTIL,
   __slice = [].slice;
 
@@ -35,6 +35,7 @@ exports.Cmd = Cmd = (function() {
     this._opts = [];
     this._optsByKey = {};
     this._args = [];
+    this._ext = false;
   }
 
   Cmd.get = function(propertyName, func) {
@@ -70,10 +71,13 @@ exports.Cmd = Cmd = (function() {
   });
 
   Cmd.prototype._parent = function(cmd) {
+    this._cmd = cmd || this;
     if (cmd) {
       cmd._cmds.push(this);
+      if (this._name) {
+        this._cmd._cmdsByName[this._name] = this;
+      }
     }
-    this._cmd = cmd || this;
     return this;
   };
 
@@ -221,6 +225,18 @@ exports.Cmd = Cmd = (function() {
     return this.cmd().name('completion').apply(require('./completion')).end();
   };
 
+  /**
+  Allow command to be extendable by external node.js modules.
+  @param {String} [pattern]  Pattern of node.js module to find subcommands at.
+  @returns {COA.Cmd} this instance (for chainability)
+  */
+
+
+  Cmd.prototype.extendable = function(pattern) {
+    this._ext = pattern || true;
+    return this;
+  };
+
   Cmd.prototype._exit = function(msg, code) {
     return process.once('exit', function() {
       if (msg) {
@@ -304,7 +320,7 @@ exports.Cmd = Cmd = (function() {
   };
 
   Cmd.prototype._parseCmd = function(argv, unparsed) {
-    var cmd, i, optSeen;
+    var c, cmd, cmdDesc, e, i, optSeen, pkg;
     if (unparsed == null) {
       unparsed = [];
     }
@@ -314,8 +330,46 @@ exports.Cmd = Cmd = (function() {
       if (!i.indexOf('-')) {
         optSeen = true;
       }
-      if (!optSeen && /^\w[\w-_]*$/.test(i) && (cmd = this._cmdsByName[i])) {
-        return cmd._parseCmd(argv, unparsed);
+      if (!optSeen && /^\w[\w-_]*$/.test(i)) {
+        cmd = this._cmdsByName[i];
+        if (!cmd && this._ext) {
+          if (typeof this._ext === 'string') {
+            if (~this._ext.indexOf('%s')) {
+              pkg = UTIL.format(this._ext, i);
+            } else {
+              pkg = this._ext + i;
+            }
+          } else if (this._ext === true) {
+            pkg = i;
+            c = this;
+            while (true) {
+              pkg = c._name + '-' + pkg;
+              if (c._cmd === c) {
+                break;
+              }
+              c = c._cmd;
+            }
+          }
+          try {
+            cmdDesc = require(pkg);
+          } catch (_error) {
+            e = _error;
+          }
+          if (cmdDesc) {
+            if (typeof cmdDesc === 'function') {
+              this.cmd().name(i).apply(cmdDesc).end();
+            } else if (typeof cmdDesc === 'object') {
+              this.cmd(cmdDesc);
+              cmdDesc.name(i);
+            } else {
+              throw new Error('Error: Unsupported command declaration type, ' + 'should be function or COA.Cmd() object');
+            }
+            cmd = this._cmdsByName[i];
+          }
+        }
+        if (cmd) {
+          return cmd._parseCmd(argv, unparsed);
+        }
       }
       unparsed.push(i);
     }

package/lib/color.js

@@ -1,4 +1,4 @@
-// Generated by CoffeeScript 1.4.0
+// Generated by CoffeeScript 1.6.3
 var colors;
 
 colors = {

package/lib/completion.js

@@ -1,4 +1,4 @@
-// Generated by CoffeeScript 1.4.0
+// Generated by CoffeeScript 1.6.3
 /**
 Most of the code adopted from the npm package shell completion code.
 See https://github.com/isaacs/npm/blob/master/lib/completion.js
@@ -21,7 +21,7 @@ module.exports = function() {
       e.errno = require('constants').ENOTSUP;
       return this.reject(e);
     }
-    if (!(process.env.COMP_CWORD != null) || !(process.env.COMP_LINE != null) || !(process.env.COMP_POINT != null)) {
+    if ((process.env.COMP_CWORD == null) || (process.env.COMP_LINE == null) || (process.env.COMP_POINT == null)) {
       return dumpScript(this._cmd._name);
     }
     console.error('COMP_LINE:  %s', process.env.COMP_LINE);

package/lib/index.js

@@ -1,7 +1,10 @@
-// Generated by CoffeeScript 1.4.0
-
+// Generated by CoffeeScript 1.6.3
 exports.Cmd = require('./cmd').Cmd;
 
+exports.Opt = require('./cmd').Opt;
+
+exports.Arg = require('./cmd').Arg;
+
 exports.shell = require('./shell');
 
 exports.require = require;

package/lib/opt.js

@@ -1,4 +1,4 @@
-// Generated by CoffeeScript 1.4.0
+// Generated by CoffeeScript 1.6.3
 var Cmd, Color, Opt, Q, fs;
 
 fs = require('fs');

package/lib/shell.js

@@ -1,5 +1,4 @@
-// Generated by CoffeeScript 1.4.0
-
+// Generated by CoffeeScript 1.6.3
 exports.unescape = function(w) {
   w = w.charAt(0) === '"' ? w.replace(/^"|([^\\])"$/g, '$1') : w.replace(/\\ /g, ' ');
   return w.replace(/\\("|'|\$|`|\\)/g, '$1');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "coa",
   "description": "Command-Option-Argument: Yet another parser for command line options.",
-  "version": "0.3.9",
+  "version": "0.4.0",
   "homepage": "http://github.com/veged/coa",
   "author": "Sergey Berezhnoy <veged@ya.ru> (http://github.com/veged)",
   "maintainers": [
@@ -19,15 +19,15 @@
     "lib": "./lib"
   },
   "dependencies": {
-    "q": "~0.8.10"
+    "q": "~0.9.6"
   },
   "devDependencies": {
-    "coffee-script": "~1.4.0",
-    "istanbul": "~0.1.11",
+    "coffee-script": "~1.6.3",
+    "istanbul": "~0.1.40",
     "mocha-as-promised": "*",
     "mocha-istanbul": "*",
-    "mocha": "~1.6.0",
-    "chai": "~1.3.0"
+    "mocha": "~1.12.0",
+    "chai": "~1.7.2"
   },
   "scripts": {
     "test": "make test",

package/src/cmd.coffee

@@ -32,6 +32,8 @@ exports.Cmd = class Cmd
 
         @_args = []
 
+        @_ext = false
+
     @get: (propertyName, func) ->
         Object.defineProperty @::, propertyName,
             configurable: true
@@ -52,8 +54,10 @@ exports.Cmd = class Cmd
         @_api
 
     _parent: (cmd) ->
-        if cmd then cmd._cmds.push @
         @_cmd = cmd or this
+        if cmd
+            cmd._cmds.push @
+            if @_name then @_cmd._cmdsByName[@_name] = @
         @
 
     ###*
@@ -163,6 +167,15 @@ exports.Cmd = class Cmd
             .apply(require './completion')
             .end()
 
+    ###*
+    Allow command to be extendable by external node.js modules.
+    @param {String} [pattern]  Pattern of node.js module to find subcommands at.
+    @returns {COA.Cmd} this instance (for chainability)
+    ###
+    extendable: (pattern) ->
+        @_ext = pattern or true
+        @
+
     _exit: (msg, code) ->
         process.once 'exit', ->
             if msg then UTIL.error msg
@@ -233,8 +246,49 @@ exports.Cmd = class Cmd
         while i = argv.shift()
             if not i.indexOf '-'
                 optSeen = true
-            if not optSeen and /^\w[\w-_]*$/.test(i) and cmd = @_cmdsByName[i]
-                return cmd._parseCmd argv, unparsed
+            if not optSeen and /^\w[\w-_]*$/.test(i)
+                cmd = @_cmdsByName[i]
+
+                if not cmd and @_ext
+                    # construct package name to require
+                    if typeof @_ext is 'string'
+                        if ~@_ext.indexOf('%s')
+                            # use formatted string
+                            pkg = UTIL.format(@_ext, i)
+                        else
+                            # just append subcommand name to the prefix
+                            pkg = @_ext + i
+                    else if @_ext is true
+                        # use default scheme: <command>-<subcommand>-<subcommand> and so on
+                        pkg = i
+                        c = @
+                        loop
+                            pkg = c._name + '-' + pkg
+                            if c._cmd is c then break
+                            c = c._cmd
+
+                    try
+                        cmdDesc = require(pkg)
+                    catch e
+
+                    if cmdDesc
+                        if typeof cmdDesc == 'function'
+                            # set create subcommand, set its name and apply imported function
+                            @cmd()
+                                .name(i)
+                                .apply(cmdDesc)
+                                .end()
+                        else if typeof cmdDesc == 'object'
+                            # register subcommand
+                            @cmd(cmdDesc)
+                            # set command name
+                            cmdDesc.name(i)
+                        else
+                            throw new Error 'Error: Unsupported command declaration type, ' +
+                                'should be function or COA.Cmd() object'
+                        cmd = @_cmdsByName[i]
+                if cmd
+                    return cmd._parseCmd argv, unparsed
 
             unparsed.push i
 

package/src/index.coffee

@@ -1,3 +1,5 @@
 exports.Cmd = require('./cmd').Cmd
+exports.Opt = require('./cmd').Opt
+exports.Arg = require('./cmd').Arg
 exports.shell = require('./shell')
 exports.require = require;

package/test/coa.js

@@ -338,6 +338,22 @@ describe('Arg', function() {
 
 describe('Cmd', function() {
 
+    var doTest = function(o) {
+            assert.deepEqual(o, {
+                opts: { opt: 'value' },
+                args: {
+                    arg1: 'value',
+                    arg2: ['value 1', 'value 2']
+                }
+            });
+        },
+
+        invokeOpts = { opt: 'value' },
+        invokeArgs = {
+            arg1: 'value',
+            arg2:  ['value 1', 'value 2']
+        };
+
     describe('Subcommand', function() {
 
         var cmd = COA.Cmd()
@@ -357,23 +373,7 @@ describe('Cmd', function() {
                 .act(function(opts, args) {
                     return { opts: opts, args: args };
                 })
-                .end(),
-
-            doTest = function(o) {
-                    assert.deepEqual(o, {
-                        opts: { opt: 'value' },
-                        args: {
-                            arg1: 'value',
-                            arg2: ['value 1', 'value 2']
-                        }
-                    });
-                },
-
-            invokeOpts = { opt: 'value' },
-            invokeArgs = {
-                    arg1: 'value',
-                    arg2:  ['value 1', 'value 2']
-                };
+                .end();
 
         describe('when specified on command line', function() {
 
@@ -413,6 +413,80 @@ describe('Cmd', function() {
 
     });
 
+    describe('External subcommand', function() {
+
+        describe('default scheme: cmd.extendable()', function() {
+
+            describe('when described as a function', function() {
+                var cmd = COA.Cmd()
+                    .name('coa')
+                    .extendable();
+
+                it('should be invoked and accept passed opts and args', function() {
+                    return cmd.do(['test', '--opt', 'value', 'value', 'value 1', 'value 2'])
+                        .then(doTest);
+                });
+            });
+
+            describe('when described as an COA.Cmd() object', function() {
+                var cmd = COA.Cmd()
+                    .name('coa')
+                    .extendable();
+
+                it('should be invoked and accept passed opts and args', function() {
+                    return cmd.do(['test-obj', '--opt', 'value', 'value', 'value 1', 'value 2'])
+                        .then(doTest);
+                });
+            });
+
+            describe('2nd level subcommand', function() {
+                var cmd = COA.Cmd()
+                    .name('coa')
+                    .cmd()
+                    .name('test')
+                    .extendable()
+                    .end();
+
+                it('should be invoked and accept passed opts and args', function() {
+                    return cmd.do(['test', 'obj', '--opt', 'value', 'value', 'value 1', 'value 2'])
+                        .then(doTest);
+                });
+            });
+
+        });
+
+        describe("common prefix: cmd.extendable('coa-')", function() {
+
+            describe('when described as a function', function() {
+                var cmd = COA.Cmd()
+                    .name('coa')
+                    .extendable('coa-');
+
+                it('should be invoked and accept passed opts and args', function() {
+                    return cmd.do(['test', '--opt', 'value', 'value', 'value 1', 'value 2'])
+                        .then(doTest);
+                });
+            });
+
+        });
+
+        describe("format string: cmd.extendable('coa-%s')", function() {
+
+            describe('when described as a function', function() {
+                var cmd = COA.Cmd()
+                    .name('coa')
+                    .extendable('coa-%s');
+
+                it('should be invoked and accept passed opts and args', function() {
+                    return cmd.do(['test', '--opt', 'value', 'value', 'value 1', 'value 2'])
+                        .then(doTest);
+                });
+            });
+
+        });
+
+    });
+
     it('helpful(), name(), title()');
 
 });

package/test/mocha.opts

@@ -1,4 +1,3 @@
 --reporter spec
---ignore-leaks
 --timeout 0
 --require test/common.js

package/tests/api-h.js

@@ -6,4 +6,4 @@ require('..').Cmd()
     .then(function(res) {
         console.log(res);
     })
-    .end(); // Q.end()
+    .done(); // Q.done()