gli_aziz_light 2.8.1

data/README.rdoc

@@ -0,0 +1,109 @@
+= Git-Like Interface Command Line Parser
+
+GLI is the best way to make a "command-suite" command-line application, e.g. one like <tt>git</tt> (for the best way to make a
+simpler command-line application, check out methadone[http://www.github.com/davetron5000/methadone]).
+
+GLI allows you to make a very polished, easy-to-maintain command-line application without a lot
+of syntax, but without restricting you in any way from the power of +OptionParser+.
+
+* {Overview}[http://davetron5000.github.com/gli]
+* {Source on Github}[http://github.com/davetron5000/gli]
+* RDoc[http://davetron5000.github.com/gli/rdoc/index.html]
+
+{<img src="https://secure.travis-ci.org/davetron5000/gli.png?branch=gli-2" alt="Build Status" />}[https://travis-ci.org/davetron5000/gli]
+
+== Use
+
+Install if you need to:
+
+    gem install gli
+
+The simplest way to get started is to create a scaffold project
+
+    gli init todo list add complete
+
+This will create a basic scaffold project in <tt>./todo</tt> with:
+
+* executable in <tt>./todo/bin/todo</tt>.  This file demonstrates most of what you need to describe your command line interface.
+* an empty test in <tt>./todo/test/default_test.rb</tt> that can bootstrap your tests
+* an empty feature in <tt>./todo/features/todo.feature</tt> that can bootstrap testing your CLI via Aruba.
+* a gemspec shell
+* a README shell
+* Rakefile that can generate RDoc, package your Gem and run tests
+* A <tt>Gemfile</tt> suitable for use with Bundler to manage development-time dependencies
+
+Now, you are ready to go:
+
+    > cd todo
+    > bundle exec bin/todo help
+    NAME
+        todo - Describe your application here
+
+    SYNOPSIS
+        todo [global options] command [command options] [arguments...]
+
+    VERSION
+        0.0.1
+
+    GLOBAL OPTIONS
+        -f, --flagname=The name of the argument - Describe some flag here (default: the default)
+        --help                                  - Show this message
+        -s, --[no-]switch                       - Describe some switch here
+
+    COMMANDS
+        add      - Describe add here
+        complete - Describe complete here
+        help     - Shows a list of commands or help for one command
+        list     - Describe list here
+
+    > bundle exec bin/todo help list
+    NAME
+        list - Describe list here
+
+    SYNOPSIS
+        todo [global options] list [command options] Describe arguments to list here
+
+    COMMAND OPTIONS
+        -f arg - Describe a flag to list (default: default)
+        -s     - Describe a switch to list
+
+All you need to do is fill in the documentation and your code; the help system, command-line parsing and many other awesome features are all handled for you.
+
+Get a more detailed walkthrough on the {main site}[http://davetron5000.github.com/gli]
+
+== Supported Platforms
+
+Known to work on
+
+* 1.8.7
+* 1.9.2
+* 1.9.3
+* 2.0.0
+* Ruby Enterprise Edition 1.8.7
+* Rubinius 1.0.1
+* JRuby 1.6.4 
+
+If you're interested in other versions of Ruby, let me know, and I'll add them to my test suite
+
+== Documentation
+
+Extensive documentation is {available at the wiki}[https://github.com/davetron5000/gli/wiki].
+
+API Documentation is available {here}[http://davetron5000.github.com/gli/rdoc/index.html].  Recommend starting with GLI::DSL or GLI::App.
+
+== Credits
+
+Author::  Dave Copeland (mailto:davetron5000 at g mail dot com)
+Copyright:: Copyright (c) 2010 by Dave Copeland
+License:: Distributes under the Apache License, see LICENSE.txt in the source distro
+
+== Links
+
+* [http://davetron5000.github.com/gli] - RubyDoc
+* [http://www.github.com/davetron5000/gli] - Source on GitHub
+* [http://www.github.com/davetron5000/gli/wiki] - Documentation Wiki
+* [http://www.github.com/davetron5000/gli/wiki/Changelog] - Changelog
+
+= <code>gli</code> CLI documentation
+
+:include:gli.rdoc

data/Rakefile

@@ -0,0 +1,126 @@
+require 'sdoc'
+require 'bundler'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+include Rake::DSL
+
+CLEAN << "log"
+CLOBBER << FileList['**/*.rbc']
+
+
+task :rdoc => [:build_rdoc, :hack_css]
+Rake::RDocTask.new(:build_rdoc) do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files = FileList["lib/**/*.rb","README.rdoc"] - 
+                  FileList["lib/gli/commands/help_modules/*.rb"] - 
+                  ["lib/gli/commands/help.rb",
+                   "lib/gli/commands/scaffold.rb",
+                   "lib/gli/support/*.rb",
+                   "lib/gli/app_support.rb",
+                   "lib/gli/option_parser_factory.rb",
+                   "lib/gli/gli_option_parser.rb",
+                   "lib/gli/command_support.rb",]
+  rd.title = 'GLI - Git Like Interface for your command-line apps'
+  rd.options << '-f' << 'sdoc'
+  rd.template = 'direct'
+end
+
+FONT_FIX = {
+  "0.82em" => "16px",
+  "0.833em" => "16px",
+  "0.85em" => "16px",
+  "1.15em" => "20px",
+  "1.1em" => "20px",
+  "1.2em" => "20px",
+  "1.4em" => "24px",
+  "1.5em" => "24px",
+  "1.6em" => "32px",
+  "1em" => "16px",
+  "2.1em" => "38px",
+}
+
+
+task :hack_css do
+  maincss = File.open('html/css/main.css').readlines
+  File.open('html/css/main.css','w') do |file|
+    file.puts '@import url(http://fonts.googleapis.com/css?family=Karla:400,700,400italic,700italic|Alegreya);'
+    
+    maincss.each do |line|
+      if line.strip == 'font-family: "Helvetica Neue", Arial, sans-serif;'
+        file.puts 'font-family: Karla, "Helvetica Neue", Arial, sans-serif;'
+      elsif line.strip == 'font-family: monospace;'
+        file.puts 'font-family: Monaco, monospace;'
+      elsif line =~ /^pre\s*$/
+        file.puts "pre {
+          font-family: Monaco, monospace;
+          margin-bottom: 1em;
+        }
+        pre.original"
+      elsif line =~ /^\s*font-size:\s*(.*)\s*;/
+        if FONT_FIX[$1]
+          file.puts "font-size: #{FONT_FIX[$1]};"
+        else
+          file.puts line.chomp
+        end
+      else
+        file.puts line.chomp
+      end
+    end
+  end
+end
+
+Bundler::GemHelper.install_tasks
+
+desc 'run unit tests'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/init_simplecov.rb','test/tc_*.rb']
+end
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  task :clobber_coverage do
+    rm_rf "coverage"
+  end
+
+  desc 'Measures test coverage'
+  task :coverage => :rcov do
+    puts "coverage/index.html contains what you need"
+  end
+
+  Rcov::RcovTask.new do |t|
+    t.libs << 'lib'
+    t.test_files = FileList['test/tc_*.rb']
+  end
+rescue LoadError
+  begin
+    require 'simplecov'
+  rescue LoadError
+    $stderr.puts "neither rcov nor simplecov are installed; you won't be able to check code coverage"
+  end
+end
+
+desc 'Publish rdoc on github pages and push to github'
+task :publish_rdoc => [:rdoc,:publish]
+
+task :default => [:test,:features]
+

data/bin/gli

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'gli/commands/scaffold'
+
+include GLI::App
+
+program_desc 'create scaffolding for a GLI-powered application'
+
+version GLI::VERSION
+
+switch :v, :desc => 'Be verbose'
+
+switch :n, :desc => 'Dry run; don''t change the disk'
+
+desc 'Root dir of project'
+long_desc <<EOS
+This is the directory where the project''s directory will be made, so if you 
+specify a project name ''foo'' and the root dir of ''.'', the directory 
+''./foo'' will be created'
+EOS
+
+flag :r,:root, :default_value => '.'
+
+desc 'Create a new GLI-based project'
+long_desc <<EOS
+This will create a scaffold command line project that uses GLI
+for command line processing.  Specifically, this will create
+an executable ready to go, as well as a lib and test directory, all
+inside the directory named for your project
+EOS
+arg_name 'project_name [command[ command]*]'
+command [:init,:scaffold] do |c|
+
+  c.switch :e,:ext, :desc => 'Create an ext dir'
+
+  c.switch :notest, :desc => 'Do not create a test or features dir', :negatable => false
+
+  c.switch :force, :desc => 'Overwrite/ignore existing files and directories'
+
+  c.switch :rvmrc, :desc => 'Create an .rvmrc based on your current RVM setup'
+
+  c.action do |g,o,args|
+    if args.length < 1
+      raise 'You must specify the name of your project'
+    end
+    GLI::Commands::Scaffold.create_scaffold(g[:r],!o[:notest],o[:e],args[0],args[1..-1],o[:force],g[:n],o[:rvmrc])
+  end
+end
+
+pre do |global,command,options,args|
+  puts "Executing #{command.name}" if global[:v]
+  true
+end
+
+post do |global,command,options,args|
+  puts "Executed #{command.name}" if global[:v]
+end
+exit run(ARGV)

data/bin/report_on_rake_results

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'yaml'
+require 'rainbow'
+
+results = YAML::load(STDIN)
+success = results["successes"] || []
+errors = results["errors"] || []
+success.each { |ruby| puts ruby.color(:green) }
+errors.each { |ruby| puts ruby.color(:red) }
+exit -1 unless errors.empty?

data/bin/test_all_rubies.sh

@@ -0,0 +1,6 @@
+echo tests
+rvm 1.9.2@gli-dev,1.9.3@gli-dev,1.8.7@gli-dev,jruby@gli-dev,rbx@gli-dev,ree@gli-dev --yaml rake test | bin/report_on_rake_results
+rake clobber > /dev/null 2>&1
+echo features
+rvm 1.9.2@gli-dev,1.9.3@gli-dev,1.8.7@gli-dev,jruby@gli-dev,rbx@gli-dev,ree@gli-dev --yaml rake features | bin/report_on_rake_results
+rake clobber > /dev/null 2>&1

data/features/gli_executable.feature

@@ -0,0 +1,90 @@
+Feature: The GLI executable works as intended
+  As a developer who wants to make a GLI-powered command-line app
+  When I use the app provided by GLI
+  I get a reasonably working application
+
+  Background:
+    Given I have GLI installed
+      And my terminal size is "80x24"
+
+  Scenario Outline: Getting Help for GLI
+    When I run `gli <command>`
+    Then the exit status should be 0
+     And the output should contain:
+    """
+    NAME
+        gli - create scaffolding for a GLI-powered application
+
+    SYNOPSIS
+        gli [global options] command [command options] [arguments...]
+
+    VERSION
+    """
+     And the output should contain:
+    """
+    GLOBAL OPTIONS
+        --help         - Show this message
+        -n             - Dry run; dont change the disk
+        -r, --root=arg - Root dir of project (default: .)
+        -v             - Be verbose
+        --version      - Display the program version
+
+    COMMANDS
+        help           - Shows a list of commands or help for one command
+        init, scaffold - Create a new GLI-based project
+    """
+
+    Examples:
+    |command|
+    |       |
+    |help   |
+
+
+  Scenario Outline: Getting help on scaffolding
+    When I run `gli help <command>`
+    Then the exit status should be 0
+     And the output should contain:
+    """
+    NAME
+        init - Create a new GLI-based project
+
+    SYNOPSIS
+        gli [global options] init [command options] project_name [command[ command]*]
+
+    DESCRIPTION
+        This will create a scaffold command line project that uses GLI for command
+        line processing. Specifically, this will create an executable ready to go,
+        as well as a lib and test directory, all inside the directory named for your
+        project 
+
+    COMMAND OPTIONS
+        -e, --[no-]ext - Create an ext dir
+        --[no-]force   - Overwrite/ignore existing files and directories
+        --notest       - Do not create a test or features dir
+    """
+
+    Examples:
+      |command  |
+      |init     |
+      |scaffold |
+
+
+  Scenario: GLI correctly identifies non-existent command
+    When I run `gli foobar`
+    Then the exit status should not be 0
+     And the stderr should contain "error: Unknown command 'foobar'"
+
+  Scenario: GLI correctly identifies non-existent global flag
+    When I run `gli -q help`
+    Then the exit status should not be 0
+     And the stderr should contain "error: Unknown option -q"
+
+  Scenario: GLI correctly identifies non-existent command flag
+    When I run `gli init -q`
+    Then the exit status should not be 0
+     And the stderr should contain "error: Unknown option -q"
+
+  Scenario: The _doc command doesn't blow up
+    Given the file "gli.rdoc" doesn't exist
+    When I run `gli _doc`
+    Then a file named "gli.rdoc" should exist

data/features/gli_init.feature

@@ -0,0 +1,232 @@
+Feature: The scaffold GLI generates works
+  As a developer who wants to make a GLI-powered command-line app
+  When I generate a GLI-powered app
+  Things work out of the box
+
+  Background:
+    Given I have GLI installed
+      And GLI's libs are in my path
+      And my terminal size is "80x24"
+
+  Scenario: Scaffold generates and things look good
+    When I run `gli init --rvmrc todo add complete list`
+    Then the exit status should be 0
+     And the output should contain exactly:
+    """
+    Creating dir ./todo/lib...
+    Creating dir ./todo/bin...
+    Creating dir ./todo/test...
+    Created ./todo/bin/todo
+    Created ./todo/README.rdoc
+    Created ./todo/todo.rdoc
+    Created ./todo/todo.gemspec
+    Created ./todo/test/default_test.rb
+    Created ./todo/test/test_helper.rb
+    Created ./todo/Rakefile
+    Created ./todo/Gemfile
+    Created ./todo/features
+    Created ./todo/lib/todo/version.rb
+    Created ./todo/lib/todo.rb
+    Created ./todo/.rvmrc
+
+    """
+     And the following directories should exist:
+       |todo      |
+       |todo/bin  |
+       |todo/test |
+       |todo/lib  |
+     And the following files should exist:
+       |todo/bin/todo              |
+       |todo/README.rdoc           |
+       |todo/todo.rdoc             |
+       |todo/todo.gemspec          |
+       |todo/test/default_test.rb  |
+       |todo/test/test_helper.rb   |
+       |todo/Rakefile              |
+       |todo/Gemfile               |
+       |todo/lib/todo/version.rb   |
+       |todo/lib/todo.rb           |
+       |todo/.rvmrc                |
+    When I cd to "todo"
+     And I make sure todo's lib dir is in my lib path
+     And I run `bin/todo`
+    Then the output should contain:
+    """
+    NAME
+        todo - Describe your application here
+
+    SYNOPSIS
+        todo [global options] command [command options] [arguments...]
+    
+    VERSION
+        0.0.1
+    
+    GLOBAL OPTIONS
+        -f, --flagname=The name of the argument - Describe some flag here (default:
+                                                  the default)
+        --help                                  - Show this message
+        -s, --[no-]switch                       - Describe some switch here
+        --version                               - Display the program version
+    
+    COMMANDS
+        add      - Describe add here
+        complete - Describe complete here
+        help     - Shows a list of commands or help for one command
+        list     - Describe list here
+
+    """
+     And I run `bin/todo --help`
+    Then the output should contain:
+    """
+    NAME
+        todo - Describe your application here
+
+    SYNOPSIS
+        todo [global options] command [command options] [arguments...]
+    
+    VERSION
+        0.0.1
+    
+    GLOBAL OPTIONS
+        -f, --flagname=The name of the argument - Describe some flag here (default:
+                                                  the default)
+        --help                                  - Show this message
+        -s, --[no-]switch                       - Describe some switch here
+        --version                               - Display the program version
+    
+    COMMANDS
+        add      - Describe add here
+        complete - Describe complete here
+        help     - Shows a list of commands or help for one command
+        list     - Describe list here
+
+    """
+    When I run `bin/todo help add`
+    Then the output should contain:
+    """
+    NAME
+        add - Describe add here
+    """
+    And the output should contain:
+    """
+    SYNOPSIS
+        todo [global options] add [command options] Describe arguments to add here
+    """
+    And the output should contain:
+    """
+    COMMAND OPTIONS
+        -f arg - Describe a flag to add (default: default)
+        -s     - Describe a switch to add
+    """
+    When I run `rake test`
+    Then the output should contain:
+    """
+    .
+    """
+    And the output should contain:
+    """
+
+    1 tests, 1 assertions, 0 failures, 0 errors
+    """
+    Given todo's libs are no longer in my load path
+    When I run `rake features`
+    Then the output should contain:
+    """
+    1 scenario (1 passed)
+    """
+    And the output should contain:
+    """
+    2 steps (2 passed)
+    """
+
+  Scenario Outline: Scaffold generates and respects flags to create ext dir and avoid test dir
+    When I run `<command>`
+    Then the exit status should be 0
+     And the output should contain exactly:
+    """
+    Creating dir ./todo/lib...
+    Creating dir ./todo/bin...
+    Creating dir ./todo/ext...
+    Created ./todo/bin/todo
+    Created ./todo/README.rdoc
+    Created ./todo/todo.rdoc
+    Created ./todo/todo.gemspec
+    Created ./todo/Rakefile
+    Created ./todo/Gemfile
+    Created ./todo/lib/todo/version.rb
+    Created ./todo/lib/todo.rb
+
+    """
+     And the following directories should exist:
+       |todo      |
+       |todo/bin  |
+       |todo/ext  |
+       |todo/lib  |
+     And the following directories should not exist:
+       |todo/test|
+     And the following files should exist:
+       |todo/bin/todo            |
+       |todo/README.rdoc         |
+       |todo/todo.rdoc           |
+       |todo/todo.gemspec        |
+       |todo/Rakefile            |
+       |todo/Gemfile             |
+       |todo/lib/todo/version.rb |
+       |todo/lib/todo.rb         |
+
+        Examples:
+            | command                                     |
+            | gli init -e --notest todo add complete list |
+            | gli init todo add complete list -e --notest |
+
+  Scenario: Running commands the normal way
+    Given I successfully run `gli init todo add complete compute list`
+      And I cd to "todo"
+      And I make sure todo's lib dir is in my lib path
+     When I successfully run `bin/todo add`
+     Then the output should contain "add command ran"
+     When I successfully run `bin/todo complete`
+     Then the output should contain "complete command ran"
+     When I run `bin/todo foobar`
+     Then the stderr should contain "error: Unknown command 'foobar'"
+      And the exit status should not be 0
+     
+  Scenario: Running commands using short form
+    Given I successfully run `gli init todo add complete compute list`
+      And I cd to "todo"
+      And I make sure todo's lib dir is in my lib path
+     When I successfully run `bin/todo a`
+     Then the output should contain "add command ran"
+     When I successfully run `bin/todo l`
+     Then the output should contain "list command ran"
+     When I successfully run `bin/todo compl`
+     Then the output should contain "complete command ran"
+     
+  Scenario: Ambiguous commands give helpful output
+    Given I successfully run `gli init todo add complete compute list`
+      And I cd to "todo"
+      And I make sure todo's lib dir is in my lib path
+     When I run `bin/todo comp`
+     Then the stderr should contain "Ambiguous command 'comp'. It matches complete,compute"
+     And the exit status should not be 0
+     
+  Scenario: Running generated command without bundler gives a helpful error message
+    Given I successfully run `gli init todo add complete compute list`
+      And I cd to "todo"
+     When I run `bin/todo comp`
+     Then the exit status should not be 0
+     Then the stderr should contain "In development, you need to use `bundle exec bin/todo` to run your app"
+     And the stderr should contain "At install-time, RubyGems will make sure lib, etc. are in the load path"
+     And the stderr should contain "Feel free to remove this message from bin/todo now"
+     
+  Scenario: Running commands with a dash in the name
+    Given I successfully run `gli init todo-app add complete compute list`
+      And I cd to "todo-app"
+      And I make sure todo's lib dir is in my lib path
+     When I successfully run `bin/todo-app add`
+     Then the output should contain "add command ran"
+     When I successfully run `bin/todo-app complete`
+     Then the output should contain "complete command ran"
+     When I run `bin/todo-app foobar`
+     Then the stderr should contain "error: Unknown command 'foobar'"
+      And the exit status should not be 0