Add a CommandRunner class for dispatching commands to args.

pkg/args/test/command_test.dart

-// Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
+// Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library command_test;
 
+import 'package:args/args.dart';
+import 'package:args/command_runner.dart';
 import 'package:unittest/unittest.dart';
-import 'package:args/args.dart';
 import 'utils.dart';
 
 void main() {
-  group('ArgParser.addCommand()', () {
-    test('creates a new ArgParser if none is given', () {
-      var parser = new ArgParser();
-      var command = parser.addCommand('install');
-      expect(parser.commands['install'], equals(command));
-      expect(command is ArgParser, isTrue);
+  var foo;
+  setUp(() {
+    foo = new FooCommand();
+
+      // Make sure [Command.runner] is set up.
+    new CommandRunner("test", "A test command runner.").addCommand(foo);
+  });
+
+  group(".usageTemplate has a sane default", () {
+    test("without subcommands", () {
+      expect(foo.usageTemplate,
+          equals("test foo <arguments>"));
     });
 
-    test('uses the command parser if given one', () {
-      var parser = new ArgParser();
-      var command = new ArgParser();
-      var result = parser.addCommand('install', command);
-      expect(parser.commands['install'], equals(command));
-      expect(result, equals(command));
+    test("with subcommands", () {
+      foo.addSubcommand(new AsyncCommand());
+      expect(foo.usageTemplate,
+          equals("test foo [subcommand] <arguments>"));
     });
 
-    test('throws on a duplicate command name', () {
-      var parser = new ArgParser();
-      parser.addCommand('install');
-      throwsIllegalArg(() => parser.addCommand('install'));
+    test("for a subcommand", () {
+      var async = new AsyncCommand();
+      foo.addSubcommand(async);
+
+      expect(async.usageTemplate,
+          equals("test foo async <arguments>"));
     });
   });
 
-  group('ArgParser.parse()', () {
-    test('parses a command', () {
-      var parser = new ArgParser();
-      var command = parser.addCommand('install');
+  group(".usage", () {
+    test("returns the usage string", () {
+      expect(foo.usage, equals("""
+Set a value.
 
-      var args = parser.parse(['install']);
+Usage: test foo <arguments>
+-h, --help    Print this usage information.
 
-      expect(args.command.name, equals('install'));
-      expect(args.rest, isEmpty);
+Run "test help" to see global options."""));
     });
 
-    test('parses a command option', () {
-      var parser = new ArgParser();
-      var command = parser.addCommand('install');
-      command.addOption('path');
+    test("contains custom options", () {
+      foo.argParser.addFlag("flag", help: "Do something.");
 
-      var args = parser.parse(['install', '--path', 'some/path']);
-      expect(args.command['path'], equals('some/path'));
+      expect(foo.usage, equals("""
+Set a value.
+
+Usage: test foo <arguments>
+-h, --help         Print this usage information.
+    --[no-]flag    Do something.
+
+Run "test help" to see global options."""));
     });
 
-    test('parses a parent solo option before the command', () {
-      var parser = new ArgParser();
-      parser.addOption('mode', abbr: 'm');
-      var command = parser.addCommand('install');
+    test("doesn't print hidden subcommands", () {
+      foo.addSubcommand(new AsyncCommand());
+      foo.addSubcommand(new HiddenCommand());
 
-      var args = parser.parse(['-m', 'debug', 'install']);
-      expect(args['mode'], equals('debug'));
-      expect(args.command.name, equals('install'));
+      expect(foo.usage, equals("""
+Set a value.
+
+Usage: test foo [subcommand] <arguments>
+-h, --help    Print this usage information.
+
+Available subcommands:
+  async   Set a value asynchronously.
+
+Run "test help" to see global options."""));
     });
 
-    test('parses a parent solo option after the command', () {
-      var parser = new ArgParser();
-      parser.addOption('mode', abbr: 'm');
-      var command = parser.addCommand('install');
+    test("doesn't print subcommand aliases", () {
+      foo.addSubcommand(new AliasedCommand());
 
-      var args = parser.parse(['install', '-m', 'debug']);
-      expect(args['mode'], equals('debug'));
-      expect(args.command.name, equals('install'));
-    });
+      expect(foo.usage, equals("""
+Set a value.
 
-    test('parses a parent option before the command', () {
-      var parser = new ArgParser();
-      parser.addFlag('verbose');
-      var command = parser.addCommand('install');
+Usage: test foo [subcommand] <arguments>
+-h, --help    Print this usage information.
 
-      var args = parser.parse(['--verbose', 'install']);
-      expect(args['verbose'], isTrue);
-      expect(args.command.name, equals('install'));
-    });
+Available subcommands:
+  aliased   Set a value.
 
-    test('parses a parent option after the command', () {
-      var parser = new ArgParser();
-      parser.addFlag('verbose');
-      var command = parser.addCommand('install');
-
-      var args = parser.parse(['install', '--verbose']);
-      expect(args['verbose'], isTrue);
-      expect(args.command.name, equals('install'));
-    });
-
-    test('parses a parent negated option before the command', () {
-      var parser = new ArgParser();
-      parser.addFlag('verbose', defaultsTo: true);
-      var command = parser.addCommand('install');
-
-      var args = parser.parse(['--no-verbose', 'install']);
-      expect(args['verbose'], isFalse);
-      expect(args.command.name, equals('install'));
-    });
-
-    test('parses a parent negated option after the command', () {
-      var parser = new ArgParser();
-      parser.addFlag('verbose', defaultsTo: true);
-      var command = parser.addCommand('install');
-
-      var args = parser.parse(['install', '--no-verbose']);
-      expect(args['verbose'], isFalse);
-      expect(args.command.name, equals('install'));
-    });
-
-    test('parses a parent abbreviation before the command', () {
-      var parser = new ArgParser();
-      parser.addFlag('debug', abbr: 'd');
-      parser.addFlag('verbose', abbr: 'v');
-      var command = parser.addCommand('install');
-
-      var args = parser.parse(['-dv', 'install']);
-      expect(args['debug'], isTrue);
-      expect(args['verbose'], isTrue);
-      expect(args.command.name, equals('install'));
-    });
-
-    test('parses a parent abbreviation after the command', () {
-      var parser = new ArgParser();
-      parser.addFlag('debug', abbr: 'd');
-      parser.addFlag('verbose', abbr: 'v');
-      var command = parser.addCommand('install');
-
-      var args = parser.parse(['install', '-dv']);
-      expect(args['debug'], isTrue);
-      expect(args['verbose'], isTrue);
-      expect(args.command.name, equals('install'));
-    });
-
-    test('does not parse a solo command option before the command', () {
-      var parser = new ArgParser();
-      var command = parser.addCommand('install');
-      command.addOption('path', abbr: 'p');
-
-      throwsFormat(parser, ['-p', 'foo', 'install']);
-    });
-
-    test('does not parse a command option before the command', () {
-      var parser = new ArgParser();
-      var command = parser.addCommand('install');
-      command.addOption('path');
-
-      throwsFormat(parser, ['--path', 'foo', 'install']);
-    });
-
-    test('does not parse a command abbreviation before the command', () {
-      var parser = new ArgParser();
-      var command = parser.addCommand('install');
-      command.addFlag('debug', abbr: 'd');
-      command.addFlag('verbose', abbr: 'v');
-
-      throwsFormat(parser, ['-dv', 'install']);
-    });
-
-    test('assigns collapsed options to the proper command', () {
-      var parser = new ArgParser();
-      parser.addFlag('apple', abbr: 'a');
-      var command = parser.addCommand('cmd');
-      command.addFlag('banana', abbr: 'b');
-      var subcommand = command.addCommand('subcmd');
-      subcommand.addFlag('cherry', abbr: 'c');
-
-      var args = parser.parse(['cmd', 'subcmd', '-abc']);
-      expect(args['apple'], isTrue);
-      expect(args.command.name, equals('cmd'));
-      expect(args.command['banana'], isTrue);
-      expect(args.command.command.name, equals('subcmd'));
-      expect(args.command.command['cherry'], isTrue);
-    });
-
-    test('option is given to innermost command that can take it', () {
-      var parser = new ArgParser();
-      parser.addFlag('verbose');
-      var command = parser.addCommand('cmd');
-      command.addFlag('verbose');
-      var subcommand = command.addCommand('subcmd');
-
-      var args = parser.parse(['cmd', 'subcmd', '--verbose']);
-      expect(args['verbose'], isFalse);
-      expect(args.command.name, equals('cmd'));
-      expect(args.command['verbose'], isTrue);
-      expect(args.command.command.name, equals('subcmd'));
-    });
-
-    test('remaining arguments are given to the innermost command', () {
-      var parser = new ArgParser();
-      var command = parser.addCommand('cmd');
-      var subcommand = command.addCommand('subcmd');
-
-      var args = parser.parse(['cmd', 'subcmd', 'other', 'stuff']);
-      expect(args.command.name, equals('cmd'));
-      expect(args.rest, isEmpty);
-      expect(args.command.command.name, equals('subcmd'));
-      expect(args.command.rest, isEmpty);
-      expect(args.command.command.rest, equals(['other', 'stuff']));
+Run "test help" to see global options."""));
     });
   });
+
+  test("usageError splits up the message and usage", () {
+    expect(() => foo.usageError("message"), throwsUsageError("message", """
+Usage: test foo <arguments>
+-h, --help    Print this usage information.
+
+Run "test help" to see global options."""));
+  });
+
+  test("considers a command hidden if all its subcommands are hidden", () {
+    foo.addSubcommand(new HiddenCommand());
+    expect(foo.hidden, isTrue);
+  });
 }