gli 1.6.0 → 2.0.0.rc3

data/features/step_definitions/gli_executable_steps.rb

@@ -0,0 +1,12 @@
+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

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,69 @@
+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 /^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
+

data/features/support/env.rb

@@ -0,0 +1,49 @@
+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
+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
+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,182 @@
+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: Getting Help for todo in general
+    When I successfully run `todo help`
+    Then the output should contain:
+    """
+    NAME
+        todo - Manages tasks
+
+    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      - 
+
+    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
+        second        - 
+    """
+
+  Scenario: Getting Help for a top level command of todo
+    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] 
+
+    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)
+    """
+
+  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 [command options] 
+        todo [global options] create [command options]  contexts
+        todo [global options] create [command options]  tasks
+
+    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: 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: 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

data/gli.cheat

@@ -0,0 +1,95 @@
+gli - create command-suite apps, a la git, using this awesome Ruby DSL
+======================================================================
+
+Setup and Usage
+---------------
+
+Installation:
+$ gem install gli
+
+Show list of commands
+$ gli help [command]
+
+Show help for one command
+$ gli help init
+
+Create a new GLI-based project with the commands foo and bar
+$ gli init project_name foo bar
+
+Create a new GLI-based project with an ext directory
+$ gli init -e project_name foo bar
+
+Create a new GLI-based project without a test directory (bad!)
+$ gli init --notest project_name foo bar
+
+Create a new GLI-based project somewhere else than .
+$ gli -r /tmp init project_name foo bar
+
+Just see what GLI would create
+$ gli -n init -e project_name foo bar
+
+
+Using GLI's DSL
+---------------
+
+Create a switch (option that takes no args)
+
+  desc 'Dry-run; don't change the disk
+  switch [:n,'dry-run']
+  # Both -n and --dry-run will work
+  * --no-dry-run will set the switch to false
+  # Access in code via global_options[:n]
+  # or global_options[:'dry-run']
+
+Create it on one line
+  switch :n,'dry-run', :desc => 'Dry-run; don't change the disk
+
+Don't create a negatable version
+  switch :n,'dry-run', :negatable => false, :desc => 'Dry-run; don't change the disk
+  # --no-dry-run is not accepted 
+
+Create a flag (option that takes an argument)
+
+  desc 'Location of the config file'
+  arg_name 'path_to_file'
+  default_value '~/.glirc'
+  flag [:c,:conf], :must_match => /^\..*rc$/
+  # Both -c and --conf work, if this flag is omitted
+  # then the default of ~/.glirc is avaialble to the code
+  # The argument must match the given regex
+  # Access in code via global_options[:c] (or :conf)
+
+Create a flag in a more compact style
+
+  flag :c,:conf, :desc => 'Location of the config file', 
+                 :arg_name => 'path_to_file', :default_value =>  '~/.glirc'
+
+Create a command
+
+  desc 'Get the list of open tickets'
+  command [:tickets] do |c|
+    c.desc 'Only assigned to me'
+    c.switch [:m,:me]
+
+    c.desc 'Show only tickets for one project'
+    c.flag [:p,:project,'only-project']
+
+    c.action do |global_options,options,args|
+      # global_options has the global options as a hash
+      # options are the command specific ones (e.g. options[:p])
+      # args are the command line arguments that weren't parsed
+      # raise an exception or exit_now! if things go wrong
+    end
+  end
+
+Set up stuff ahead of time
+
+  pre do |global_options,command,options,args|
+    return true if things_are_ok
+    return false if we_should_abort_the_command
+  end
+
+Use GLI
+
+  exit run(ARGV)
+  # run returns a suitable exit status

data/gli.gemspec

@@ -0,0 +1,34 @@
+# Make sure we get the gli that's local
+require File.join([File.dirname(__FILE__),'lib','gli','version.rb'])
+
+spec = Gem::Specification.new do |s| 
+  s.name = 'gli'
+  s.version = GLI::VERSION
+  s.author = 'David Copeland'
+  s.email = 'davidcopeland@naildrivin5.com'
+  s.homepage = 'http://davetron5000.github.com/gli'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A Git Like Interface for building command line apps'
+  s.description = 'An application and API for describing command line interfaces that can be used to quickly create a shell for executing command-line tasks.  The command line user interface is similar to Git''s, in that it takes global options, a command, command-specific options, and arguments'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   =  'gli'
+  s.require_paths = ["lib"]
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc', 'gli.rdoc']
+  s.rdoc_options << '--title' << 'Git Like Interface' << '--main' << 'README.rdoc'
+  s.bindir = 'bin'
+  s.rubyforge_project = 'gli'
+  s.add_development_dependency('rake', '~> 0.9.2.2')
+  s.add_development_dependency('rdoc', '~> 3.11')
+  s.add_development_dependency('roodi', '~> 2.1.0')
+  s.add_development_dependency('reek')
+  s.add_development_dependency('grancher', '~> 0.1.5')
+  s.add_development_dependency('rainbow', '~> 1.1.1')
+  s.add_development_dependency('clean_test')
+  s.add_development_dependency('aruba', '~> 0.4.7')
+  s.add_development_dependency('sdoc')
+end
+