brightbox-cli 0.13.0

data/lib/brightbox-cli/vendor/gli/features/gli_init.feature

@@ -0,0 +1,122 @@
+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 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/tc_nothing.rb
+    Created ./todo/Rakefile
+    Created ./todo/Gemfile
+    Created ./todo/lib/todo_version.rb
+
+    """
+     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/tc_nothing.rb  |
+       |todo/Rakefile            |
+       |todo/Gemfile             |
+       |todo/lib/todo_version.rb |
+    When I cd to "todo"
+     And I run `bin/todo`
+    Then the output should contain:
+    """
+    usage: todo [global options] command [command options]
+    
+    Version: 0.0.1
+    
+    Global Options:
+        -f, --flagname=The name of the argument - Describe some flag here (default: 
+                                                  the default)
+        -s, --switch                            - Describe some switch here
+    
+    Commands:
+        add      - Describe add here
+        complete - Describe complete here
+        help     - Shows list of commands or help for one command
+        list     - Describe list here
+
+    """
+    When I run `bin/todo help add`
+    Then the output should contain:
+    """
+    add [command options] Describe arguments to add here
+        Describe add here
+
+    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:
+    """
+    Started
+    .
+    """
+    And the output should contain:
+    """
+
+    1 tests, 1 assertions, 0 failures, 0 errors
+    """
+    When I run `bin/todo rdoc`
+    Then the file "todo.rdoc" should contain "todo [global options] command_name [command-specific options] [--] arguments..."
+     And the file "todo.rdoc" should contain "[<tt>add</tt>] Describe add here"
+     And the file "todo.rdoc" should contain "[<tt>complete</tt>] Describe complete here"
+     And the file "todo.rdoc" should contain "[<tt>list</tt>] Describe list here"
+
+      @debug
+  Scenario: Scaffold generates and respects flags to create ext dir and avoid test dir
+    When I run `gli init -e --notest 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/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
+
+    """
+     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 |

data/lib/brightbox-cli/vendor/gli/features/step_definitions/gli_executable_steps.rb

@@ -0,0 +1,12 @@
+Given /^I have GLI installed$/ do
+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/lib/brightbox-cli/vendor/gli/features/step_definitions/gli_init_steps.rb

@@ -0,0 +1,4 @@
+Given /^GLI's libs are in my path$/ do
+  ENV['RUBYLIB'] = GLI_LIB_PATH
+end
+

data/lib/brightbox-cli/vendor/gli/features/support/env.rb

@@ -0,0 +1,21 @@
+require 'aruba/cucumber'
+require 'fileutils'
+
+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]
+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
+end

data/lib/brightbox-cli/vendor/gli/gli.cheat

@@ -0,0 +1,80 @@
+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
+  # Access in code via global_options[:n]
+
+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]
+  # Both -c and --conf work, if this flag is omitted
+  # then the default of ~/.glirc is avaialble to the code
+  # Access in code via global_options[:c] (or :conf)
+
+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/lib/brightbox-cli/vendor/gli/gli.gemspec

@@ -0,0 +1,46 @@
+# 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 = %w(
+lib/gli/command.rb
+lib/gli/command_line_token.rb
+lib/gli/copy_options_to_aliases.rb
+lib/gli/flag.rb
+lib/gli/switch.rb
+lib/gli/options.rb
+lib/gli/exceptions.rb
+lib/gli/terminal.rb
+lib/gli.rb
+lib/gli_version.rb
+lib/support/help.rb
+lib/support/rdoc.rb
+lib/support/scaffold.rb
+lib/support/initconfig.rb
+bin/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' << '-R'
+  s.bindir = 'bin'
+  s.executables << 'gli'
+  s.rubyforge_project = 'gli'
+  s.add_development_dependency('rake', '~> 0.8.0')
+  s.add_development_dependency('rdoc', '~> 2.4.0')
+  s.add_development_dependency('sdoc', '~> 0.2.0')
+  s.add_development_dependency('reek', '~> 1.2.0')
+  s.add_development_dependency('roodi', '~> 2.1.0')
+  s.add_development_dependency('grancher', '~> 0.1.5')
+  s.add_development_dependency('rainbow', '~> 1.1.1')
+  s.add_development_dependency('aruba', '~> 0.3.6')
+end
+

data/lib/brightbox-cli/vendor/gli/gli.rdoc

@@ -0,0 +1,51 @@
+= <tt>gli</tt>
+
+gli allows you to create the scaffolding for a GLI-powered application
+    gli [global options] command_name [command-specific options] [--] arguments...
+
+* Use the command +help+ to get a summary of commands
+* Use the command <tt>help command_name</tt> to get a help for +command_name+
+* Use <tt>--</tt> to stop command line argument processing; useful if your arguments have dashes in them
+
+== Global Options
+These options are available for any command and are specified before the name of the command
+
+[<tt>-n</tt>] Dry run; dont change the disk
+[<tt>-r, --root=arg</tt>] Root dir of project <i>( default: <tt>.</tt>)</i>
+
+                          This is the directory where the projects directory will be made, so if you specify a project name foo and the root dir of ., the directory ./foo will be created
+
+[<tt>-v</tt>] Be verbose
+== Commands
+[<tt>help</tt>] Shows list of commands or help for one command
+[<tt>init</tt>] Create a new GLI-based project
+
+=== <tt>help [command]</tt>
+
+Shows list of commands or help for one command
+
+Gets help for the application or its commands.  Can also list the commands in a way helpful to creating a bash-style completion function
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-c, --completion</tt>] List all commands one line at a time, for use with shell completion ([command] argument is partial command to match)
+=== <tt>init project_name [command[ command]*]</tt>
+
+Create a new GLI-based project
+
+*Aliases*
+* <tt><b>scaffold</b></tt>
+
+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
+
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-e, --ext</tt>] Create an ext dir
+[<tt>--force</tt>] Overwrite/ignore existing files and directories
+[<tt>--notest</tt>] Do not create a test dir

data/lib/brightbox-cli/vendor/gli/lib/gli/command.rb

@@ -0,0 +1,124 @@
+require 'gli/command_line_token.rb'
+require 'gli/copy_options_to_aliases.rb'
+
+module GLI
+  # A command to be run, in context of global flags and switches.  You are given an instance of this class
+  # to the block you use for GLI#command.  You then use the methods described here to describe the 
+  # command-specific command-line arguments, much as you use the methods in GLI to describe the global
+  # command-line interface
+  class Command < CommandLineToken
+    include CopyOptionsToAliases
+
+    # Create a new command
+    #
+    # +names+:: A String, Symbol, or Array of String or Symbol that represents the name(s) of this command.
+    # +description+:: short description of this command as a Strign
+    # +arguments_name+:: description of the arguments as a String, or nil if this command doesn't take arguments
+    # +long_desc+:: a longer description of the command, possibly with multiple lines and text formatting
+    # +skips_pre+:: if true, this command advertises that it doesn't want the pre block called first
+    # +skips_post+:: if true, this command advertises that it doesn't want the post block called after it
+    def initialize(names,description,arguments_name=nil,long_desc=nil,skips_pre=false,skips_post=false) # :nodoc:
+      super(names,description,long_desc)
+      @arguments_description = arguments_name || ''
+      @skips_pre = skips_pre
+      @skips_post = skips_post
+      clear_nexts
+    end
+
+    # Return the arguments description
+    def arguments_description #:nodoc:
+      @arguments_description
+    end
+
+    # If true, this command doesn't want the pre block run before it executes
+    def skips_pre #:nodoc:
+      @skips_pre
+    end
+
+    # If true, this command doesn't want the post block run before it executes
+    def skips_post #:nodoc:
+      @skips_post
+    end
+
+    # Return the Array of the command's names
+    def names #:nodoc:
+      all_forms
+    end
+
+    # Get the usage string
+    # CR: This should probably not be here
+    def usage #:nodoc:
+      usage = name.to_s
+      usage += ' [command options]' if !flags.empty? || !switches.empty?
+      usage += ' ' + @arguments_description if @arguments_description
+      usage
+    end
+
+    # Return the flags as a Hash
+    def flags #:nodoc:
+      @flags ||= {}
+    end
+    # Return the switches as a Hash
+    def switches #:nodoc:
+      @switches ||= {}
+    end
+
+    # describe the next switch or flag just as GLI#desc does.
+    def desc(description); @next_desc = description; end
+    # set the long description of this flag/switch, just as GLI#long_desc does.
+    def long_desc(long_desc); @next_long_desc = long_desc; end
+    # describe the argument name of the next flag, just as GLI#arg_name does.
+    def arg_name(name); @next_arg_name = name; end
+    # set the default value of the next flag, just as GLI#default_value does.
+    def default_value(val); @next_default_value = val; end
+
+    # Create a command-specific flag, similar to GLI#flag
+    def flag(*names)
+      names = [names].flatten
+      GLI.verify_unused(names,flags,switches,"in command #{name}")
+      flag = Flag.new(names,@next_desc,@next_arg_name,@next_default_value,@next_long_desc)
+      flags[flag.name] = flag
+      clear_nexts
+    end
+
+    # Create a command-specific switch, similar to GLI#switch
+    def switch(*names)
+      names = [names].flatten
+      GLI.verify_unused(names,flags,switches,"in command #{name}")
+      switch = Switch.new(names,@next_desc,@next_long_desc)
+      switches[switch.name] = switch
+      clear_nexts
+    end
+
+    # Define the action to take when the user executes this command
+    #
+    # +block+:: A block of code to execute.  The block will be given 3 arguments:
+    #           +global_options+:: A Hash (or Options, see GLI#use_openstruct) of the _global_ options specified
+    #                              by the user, with defaults set and config file values used (if using a config file, see
+    #                              GLI#config_file)
+    #           +options+:: A Hash (or Options, see GLI#use_openstruct) of the command-specific options specified by the 
+    #                       user, with defaults set and config file values used (if using a config file, see GLI#config_file)
+    #           +arguments+:: An Array of Strings representing the unparsed command line arguments
+    #           The block's result value is not used; raise an exception or use GLI#exit_now! if you need an early exit based
+    #           on an error condition
+    def action(&block)
+      @action = block
+    end
+
+    def self.name_as_string(name) #:nodoc:
+      name.to_s
+    end
+
+    def clear_nexts #:nodoc:
+      @next_desc = nil
+      @next_arg_name = nil
+      @next_default_value = nil
+      @next_long_desc = nil
+    end
+
+    # Executes the command
+    def execute(global_options,options,arguments) #:nodoc:
+      @action.call(global_options,options,arguments)
+    end
+  end
+end

data/lib/brightbox-cli/vendor/gli/lib/gli/command_line_token.rb

@@ -0,0 +1,58 @@
+module GLI
+  # Abstract base class for a logical element of a command line, mostly so that subclasses can have similar
+  # initialization and interface
+  class CommandLineToken
+    attr_reader :name #:ndoc:
+    attr_reader :aliases #:ndoc:
+    attr_reader :description #:ndoc:
+    attr_reader :long_description #:ndoc:
+
+    def initialize(names,description,long_description=nil) #:ndoc:
+      @description = description
+      @long_description = long_description
+      @name,@aliases,@names = parse_names(names)
+    end
+
+    def usage #:nodoc:
+      all_forms
+    end
+
+    # Sort based on name
+    def <=>(other)
+      self.name.to_s <=> other.name.to_s
+    end
+
+    private
+    # Returns a string of all possible forms
+    # of this flag.  Mostly intended for printing
+    # to the user.
+    def all_forms(joiner=', ')
+      forms = all_forms_a
+      forms.join(joiner)
+    end
+
+
+    # Handles dealing with the "names" param, parsing
+    # it into the primary name and aliases list
+    def parse_names(names)
+      # Allow strings; convert to symbols
+      names = [names].flatten.map { |name| name.to_sym } 
+      names_hash = Hash.new
+      names.each do |name| 
+        raise ArgumentError.new("#{name} has spaces; they are not allowed") if name.to_s =~ /\s/
+        names_hash[self.class.name_as_string(name)] = true
+      end
+      name = names.shift
+      aliases = names.length > 0 ? names : nil
+      [name,aliases,names_hash]
+    end
+
+    def all_forms_a
+      forms = [self.class.name_as_string(name)]
+      if aliases
+        forms |= aliases.collect { |one_alias| self.class.name_as_string(one_alias) }.sort { |one,two| two.length <=> one.length }
+      end
+      forms
+    end
+  end
+end

data/lib/brightbox-cli/vendor/gli/lib/gli/copy_options_to_aliases.rb

@@ -0,0 +1,33 @@
+module GLI
+
+  # Mixin that both GLI and Command can use to copy command-line options to the aliased versions
+  # of flags and switches
+  #
+  # includers must provide the methods +flags+ and +switches+ that return an Array of Flag or Switch, 
+  # respectively
+  module CopyOptionsToAliases # :nodoc:
+    # For each option in options, copies its value to keys for the aliases of the flags or
+    # switches in gli_like
+    #
+    # options - Hash of options parsed from command line; this is an I/O param
+    def copy_options_to_aliases(options) # :nodoc:
+      new_options = {}
+      options.each do |key,value|
+        if flags[key] && flags[key].aliases
+          copy_aliases(flags[key].aliases,new_options,value)
+        elsif switches[key] && switches[key].aliases
+          copy_aliases(switches[key].aliases,new_options,value)
+        end
+      end
+      options.merge!(new_options)
+    end
+
+    private 
+
+    def copy_aliases(aliases,new_options,value)
+      aliases.each do |alias_name|
+        new_options[alias_name] = value
+      end
+    end
+  end
+end

data/lib/brightbox-cli/vendor/gli/lib/gli/exceptions.rb

@@ -0,0 +1,45 @@
+module GLI
+  # Indicates that the command line invocation was bad
+  class BadCommandLine < Exception
+    def exit_code; -1; end
+  end
+
+  # Indicates the bad command line was an unknown command
+  class UnknownCommand < BadCommandLine
+  end
+
+  # Indicates the bad command line was an unknown global argument
+  class UnknownGlobalArgument < BadCommandLine
+  end
+
+  # Indicates the bad command line was an unknown command argument
+  class UnknownCommandArgument < BadCommandLine
+    attr_reader :command
+    # +message+:: the error message to show the user
+    # +command+:: the command we were using to parse command-specific options
+    def initialize(message,command)
+      super(message)
+      @command = command
+    end
+  end
+
+  # Raise this if you want to use an exit status that isn't the default
+  # provided by GLI.  Note that GLI#exit_now! might be a bit more to your liking.
+  #
+  # Example:
+  #
+  #     raise CustomExit.new("Not connected to DB",-5) unless connected?
+  #     raise CustomExit.new("Bad SQL",-6) unless valid_sql?(args[0])
+  #
+  class CustomExit < Exception
+    attr_reader :exit_code #:nodoc:
+    # Create a custom exit exception
+    #
+    # +message+:: String containing error message to show the user
+    # +exit_code+:: the exit code to use (as an Int), overridding GLI's default
+    def initialize(message,exit_code)
+      super(message)
+      @exit_code = exit_code
+    end
+  end
+end

data/lib/brightbox-cli/vendor/gli/lib/gli/flag.rb

@@ -0,0 +1,67 @@
+require 'gli/command_line_token.rb'
+require 'gli/switch.rb'
+
+module GLI
+  # Defines a flag, which is to say a switch that takes an argument
+  class Flag < Switch # :nodoc:
+
+    attr_accessor :default_value
+
+    def initialize(names,description,argument_name=nil,default=nil,long_desc=nil)
+      super(names,description,long_desc)
+      @argument_name = argument_name || "arg"
+      @default_value = default
+    end
+
+    def get_value!(args)
+      args.each_index() do |index|
+        arg = args[index]
+        present,matched,value = find_me(arg)
+        if present
+          args.delete_at index
+          if !value || value == ''
+            if args[index]
+              value = args[index]
+              args.delete_at index
+              return value
+            else
+              raise BadCommandLine.new("#{matched} requires an argument")
+            end
+          else
+            return value
+          end
+        end
+      end
+      return @default_value
+    end
+
+    def find_me(arg)
+      if @names[arg]
+        return [true,arg,nil] if arg.length == 2
+        # This means we matched the long-form, but there's no argument
+        raise BadCommandLine.new("#{arg} requires an argument via #{arg}=argument")
+      end
+      @names.keys.each() do |name|
+        match_string = "^#{name}=(.*)$"
+        match_data = arg.match(match_string)
+        return [true,name,$1] if match_data;
+      end
+      [false,nil,nil]
+    end
+
+    # Returns a string of all possible forms
+    # of this flag.  Mostly intended for printing
+    # to the user.
+    def all_forms(joiner=', ')
+      forms = all_forms_a
+      string = forms.join(joiner)
+      if forms[-1] =~ /^\-\-/
+        string += '='
+      else
+        string += ' '
+      end
+      string += @argument_name
+      return string
+    end
+  end
+end

data/lib/brightbox-cli/vendor/gli/lib/gli/options.rb

@@ -0,0 +1,19 @@
+require 'ostruct'
+
+module GLI
+  # Subclass of OpenStruct that provides hash-like methods for #[] and #[]=.  Note that is is *not* a Hash.
+  class Options < OpenStruct
+
+    # Return the value of an attribute
+    def[](k)
+      @table[k.to_sym]
+    end
+
+    # Set the value of an attribute
+    def[]=(k, v)
+      @table[k.to_sym] = v
+    end
+
+  end
+end
+