choice 0.1.7 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzIxY2UxYzVhYWQ3M2MyMmJjMTU4OTRkNTA5MmM5N2I2YWI3OTk0YQ==
-  data.tar.gz: !binary |-
-    M2I0MjZhZjM5MTY5YjFlZTJlNmY4NTQxN2U1MzQ1YmJiNmZjNDA2NA==
+SHA1:
+  metadata.gz: 15f0c2eb270e5a078a4073be95b3bee511cddfbe
+  data.tar.gz: e31ced92d8f6b1cff0ae20b9edd151852d408412
 SHA512:
-  metadata.gz: !binary |-
-    YzY2YzlmOGNlNTBkOTFjOWEzMzY3Y2QwN2Q2MjVmMTliNWE5ZDY5ZTdjYWZj
-    YjcwMDJkMjlhZDA5NzNiYjBkYTgwMGI5MWVmYWYyNTM4Nzg5OWNhNmQyNTlk
-    NzVhZDRiZGQ3NDQxY2U1YjNhYzllN2I0MWUxMzdkMjQ5YjM2YWU=
-  data.tar.gz: !binary |-
-    NWFlMzYyMGM0OWUzMWZjMTc1NTU1MjMyZGQ1ZDQxM2NlOGQ4OWE2MzViNzhh
-    ZWNjYjY1NWViZWY3MzVjNGE0NGUyZjljN2U5YjI2NmRkYjUzMTE1MjFhNjYy
-    MWUwMzhhNzI0YTgwNDM0ODYxODUzOGUyMjRlYzc1M2VmMTgwYzI=
+  metadata.gz: 16a9248efc0788034bda81cfccaee80b155b5cae18e31ace243e8f0488c7a8170c232c95f961c330aa9ee40215717e149bcfc5fbcf79e8520002d81e7328332d
+  data.tar.gz: 60f97f4404904fedd8b254cf9a148e7fe401b4d9729c6a40cd12748d3eef5b410443c696d509afe3e1929b3e968bbc475379c00872050ec7e84ae7ba7d918078

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -2,6 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
   - rbx-2
   - jruby

data/CHANGELOG

@@ -1,3 +1,5 @@
+0.2.0:
+  - Removed some version specific hacks. Including 1.8.6 support.
 0.1.7:
   - Fix bug related to NilClass#to_h
   - Simplified packaging process: Now possible to package with an up-to-date system.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.rdoc

@@ -1,12 +1,14 @@
+{<img src="https://travis-ci.org/defunkt/choice.svg?branch=master" />}[https://travis-ci.org/defunkt/choice]
+
 = Welcome to Choice
 
-Choice is a small library for defining and parsing command line options.  It 
-works awesomely with Highline[https://github.com/JEG2/highline] or other command 
+Choice is a small library for defining and parsing command line options.  It
+works awesomely with Highline[https://github.com/JEG2/highline] or other command
 line interface libraries.
 
-Choice was written by Chris Wanstrath as an exercise in test driving development 
-of a DSL.  This project is still an infant: bugs are expected and tattling on them 
-is appreciated.  
+Choice was written by Chris Wanstrath as an exercise in test driving development
+of a DSL.  This project is still an infant: bugs are expected and tattling on them
+is appreciated.
 
 Installing is easy, with RubyGems.  Give it a shot:
  $ gem install choice
@@ -14,7 +16,7 @@ Installing is easy, with RubyGems.  Give it a shot:
 E-mail inquiries can be directed to mailto:chris[at]ozmm[dot]org.
 
 Of course, Choice is licensed under the MIT License, which you can find included
-in the LICENSE file or by surfing your World Wide Web browser of choice towards 
+in the LICENSE file or by surfing your World Wide Web browser of choice towards
 http://www.opensource.org/licenses/mit-license.php.
 
 == Using Choice
@@ -31,7 +33,7 @@ programs utilizing the library have been placed.  Here's a snippet:
   Choice.options do
     header ''
     header 'Specific options:'
-  
+
     option :host do
       short '-h'
       long '--host=HOST'
@@ -46,7 +48,7 @@ programs utilizing the library have been placed.  Here's a snippet:
       cast Integer
       default 21
     end
-  
+
     separator ''
     separator 'Common options: '
 
@@ -61,42 +63,42 @@ programs utilizing the library have been placed.  Here's a snippet:
       desc 'Show version'
       action do
         puts "ftpd.rb FTP server v#{PROGRAM_VERSION}"
-        exit      
+        exit
       end
     end
   end
 
   puts 'port: ' + Choice[:port]
 
-Notice the last line.  For free, you will be given a <tt>Choice.choices</tt> 
-hash which contain, at runtime, the options found and their values. 
+Notice the last line.  For free, you will be given a <tt>Choice.choices</tt>
+hash which contain, at runtime, the options found and their values.
 
 <tt>Choice[:key]</tt> is a shortcut for <tt>Choice.choices[:key]</tt>.
 
-Because we gave option <tt>:port</tt> a default of 21, 
-<tt>Choice[:port]</tt> should be 21 if we run ftpd.rb with no options.  
+Because we gave option <tt>:port</tt> a default of 21,
+<tt>Choice[:port]</tt> should be 21 if we run ftpd.rb with no options.
 Let's see.
 
  $ ruby ftpd.rb
  port: 21
- 
+
 Cool.  On our system, port 21 is reserved.  Let's use another port.
 
  $ ruby ftpd.rb -p 2100
  port: 2100
- 
+
 Alright.  And, of course, there is the hard way of doing things.
 
  $ ruby ftpd.rb --port=2100
  port: 2100
 
-That <tt>:version</tt> option looks pretty interesting, huh?  I wonder what it 
+That <tt>:version</tt> option looks pretty interesting, huh?  I wonder what it
 does...
- 
+
   $ ruby ftpd.rb -v
   ftpd.rb FTP server v4
 
-That's not all, though.  We also get a <tt>--help</tt> option for free.  
+That's not all, though.  We also get a <tt>--help</tt> option for free.
 
   $ ruby ftpd.rb --help
   Usage: ftpd.rb [-hpv]
@@ -105,16 +107,16 @@ That's not all, though.  We also get a <tt>--help</tt> option for free.
       -h, --host=HOST                  The hostname or ip of the host to bind to (default 127.0.0.1)
       -p, --port=PORT                  The port to listen on (default 21)
 
-  Common options: 
+  Common options:
           --help                       Show this message
       -v, --version                    Show version
-      
-      
+
+
 == The Choice.choices hash
 
-For better or worse, the <tt>Choice.choices</tt> hash is a bit lazy.  It does 
-not care how you access it.  Using the above example, assume we have a 
-<tt>:port</tt> option and we replace the last line of our program with the 
+For better or worse, the <tt>Choice.choices</tt> hash is a bit lazy.  It does
+not care how you access it.  Using the above example, assume we have a
+<tt>:port</tt> option and we replace the last line of our program with the
 following three lines:
 
   puts 'port: ' + Choice.choices[:port]
@@ -130,8 +132,8 @@ Now, run it.
 
 Lazy, huh?
 
-Keep in mind that your option's key in the <tt>Choice.choices</tt> hash is 
-defined by the first parameter passed to option statement.  This is perfectly 
+Keep in mind that your option's key in the <tt>Choice.choices</tt> hash is
+defined by the first parameter passed to option statement.  This is perfectly
 legit, albeit somewhat confusing:
 
   option :name do
@@ -140,16 +142,16 @@ legit, albeit somewhat confusing:
     desc "Your handle."
   end
 
-You can access this option by using <tt>Choice.choices[:name]</tt>, not 
+You can access this option by using <tt>Choice.choices[:name]</tt>, not
 <tt>:handle</tt>.
 
 == Option options
 
 Obviously, Choice revolves around the <tt>option</tt> statement, which receives
-a block.  Here are all the, er, options +option+ accepts.  None of them are 
+a block.  Here are all the, er, options +option+ accepts.  None of them are
 required but +short+ or +long+ must be present for Choice to know what to do.
 
-Options must be defined in the context of a <tt>Choice.options</tt> block, as 
+Options must be defined in the context of a <tt>Choice.options</tt> block, as
 seen above.  This context is assumed for the following explanations.
 
 For the quick learners, here's the list:
@@ -177,7 +179,7 @@ character.
 Defines the long switch for an option.  Expected to be a double dash followed by
 a string, an equal sign (or a space), and another string.
 
-There are two variants: longs where a parameter is required and longs where a 
+There are two variants: longs where a parameter is required and longs where a
 parameter is optional, in which case the value will be +true+ if the option is
 present.
 
@@ -191,7 +193,7 @@ we can do this:
 
   $ ruby ftpd.rb --debug
   debug: true
-  
+
   $ ruby ftpd.rb --debug=1
   debug: 1
 
@@ -205,7 +207,7 @@ Assuming the same as above:
 
   $ ruby ftpd.rb --debug 1
   debug: 1
-  
+
   $ ruby ftpd.rb --debug
   <help screen printed>
 
@@ -214,7 +216,7 @@ Assuming the same as above:
 Often you may wish to allow users the ability to pass in multiple arguments and have
 them all combined into an array.  You can accomplish this by defining a +long+ and
 setting the caps-argument to *ARG.  Like this:
-    
+
   long '--suit *SUITS'
 
 <tt>Choice.choices.suits</tt> will now return an array.  Here's an example of usage:
@@ -234,7 +236,7 @@ As with the above, assume our program prints <tt>Choice.choices[:debug]</tt>:
 
   default 'info'
 
-If we don't pass in <tt>--debug</tt>, the <tt>:debug</tt> element of our hash 
+If we don't pass in <tt>--debug</tt>, the <tt>:debug</tt> element of our hash
 will be 'info.'
 
   $ ftpd.rb
@@ -246,7 +248,7 @@ will be 'info.'
 === desc
 
 The description of this option.  Fairly straightforward, with one little trick:
-multiple +desc+ statements in a single option will be considered new desc lines.  
+multiple +desc+ statements in a single option will be considered new desc lines.
 The desc lines will be printed in the order they are defined.  Like this:
 
   desc "Your hostname."
@@ -260,8 +262,8 @@ A snippet from your <tt>--help</tt> might then look like this:
 
 === cast
 
-By default, all members of the <tt>Choice.choices</tt> hash are strings.  If 
-you want something different, like an Integer for a port number, you can use 
+By default, all members of the <tt>Choice.choices</tt> hash are strings.  If
+you want something different, like an Integer for a port number, you can use
 the +cast+ statement.
 
   cast Integer
@@ -293,7 +295,7 @@ your option's "desc" value.
 
 === validate
 
-The +validate+ statement accepts a regular expression which it will test 
+The +validate+ statement accepts a regular expression which it will test
 against the value passed.  If the test fails, the <tt>--help</tt> screen will
 be printed.  I love ports, so let's stick with that example:
 
@@ -315,8 +317,8 @@ I've told it so):
 The +filter+ statement lets you play with a value before it goes into the
 <tt>Choice.choices</tt> hash.  If you use +cast+, this will occur post-casting.
 
-In this program we're defining a :name option and saying we don't want any 
-crazy characters in it, then printing that element of the 
+In this program we're defining a :name option and saying we don't want any
+crazy characters in it, then printing that element of the
 <tt>Choice.choices</tt>+ hash:
 
   filter do |value|
@@ -328,7 +330,7 @@ Now:
   $ ruby ftpd.rb --name=c.hr.is
   name: chris
 
-You can probably think of better uses.  
+You can probably think of better uses.
 
 === action
 
@@ -337,7 +339,7 @@ is passed.  See the <tt>--version</tt> example earlier.
 
 === required options
 
-You can specify an option as being required by passing :required => true to the 
+You can specify an option as being required by passing :required => true to the
 option definition.  Choice will then print the help screen if this option is
 not present.  Please let your dear users know which options are required.
 
@@ -363,8 +365,8 @@ Passing an empty string to any of these options will print a newline.
 
 === banner
 
-The banner is the first line printed when your program is called with 
-<tt>--help</tt>.  By default, it will be something like this, based on the 
+The banner is the first line printed when your program is called with
+<tt>--help</tt>.  By default, it will be something like this, based on the
 options defined:
 
   Usage: ftpd.rb [-hpv]
@@ -384,7 +386,7 @@ are printed.  Each header call is a newline.  Check out the example above.
 === separator
 
 As in the example above, you can put separators between options to help display
-the logical groupings of your options.  Or whatever.  
+the logical groupings of your options.  Or whatever.
 
   separator "----"
 
@@ -394,14 +396,14 @@ To get a blank line, rock an empty string:
 
 === footer
 
-The footer is displayed after all your options are displayed.  Nothing new 
+The footer is displayed after all your options are displayed.  Nothing new
 here, works like the other options above.
 
   footer "That's all there is to it!"
 
 == Shorthand
 
-Now that you've gone through all the hard stuff, here's the easy stuff: Choice 
+Now that you've gone through all the hard stuff, here's the easy stuff: Choice
 options can be defined with a simple hash if you'd like.  Here's an example,
 from the tests:
 
@@ -411,7 +413,7 @@ from the tests:
      options :band => { :short => "-b", :long => "--band=BAND", :cast => String, :desc => "Your favorite band.",
                        :validate => /\w+/ },
              :animal => { :short => "-a", :long => "--animal=ANIMAL", :cast => String, :desc => "Your favorite animal." }
-     
+
      footer ""
      footer "--help This message"
    end
@@ -420,17 +422,17 @@ How's that tickle you?  Real nice.
 
 == It looks like poetry
 
-That's it.  Not much, I know.  Maybe this will make handling your command 
-line options a bit easier.  You can always use the option parser in the standard 
-Ruby library, but DSLs are just so cool.  As one of my non-programmer friends 
+That's it.  Not much, I know.  Maybe this will make handling your command
+line options a bit easier.  You can always use the option parser in the standard
+Ruby library, but DSLs are just so cool.  As one of my non-programmer friends
 said of a Ruby DSL: "It looks like poetry."
 
 == It's totally broken
 
-Okay, I knew this would happen.  Do me a favor, if you have time: run +rake+ 
-from the Choice directory and send me the output (mailto:chris[at]ozmm[dot]org).  
-This'll run the unit tests.  Also, if you would, send me a bit of information 
-on your platform.  Choice was tested on OS X and RHEL with a 2.4 kernel but who 
+Okay, I knew this would happen.  Do me a favor, if you have time: run +rake+
+from the Choice directory and send me the output (mailto:chris[at]ozmm[dot]org).
+This'll run the unit tests.  Also, if you would, send me a bit of information
+on your platform.  Choice was tested on OS X and RHEL with a 2.4 kernel but who
 knows.  Thanks a lot.
 
 == Thanks to

data/TODO

@@ -1,7 +1,3 @@
 1. Add support for defining the number of arguments an option takes.
-2. Use a static gemspec.
-3. Add a Gemfile to help with consistency in development.
-4. Simplify anything in the Rakefile that has a more common current practice.
-5. Either make everything work on 1.8.6+ or start deprecating older interpreters.
-6. Publish docs similar to how we used to pub to RubyForge
-7. Convert these to Github Issues
+2. Publish docs similar to how we used to pub to RubyForge
+3. Convert these to Github Issues

data/choice.gemspec

@@ -17,4 +17,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
 end

data/lib/choice.rb

@@ -4,16 +4,10 @@ require 'choice/parser'
 require 'choice/writer'
 require 'choice/lazyhash'
 
-if RUBY_VERSION < "1.9"
-  class Hash
-    alias_method(:key, :index) unless method_defined?(:key)
-  end
-end
-
 #
 # Usage of this module is lovingly detailed in the README file.
 #
-module Choice 
+module Choice
   extend self
 
   # The main method, which defines the options
@@ -24,7 +18,7 @@ module Choice
     # Setup all instance variables
     reset! if hash.empty?
     @@args ||= ARGV
-    
+
     # Eval the passed block to define the options.
     instance_eval(&block) if block_given?
 
@@ -36,13 +30,13 @@ module Choice
   def options_from_hash(options_hash)
     options_hash.each do |name, definition|
       option = Option.new
-      definition.each do |key, value| 
+      definition.each do |key, value|
         Array(value).each { |hit| option.send(key, hit) }
       end
       @@options << [name.to_s, option]
     end
   end
-  
+
   # Return an array representing the rest of the command line arguments
   def rest
     @@rest
@@ -75,20 +69,14 @@ module Choice
   # Define the banner, header, footer methods.  All are just getters/setters
   # of class variables.
   %w[banner header footer].each do |method|
-    define_method(method) do |string|
+    define_method(method) do |string=nil|
       variable = "@@#{method}"
       return class_variable_get(variable) if string.nil?
       val = class_variable_get(variable) || ''
       class_variable_set(variable, val << string)
     end
-
-    if RUBY_VERSION > "1.9"
-      original_method = "original_#{method}" 
-      alias_method original_method, method
-      eval "def #{method}(string=nil); #{original_method}(string); end"
-    end
   end
-  
+
   # Parse the provided args against the defined options.
   def parse #:nodoc:
     # Do nothing if options are not defined.
@@ -99,7 +87,7 @@ module Choice
       help
     else
       begin
-        # Delegate parsing to our parser class, passing it our defined 
+        # Delegate parsing to our parser class, passing it our defined
         # options and the passed arguments.
         @@choices, @@rest = Parser.parse(@@options, @@args)
         @@choices = LazyHash.new(@@choices)
@@ -109,19 +97,19 @@ module Choice
       end
     end
   end
-  
+
   # Did we already parse the arguments?
   def parsed? #:nodoc:
     @@choices ||= false
   end
-  
+
   # Print the help screen by calling our Writer object
   def help #:nodoc:
-    Writer.help( { :banner => @@banner, :header => @@header, 
-                   :options => @@options, :footer => @@footer }, 
+    Writer.help( { :banner => @@banner, :header => @@header,
+                   :options => @@options, :footer => @@footer },
                    output_to, exit_on_help? )
   end
-  
+
   # Set the args, potentially to something other than ARGV.
   def args=(args) #:nodoc:
     @@args = args.dup.map { |a| a + '' }
@@ -132,11 +120,11 @@ module Choice
   def args #:nodoc:
     @@args
   end
-  
+
   # Returns the arguments that follow an argument
   def args_of(opt)
     args_of_opt = []
-    
+
     # Return an array of the arguments between opt and the next option,
     # which all start with "-"
     @@args.slice(@@args.index(opt)+1, @@args.length).select do |arg|
@@ -148,24 +136,24 @@ module Choice
     end
     args_of_opt
   end
-  
+
   # You can choose to not kill the script after the help screen is printed.
   def dont_exit_on_help=(val) #:nodoc:
     @@exit = true
   end
-  
+
   # Do we want to exit on help?
   def exit_on_help? #:nodoc:
     @@exit rescue false
   end
-  
+
   # If we want to write to somewhere other than STDOUT.
   def output_to(target = nil) #:nodoc:
     @@output_to ||= STDOUT
     return @@output_to if target.nil?
     @@output_to = target
   end
-  
+
   # Reset all the class variables.
   def reset! #:nodoc:
     @@args    = false

data/lib/choice/version.rb

@@ -1,8 +1,8 @@
 module Choice
   module Version #:nodoc:
     MAJOR  = 0
-    MINOR  = 1
-    TINY   = 7
+    MINOR  = 2
+    TINY   = 0
     STRING = [MAJOR, MINOR, TINY] * '.'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: choice
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Grant Austin
@@ -9,8 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
-dependencies: []
+date: 2014-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Choice is a simple little gem for easily defining and parsing command
   line options with a friendly DSL.
 email:
@@ -20,8 +62,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -50,12 +94,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -70,4 +114,3 @@ test_files:
 - test/test_option.rb
 - test/test_parser.rb
 - test/test_writer.rb
-has_rdoc: