RubyGems - gli - Versions diffs - 2.9.0 → 2.20.0 - Mend

gli 2.9.0 → 2.20.0

Files changed (94) hide show

checksums.yaml +5 -5
data/.circleci/config.yml +28 -0
data/.gitignore +3 -3
data/.tool-versions +1 -0
data/Gemfile +0 -2
data/README.rdoc +29 -18
data/Rakefile +15 -37
data/bin/ci +29 -0
data/bin/gli +24 -54
data/bin/rake +29 -0
data/bin/setup +5 -0
data/exe/gli +68 -0
data/gli.gemspec +20 -24
data/gli.rdoc +9 -9
data/lib/gli/app.rb +42 -8
data/lib/gli/app_support.rb +17 -5
data/lib/gli/argument.rb +20 -0
data/lib/gli/command.rb +27 -2
data/lib/gli/command_finder.rb +42 -25
data/lib/gli/command_support.rb +13 -7
data/lib/gli/commands/doc.rb +9 -3
data/lib/gli/commands/help.rb +2 -1
data/lib/gli/commands/help_modules/arg_name_formatter.rb +29 -2
data/lib/gli/commands/help_modules/command_help_format.rb +19 -1
data/lib/gli/commands/help_modules/full_synopsis_formatter.rb +5 -4
data/lib/gli/commands/help_modules/global_help_format.rb +1 -1
data/lib/gli/commands/help_modules/options_formatter.rb +4 -6
data/lib/gli/commands/initconfig.rb +3 -6
data/lib/gli/commands/rdoc_document_listener.rb +2 -1
data/lib/gli/commands/scaffold.rb +71 -142
data/lib/gli/dsl.rb +25 -1
data/lib/gli/exceptions.rb +26 -0
data/lib/gli/flag.rb +23 -2
data/lib/gli/gli_option_parser.rb +73 -21
data/lib/gli/option_parser_factory.rb +10 -3
data/lib/gli/options.rb +2 -2
data/lib/gli/switch.rb +4 -0
data/lib/gli/terminal.rb +6 -2
data/lib/gli/version.rb +1 -1
data/lib/gli.rb +2 -0
data/object-model.dot +29 -0
data/object-model.png +0 -0
data/test/apps/todo/Gemfile +1 -1
data/test/apps/todo/bin/todo +16 -6
data/test/apps/todo/lib/todo/commands/create.rb +48 -18
data/test/apps/todo/lib/todo/commands/list.rb +48 -35
data/test/apps/todo/lib/todo/commands/ls.rb +25 -24
data/test/apps/todo/lib/todo/commands/make.rb +42 -39
data/test/apps/todo/todo.gemspec +1 -2
data/test/apps/todo_legacy/todo.gemspec +1 -2
data/test/apps/todo_plugins/commands/third.rb +2 -0
data/test/integration/gli_cli_test.rb +69 -0
data/test/integration/gli_powered_app_test.rb +52 -0
data/test/integration/scaffold_test.rb +30 -0
data/test/integration/test_helper.rb +52 -0
data/test/unit/command_finder_test.rb +54 -0
data/test/{tc_command.rb → unit/command_test.rb} +20 -7
data/test/unit/compound_command_test.rb +17 -0
data/test/{tc_doc.rb → unit/doc_test.rb} +38 -51
data/test/{tc_flag.rb → unit/flag_test.rb} +19 -25
data/test/{tc_gli.rb → unit/gli_test.rb} +92 -49
data/test/{tc_help.rb → unit/help_test.rb} +54 -113
data/test/{init_simplecov.rb → unit/init_simplecov.rb} +0 -0
data/test/{tc_options.rb → unit/options_test.rb} +4 -4
data/test/unit/subcommand_parsing_test.rb +263 -0
data/test/unit/subcommands_test.rb +245 -0
data/test/{fake_std_out.rb → unit/support/fake_std_out.rb} +0 -0
data/test/{config.yaml → unit/support/gli_test_config.yml} +1 -0
data/test/unit/switch_test.rb +49 -0
data/test/{tc_terminal.rb → unit/terminal_test.rb} +28 -3
data/test/unit/test_helper.rb +13 -0
data/test/unit/verbatim_wrapper_test.rb +24 -0
metadata +86 -141
data/.ruby-gemset +0 -1
data/.ruby-version +0 -1
data/.travis.yml +0 -12
data/ObjectModel.graffle +0 -1191
data/bin/report_on_rake_results +0 -10
data/bin/test_all_rubies.sh +0 -6
data/features/gli_executable.feature +0 -90
data/features/gli_init.feature +0 -232
data/features/step_definitions/gli_executable_steps.rb +0 -18
data/features/step_definitions/gli_init_steps.rb +0 -11
data/features/step_definitions/todo_steps.rb +0 -96
data/features/support/env.rb +0 -54
data/features/todo.feature +0 -449
data/features/todo_legacy.feature +0 -128
data/test/option_test_helper.rb +0 -13
data/test/tc_compound_command.rb +0 -22
data/test/tc_subcommand_parsing.rb +0 -104
data/test/tc_subcommands.rb +0 -259
data/test/tc_switch.rb +0 -55
data/test/tc_verbatim_wrapper.rb +0 -36
data/test/test_helper.rb +0 -20

data/features/todo.feature DELETED Viewed

@@ -1,449 +0,0 @@
-Feature: The todo app has a nice user interface
-  As a user of the todo application
-  It should have a nice UI, since it's GLI-powered
-  Background:
-    Given I have GLI installed
-      And GLI's libs are in my path
-      And my terminal size is "80x24"
-      And todo's bin directory is in my path
-  Scenario: Error message for unknown command
-    When I run `todo help unknown`
-    Then the output should contain:
-    """
-    error: Unknown command 'unknown'.  Use 'todo help' for a list of commands.
-    """
-  Scenario Outline: Getting Help for todo in general
-    When I successfully run `todo <help>`
-    Then the output should contain:
-    """
-    NAME
-        todo - Manages tasks
-        A test program that has a sophisticated UI that can be used to exercise a
-        lot of GLI's power
-    SYNOPSIS
-        todo [global options] command [command options] [arguments...]
-    VERSION
-        0.0.1
-    GLOBAL OPTIONS
-        --flag=arg         - (default: none)
-        --help             - Show this message
-        --[no-]otherswitch -
-        --[no-]switch      -
-        --version          - Display the program version
-    COMMANDS
-        chained       -
-        chained2, ch2 -
-        create, new   - Create a new task or context
-        first         -
-        help          - Shows a list of commands or help for one command
-        initconfig    - Initialize the config file using current global options
-        list          - List things, such as tasks or contexts
-        ls            - LS things, such as tasks or contexts
-        make          -
-        second        -
-        third         -
-    """
-    Examples:
-      | help      |
-      | help      |
-  Scenario: Version display
-    When I successfully run `todo --version`
-    Then the output should contain:
-    """
-    todo version 0.0.1
-    """
-  Scenario: Help completion mode
-    When I successfully run `todo help -c`
-    Then the output should contain:
-    """
-    _doc
-    ch2
-    chained
-    chained2
-    create
-    first
-    help
-    initconfig
-    list
-    ls
-    make
-    new
-    second
-    third
-    """
-  Scenario: Help completion mode for partial match
-    When I successfully run `todo help -c ch`
-    Then the output should contain:
-    """
-    ch2
-    chained
-    chained2
-    """
-  Scenario: Help completion mode for subcommands
-    When I successfully run `todo help -c list`
-    Then the output should contain:
-    """
-    contexts
-    tasks
-    """
-  Scenario: Help completion mode partial match for subcommands
-    When I successfully run `todo help -c list con`
-    Then the output should contain:
-    """
-    contexts
-    """
-  Scenario: Getting Help with self-ordered commands
-    Given the todo app is coded to avoid sorted help commands
-    When I successfully run `todo help`
-    Then the output should contain:
-    """
-    NAME
-        todo - Manages tasks
-        A test program that has a sophisticated UI that can be used to exercise a
-        lot of GLI's power
-    SYNOPSIS
-        todo [global options] command [command options] [arguments...]
-    VERSION
-        0.0.1
-    GLOBAL OPTIONS
-        --flag=arg         - (default: none)
-        --[no-]switch      -
-        --[no-]otherswitch -
-        --version          - Display the program version
-        --help             - Show this message
-    COMMANDS
-        help          - Shows a list of commands or help for one command
-        initconfig    - Initialize the config file using current global options
-        create, new   - Create a new task or context
-        list          - List things, such as tasks or contexts
-        ls            - LS things, such as tasks or contexts
-        make          -
-        third         -
-        first         -
-        second        -
-        chained       -
-        chained2, ch2 -
-    """
-  Scenario Outline: Getting Help for a top level command of todo
-    When I successfully run `todo <help_invocation>`
-    Then the output should contain:
-    """
-    NAME
-        list - List things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
-        todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
-    DESCRIPTION
-        List a whole lot of things that you might be keeping track of in your
-        overall todo list.
-        This is your go-to place or finding all of the things that you might have
-        stored in your todo databases.
-    COMMAND OPTIONS
-        -l, --[no-]long     - Show long form
-        --required_flag=arg - (required, default: none)
-    COMMANDS
-        contexts - List contexts
-        tasks    - List tasks (default)
-    """
-    Examples:
-      | help_invocation |
-      | help list       |
-      | list -h         |
-      | list --help     |
-      | --help list     |
-  Scenario: Getting Help for a top level command of todo with no command options
-    When I successfully run `todo help chained`
-    Then the output should contain:
-    """
-    NAME
-        chained -
-    SYNOPSIS
-        todo [global options] chained
-    """
-  Scenario: Getting Help with no wrapping
-    Given the todo app is coded to avoid wrapping text
-    When I successfully run `todo help list`
-    Then the output should contain:
-    """
-    NAME
-        list - List things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
-        todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
-    DESCRIPTION
-        List a whole lot of things that you might be keeping track of    in your overall todo list.   This is your go-to place or finding all of the things that you   might have    stored in    your todo databases.
-    COMMAND OPTIONS
-        -l, --[no-]long     - Show long form
-        --required_flag=arg - (required, default: none)
-    COMMANDS
-        contexts - List contexts
-        tasks    - List tasks (default)
-    """
-  Scenario: Getting Help with verbatim formatting
-    Given the todo app is coded to use verbatim formatting
-    When I successfully run `todo help list`
-    Then the output should contain:
-    """
-    NAME
-        list - List things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
-        todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
-    DESCRIPTION
-      List a whole lot of things that you might be keeping track of
-      in your overall todo list.
-      This is your go-to place or finding all of the things that you
-      might have
-      stored in
-      your todo databases.
-    COMMAND OPTIONS
-        -l, --[no-]long     - Show long form
-        --required_flag=arg - (required, default: none)
-    COMMANDS
-        contexts - List contexts
-        tasks    - List tasks (default)
-    """
-  Scenario: Getting Help without wrapping
-    Given the todo app is coded to wrap text only for tty
-    When I successfully run `todo help list`
-    Then the output should contain:
-    """
-    NAME
-        list - List things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
-        todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
-    DESCRIPTION
-        List a whole lot of things that you might be keeping track of    in your overall todo list.   This is your go-to place or finding all of the things that you   might have    stored in    your todo databases.
-    COMMAND OPTIONS
-        -l, --[no-]long     - Show long form
-        --required_flag=arg - (required, default: none)
-    COMMANDS
-        contexts - List contexts
-        tasks    - List tasks (default)
-    """
-  Scenario: Getting Help for a sub command of todo list
-    When I successfully run `todo help list tasks`
-    Then the output should contain:
-    """
-    NAME
-        tasks - List tasks
-    SYNOPSIS
-        todo [global options] list tasks [command options]
-        todo [global options] list tasks [command options] open
-    DESCRIPTION
-        Lists all of your tasks that you have, in varying orders, and all that
-        stuff. Yes, this is long, but I need a long description.
-    COMMAND OPTIONS
-        --flag=arg - (default: none)
-        -x arg     - blah blah crud x whatever (default: none)
-    COMMANDS
-        <default> - list all tasks
-        open      - list open tasks
-    """
-  Scenario: Getting Help for a sub command with no command options
-    When I successfully run `todo help new`
-    Then the output should contain:
-    """
-    NAME
-        create - Create a new task or context
-    SYNOPSIS
-        todo [global options] create
-        todo [global options] create contexts [context_name]
-        todo [global options] create tasks task_name[, task_name]*
-    COMMANDS
-        <default> - Makes a new task
-        contexts  - Make a new context
-        tasks     - Make a new task
-    """
-    And the output should not contain "COMMAND OPTIONS"
-  Scenario: Running list w/out subcommand performs list tasks by default
-    When I successfully run `todo list --required_flag=blah boo yay`
-    Then the output should contain "list tasks: boo,yay"
-  Scenario: Running list w/out subcommand or any arguments performs list tasks by default
-    When I successfully run `todo list --required_flag=blah`
-    Then the output should contain "list tasks:"
-  Scenario: Running chained commands works
-    When I successfully run `todo chained foo bar`
-    Then the output should contain:
-    """
-    first: foo,bar
-    second: foo,bar
-    """
-  Scenario: Running chained commands works and is ordered
-    When I successfully run `todo chained2 foo bar`
-    Then the output should contain:
-    """
-    second: foo,bar
-    first: foo,bar
-    """
-  Scenario: Running chained commands works and is ordered
-    When I successfully run `todo ch2 foo bar`
-    Then the output should contain:
-    """
-    second: foo,bar
-    first: foo,bar
-    """
-  Scenario: Running ls w/out subcommand shows help and an error
-    When I run `todo ls`
-    Then the exit status should not be 0
-    And the stderr should contain "error: Command 'ls' requires a subcommand"
-    And the stdout should contain:
-    """
-    NAME
-        ls - LS things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] ls [command options] contexts [-b] [-f|--foobar]
-        todo [global options] ls [command options] tasks [-x arg]
-    DESCRIPTION
-        List a whole lot of things that you might be keeping track of in your
-        overall todo list.
-        This is your go-to place or finding all of the things that you might have
-        stored in your todo databases.
-    COMMAND OPTIONS
-        -l, --[no-]long - Show long form
-    COMMANDS
-        contexts - List contexts
-        tasks    - List tasks
-    """
-  Scenario: Access to the complex command-line options for nested subcommands
-    Given I run `todo make -l MAKE task -l TASK bug -l BUG other args`
-    Then the exit status should be 0
-    And the stdout should contain:
-    """
-    new task bug
-    other,args
-    BUG
-    BUG
-    TASK
-    TASK
-    MAKE
-    MAKE
-    """
-  Scenario: Init Config makes a reasonable config file
-    Given a clean home directory
-    When I successfully run `todo --flag foo --switch --no-otherswitch initconfig`
-    Then the config file should contain a section for each command and subcommand
-  Scenario: Init Config makes a reasonable config file if one is there and we force it
-    Given a clean home directory
-    And I successfully run `todo --flag foo --switch --no-otherswitch initconfig`
-    When I run `todo --flag foo --switch --no-otherswitch initconfig`
-    Then the exit status should not be 0
-    When I run `todo --flag foo --switch --no-otherswitch initconfig --force`
-    Then the exit status should be 0
-  Scenario: Configuration percolates to the app
-    Given a clean home directory
-    And a config file that specifies defaults for some commands with subcommands
-    When I successfully run `todo help list tasks`
-    Then I should see the defaults for 'list tasks' from the config file in the help
-  Scenario: Do it again because aruba buffers all output
-    Given a clean home directory
-    And a config file that specifies defaults for some commands with subcommands
-    When I successfully run `todo help list contexts`
-    Then I should see the defaults for 'list contexts' from the config file in the help
-  Scenario: A complex SYNOPSIS section gets summarized in terminal mode
-    Given my terminal is 50 characters wide
-    And my app is configured for "terminal" synopses
-    When I run `todo ls`
-    Then the exit status should not be 0
-    And the stderr should contain "error: Command 'ls' requires a subcommand"
-    And the stdout should contain:
-    """
-    NAME
-        ls - LS things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] ls [command options] contexts [subcommand options]
-        todo [global options] ls [command options] tasks [subcommand options]
-    """
-  Scenario: We can always use a compact SYNOPSIS
-    Given my terminal is 500 characters wide
-    And my app is configured for "compact" synopses
-    When I run `todo ls`
-    Then the exit status should not be 0
-    And the stderr should contain "error: Command 'ls' requires a subcommand"
-    And the stdout should contain:
-    """
-    NAME
-        ls - LS things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] ls [command options] contexts [subcommand options]
-        todo [global options] ls [command options] tasks [subcommand options]
-    """

data/features/todo_legacy.feature DELETED Viewed

@@ -1,128 +0,0 @@
-Feature: The todo app is backwards compatible with legacy subcommand parsing
-  As a user of GLI
-  My apps with subcommands should support the old, legacy way, by default
-  Background:
-    Given I have GLI installed
-      And GLI's libs are in my path
-      And my terminal size is "80x24"
-      And todo_legacy's bin directory is in my path
-  Scenario: Help completion mode for subcommands
-    When I successfully run `todo help -c list`
-    Then the output should contain:
-    """
-    contexts
-    tasks
-    """
-  Scenario: Help completion mode partial match for subcommands
-    When I successfully run `todo help -c list con`
-    Then the output should contain:
-    """
-    contexts
-    """
-  Scenario Outline: Getting Help for a top level command of todo
-    When I successfully run `todo <help_invocation>`
-    Then the output should contain:
-    """
-    NAME
-        list - List things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] list [command options] [tasks] [--flag arg] [-x arg]
-        todo [global options] list [command options] contexts [--otherflag arg] [-b] [-f|--foobar]
-    DESCRIPTION
-        List a whole lot of things that you might be keeping track of in your
-        overall todo list.
-        This is your go-to place or finding all of the things that you might have
-        stored in your todo databases.
-    COMMAND OPTIONS
-        -l, --[no-]long - Show long form
-    COMMANDS
-        contexts - List contexts
-        tasks    - List tasks (default)
-    """
-    Examples:
-      | help_invocation |
-      | help list       |
-      | list -h         |
-      | list --help     |
-  Scenario: Getting Help for a sub command of todo list
-    When I successfully run `todo help list tasks`
-    Then the output should contain:
-    """
-    NAME
-        tasks - List tasks
-    SYNOPSIS
-        todo [global options] list tasks [command options]
-        todo [global options] list tasks [command options] open
-    DESCRIPTION
-        Lists all of your tasks that you have, in varying orders, and all that
-        stuff. Yes, this is long, but I need a long description.
-    COMMAND OPTIONS
-        --flag=arg - (default: none)
-        -x arg     - blah blah crud x whatever (default: none)
-    COMMANDS
-        <default> - list all tasks
-        open      - list open tasks
-    """
-  Scenario: Getting Help for a sub command with no command options
-    When I successfully run `todo help new`
-    Then the output should contain:
-    """
-    NAME
-        create - Create a new task or context
-    SYNOPSIS
-        todo [global options] create
-        todo [global options] create contexts [context_name]
-        todo [global options] create tasks task_name[, task_name]*
-    COMMANDS
-        <default> - Makes a new task
-        contexts  - Make a new context
-        tasks     - Make a new task
-    """
-    And the output should not contain "COMMAND OPTIONS"
-  Scenario: Running ls w/out subcommand shows help and an error
-    When I run `todo ls`
-    Then the exit status should not be 0
-    And the stderr should contain "error: Command 'ls' requires a subcommand"
-    And the stdout should contain:
-    """
-    NAME
-        ls - LS things, such as tasks or contexts
-    SYNOPSIS
-        todo [global options] ls [command options] contexts [-b] [-f|--foobar]
-        todo [global options] ls [command options] tasks [-x arg]
-    DESCRIPTION
-        List a whole lot of things that you might be keeping track of in your
-        overall todo list.
-        This is your go-to place or finding all of the things that you might have
-        stored in your todo databases.
-    COMMAND OPTIONS
-        -l, --[no-]long - Show long form
-    COMMANDS
-        contexts - List contexts
-        tasks    - List tasks
-    """

data/test/option_test_helper.rb DELETED Viewed

@@ -1,13 +0,0 @@
-module OptionTestHelper
-  def name_should_be(name)
-    lambda {
-      assert_equal(name,@cli_option.name)
-    }
-  end
-  def aliases_should_be(aliases)
-    lambda {
-      assert_equal(aliases,@cli_option.aliases)
-    }
-  end
-end

data/test/tc_compound_command.rb DELETED Viewed

@@ -1,22 +0,0 @@
-require 'test_helper'
-require 'tempfile'
-class TC_testCompounCommand < Clean::Test::TestCase
-  include TestHelper
-  test_that "when we create a CompoundCommand where some commands are missing, we get an exception" do
-    Given {
-      @name = any_string
-      @unknown_name = any_string
-      @existing_command = OpenStruct.new(:name => @name)
-      @base = OpenStruct.new( :commands => { @name => @existing_command })
-    }
-    When {
-      @code = lambda { GLI::Commands::CompoundCommand.new(@base,{:foo => [@name,@unknown_name]}) }
-    }
-    Then {
-      ex = assert_raises(RuntimeError,&@code)
-      assert_match /#{@unknown_name}/,ex.message
-    }
-  end
-end