gli_aziz_light 2.8.1

data/features/step_definitions/gli_executable_steps.rb

@@ -0,0 +1,18 @@
+Given /^I have GLI installed$/ do
+  add_to_lib_path(GLI_LIB_PATH)
+end
+
+Given /^my terminal size is "([^"]*)"$/ do |terminal_size|
+  if terminal_size =~/^(\d+)x(\d+)$/
+    ENV['COLUMNS'] = $1
+    ENV['LINES'] = $2
+  else
+    raise "Terminal size should be COLxLines, e.g. 80x24" 
+  end
+end
+
+
+Given /^the file "(.*?)" doesn't exist$/ do |filename|
+  FileUtils.rm filename if File.exists?(filename)
+end
+

data/features/step_definitions/gli_init_steps.rb

@@ -0,0 +1,11 @@
+Given /^GLI's libs are in my path$/ do
+  ENV['RUBYLIB'] = GLI_LIB_PATH
+end
+
+Given /^I make sure todo's lib dir is in my lib path$/ do
+  add_to_lib_path("./lib")
+end
+
+Given /^todo's libs are no longer in my load path$/ do
+  remove_from_lib_path("./lib")
+end

data/features/step_definitions/todo_steps.rb

@@ -0,0 +1,88 @@
+Given /^todo_legacy's bin directory is in my path/ do
+  add_to_path(File.expand_path(File.join(File.dirname(__FILE__),'..','..','test','apps','todo_legacy','bin')))
+end
+
+Given /^todo's bin directory is in my path/ do
+  add_to_path(File.expand_path(File.join(File.dirname(__FILE__),'..','..','test','apps','todo','bin')))
+end
+
+Given /^the todo app is coded to avoid sorted help commands$/ do
+  ENV['TODO_SORT_HELP'] = 'manually'
+end
+
+Given /^the todo app is coded to avoid wrapping text$/ do
+  ENV['TODO_WRAP_HELP_TEXT'] = 'one_line'
+end
+
+Given /^the todo app is coded to wrap text only for tty$/ do
+  ENV['TODO_WRAP_HELP_TEXT'] = 'tty_only'
+end
+
+Given /^a clean home directory$/ do
+  FileUtils.rm_rf File.join(ENV['HOME'],'gli_test_todo.rc')
+end
+
+Then /^the config file should contain a section for each command and subcommand$/ do
+  config = File.open(File.join(ENV['HOME'],'gli_test_todo.rc')) do |file|
+    YAML::load(file)
+  end
+  config.keys.should include(:flag)
+  config[:flag].should == 'foo'
+  config[:flag].tap do |flag|
+    if flag.respond_to?(:encoding)
+      flag.encoding.name.should == 'UTF-8'
+    end
+  end
+  config.keys.should include(:switch)
+  config[:switch].should == true
+  config.keys.should include(:otherswitch)
+  config[:otherswitch].should == false
+  config.keys.should include('commands')
+  %w(chained chained2 create first list ls second).map(&:to_sym).each do |command_name|
+    config['commands'].keys.should include(command_name)
+  end
+  config['commands'][:create].keys.should include('commands')
+  config['commands'][:create]['commands'].should include(:tasks)
+  config['commands'][:create]['commands'].should include(:contexts)
+
+  config['commands'][:list].keys.should include('commands')
+  config['commands'][:list]['commands'].should include(:tasks)
+  config['commands'][:list]['commands'].should include(:contexts)
+end
+
+Given /^a config file that specifies defaults for some commands with subcommands$/ do
+  @config = {
+    'commands' => {
+      :list => {
+        'commands' => {
+          :tasks => {
+            :flag => 'foobar',
+          },
+          :contexts => {
+            :otherflag => 'crud',
+          },
+        }
+      }
+    }
+  }
+  File.open(File.join(ENV['HOME'],'gli_test_todo.rc'),'w') do |file|
+    file.puts @config.to_yaml
+  end
+end
+
+Then /^I should see the defaults for '(.*)' from the config file in the help$/ do |command_path|
+  if command_path == 'list tasks'
+    step %{the output should match /--flag.*default: foobar/}
+    unescape(all_output).should_not =~ /#{unescape("--otherflag.*default: crud")}/m
+  elsif command_path == 'list contexts'
+    step %{the output should match /--otherflag.*default: crud/}
+    unescape(all_output).should_not =~ /#{unescape("--flag.*default: foobar")}/m
+  else
+    raise "Don't know how to test for command path #{command_path}"
+  end
+end
+
+
+Given /^the todo app is coded to use verbatim formatting$/ do
+  ENV['TODO_WRAP_HELP_TEXT'] = 'verbatim'
+end

data/features/support/env.rb

@@ -0,0 +1,53 @@
+begin
+  require 'simplecov'
+  SimpleCov.start
+rescue LoadError
+  # Don't care
+end
+require 'aruba/cucumber'
+require 'fileutils'
+
+# Adds GLI's bin dir to our path
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+GLI_LIB_PATH = File.expand_path(File.join(File.dirname(__FILE__),'..','..','lib'))
+
+GLI_GEMSET = 'gli-testing'
+TMP_PATH = 'tmp/aruba'
+
+Before do
+  # Not sure how else to get this dynamically
+  @dirs = [TMP_PATH]
+  @aruba_timeout_seconds = 5
+  @original_path = ENV['PATH'].split(File::PATH_SEPARATOR)
+  @original_home = ENV['HOME']
+  new_home = "/tmp/fakehome"
+  FileUtils.rm_rf new_home
+  FileUtils.mkdir new_home
+  ENV['HOME'] = new_home
+  FileUtils.cp 'gli.rdoc','gli.rdoc.orig'
+end
+
+After do |scenario|
+  ENV['RUBYLIB'] = ''
+  todo_app_dir = File.join(TMP_PATH,'todo')
+  if File.exists? todo_app_dir
+    FileUtils.rm_rf(todo_app_dir)
+  end
+  ENV['PATH'] = @original_path.join(File::PATH_SEPARATOR)
+  ENV['HOME'] = @original_home
+  ENV['TODO_SORT_HELP'] = nil
+  ENV['TODO_WRAP_HELP_TEXT'] = nil
+  FileUtils.mv 'gli.rdoc.orig','gli.rdoc'
+end
+
+def add_to_path(dir)
+  ENV['PATH'] = "#{dir}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+end
+
+def add_to_lib_path(path)
+  ENV["RUBYLIB"] = (String(ENV["RUBYLIB"]).split(File::PATH_SEPARATOR) + [path]).join(File::PATH_SEPARATOR)
+end
+
+def remove_from_lib_path(path)
+  ENV["RUBYLIB"] = (String(ENV["RUBYLIB"]).split(File::PATH_SEPARATOR) - [path]).join(File::PATH_SEPARATOR)
+end

data/features/todo.feature

@@ -0,0 +1,413 @@
+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] [--flag arg] [-x arg] [tasks]
+        todo [global options] list [command options] [--otherflag arg] [-b] [-f|--foobar] contexts
+
+    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     |
+      | --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] [--flag arg] [-x arg] [tasks]
+        todo [global options] list [command options] [--otherflag arg] [-b] [-f|--foobar] contexts
+
+    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)
+    """
+
+  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] [--flag arg] [-x arg] [tasks]
+        todo [global options] list [command options] [--otherflag arg] [-b] [-f|--foobar] contexts
+
+    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)
+    """
+
+  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] [--flag arg] [-x arg] [tasks]
+        todo [global options] list [command options] [--otherflag arg] [-b] [-f|--foobar] contexts
+
+    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)
+    """
+
+  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 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`
+    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] [-b] [-f|--foobar] contexts
+        todo [global options] ls [command options] [-x arg] tasks
+
+    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