choice 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.1.2:
+  - Made validate directive accept block and validate against its boolean value.
+  - Created shorthand format for defining options directly with a hash.
+
 0.1.1:
   - Fixed test_option.rb to be self sufficient.
   - Fix so that long argument with equals sign in it will parse correctly [Justin Bailey]

data/README

@@ -5,9 +5,8 @@ works awesomely with Highline[http://highline.rubyforge.org/] or other command
 line interface libraries.
 
 Choice was written by Chris Wanstrath as an exercise in test driving development 
-of a DSL.  We hope you find it useful.  If you don't, we'd love to hear why.  
-This project is still an infant: bugs are expected and tattling on them is 
-appreciated.  
+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
@@ -400,6 +399,25 @@ 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 
+options can be defined with a simple hash if you'd like.  Here's an example,
+from the tests:
+
+   Choice.options do
+     header "Tell me about yourself?"
+     header ""
+     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
+
+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 

data/lib/choice.rb

@@ -8,122 +8,132 @@ require 'choice/lazyhash'
 # Usage of this module is lovingly detailed in the README file.
 #
 module Choice 
-  class <<self 
-    # The main method, which defines the options
-    def options(&block)
-      # Setup all instance variables
-      @@args    ||= ARGV
-      @@banner  ||= false
-      @@header  ||= Array.new
-      @@options ||= Array.new
-      @@footer  ||= Array.new
-      
-      # Eval the passed block to define the options.
-      instance_eval(&block)
+  extend self
 
-      # Parse what we've got.
-      parse unless parsed?
+  # The main method, which defines the options
+  def options(hash = {}, &block)
+    # if we are passing in a hash to define our options, use that straight
+    options_from_hash(hash) unless hash.empty?
+
+    # Setup all instance variables
+    reset! if hash.empty?
+    @@args ||= ARGV
+    
+    # Eval the passed block to define the options.
+    instance_eval(&block) if block_given?
+
+    # Parse what we've got.
+    parse unless parsed?
+  end
+
+  # Set options from a hash, shorthand style
+  def options_from_hash(options_hash)
+    options_hash.each do |name, definition|
+      option = Option.new
+      definition.each do |key, value| 
+        Array(value).each { |hit| option.send(key, hit) }
+      end
+      @@options << [name.to_s, option]
     end
+  end
+
+  # Returns a hash representing options passed in via the command line.
+  def choices
+    @@choices
+  end
+
+  # Defines an option.
+  def option(opt, options = {}, &block)
+    # Notice: options is maintained as an array of arrays, the first element
+    # the option name and the second the option object.
+    @@options << [opt.to_s, Option.new(options, &block)]
+  end
   
-    # Returns a hash representing options passed in via the command line.
-    def choices
-      @@choices
-    end
+  # Separators are text displayed by --help within the options block.
+  def separator(str)
+    # We store separators as simple strings in the options array to maintain 
+    # order.  They are ignored by the parser.
+    @@options << str
+  end
   
-    # Defines an option.
-    def option(opt, options = {}, &block)
-      # Notice: options is maintained as an array of arrays, the first element
-      # the option name and the second the option object.
-      @@options << [opt.to_s, Option.new(options, &block)]
-    end
-    
-    # Separators are text displayed by --help within the options block.
-    def separator(str)
-      # We store separators as simple strings in the options array to maintain 
-      # order.  They are ignored by the parser.
-      @@options << str
-    end
-    
-    # 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|
-        variable = "@@#{method}"
-        return class_variable_get(variable) if string.nil?
-        val = class_variable_get(variable) || ''
-        class_variable_set(variable, val << string)
-      end
+  # 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|
+      variable = "@@#{method}"
+      return class_variable_get(variable) if string.nil?
+      val = class_variable_get(variable) || ''
+      class_variable_set(variable, val << string)
     end
+  end
 
-    
-    # Parse the provided args against the defined options.
-    def parse #:nodoc:
-      # Do nothing if options are not defined.
-      return unless @@options.size > 0
+  
+  # Parse the provided args against the defined options.
+  def parse #:nodoc:
+    # Do nothing if options are not defined.
+    return unless @@options.size > 0
 
-      # Show help if it's anywhere in the argument list.
-      if @@args.include?('--help')
-        self.help
-      else
-        begin
-          # Delegate parsing to our parser class, passing it our defined 
-          # options and the passed arguments.
-          @@choices = LazyHash.new(Parser.parse(@@options, @@args))
-        rescue Choice::Parser::ParseError
-          # If we get an expected exception, show the help file.
-          self.help
-        end
+    # Show help if it's anywhere in the argument list.
+    if @@args.include?('--help')
+      help
+    else
+      begin
+        # Delegate parsing to our parser class, passing it our defined 
+        # options and the passed arguments.
+        @@choices = LazyHash.new(Parser.parse(@@options, @@args))
+      rescue Choice::Parser::ParseError
+        # If we get an expected exception, show the help file.
+        help
       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 }, 
-                     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 + '' }
-      parse if parsed?
-    end
+  end
   
-    # Return the args.
-    def args #:nodoc:
-      @@args
-    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
-      @@banner  = false
-      @@header  = Array.new
-      @@options = Array.new
-      @@footer  = Array.new
-    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 }, 
+                   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 + '' }
+    parse if parsed?
+  end
+
+  # Return the args.
+  def args #:nodoc:
+    @@args
+  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
+    @@banner  = false
+    @@header  = Array.new
+    @@options = Array.new
+    @@footer  = Array.new
+  end
 end

data/lib/choice/option.rb

@@ -17,7 +17,7 @@ module Choice
       @choices = []      
 
       # If we got a block, eval it and set everything up.
-      self.instance_eval(&block) if block_given?      
+      instance_eval(&block) if block_given?      
 
       # Is this option required?
       @required = options[:required] || false
@@ -28,17 +28,16 @@ module Choice
     # It also gives us choice? methods.
     def method_missing(method, *args, &block)
       # Get the name of the choice we want, as a class variable string.
-      var = "@#{method.to_s.sub(/\?/,'')}"
+      var = "@#{method.to_s.sub('?','')}"
 
       # To string, for regex purposes.
       method = method.to_s
       
       # Don't let in any choices not defined in our white list array.
-      raise ParseError, "I don't know '#{method}'" unless CHOICES.include? method.sub(/\?/,'')
+      raise ParseError, "I don't know `#{method}'" unless CHOICES.include? method.sub('?','')
       
       # If we're asking a question, give an answer.  Like 'short?'.
-      return true if method =~ /\?/ && instance_variable_get(var)
-      return false if method =~ /\?/
+      return !!instance_variable_get(var) if method =~ /\?/ 
       
       # If we were called with no arguments, we want a get.
       return instance_variable_get(var) unless args[0] || block_given?
@@ -66,27 +65,22 @@ module Choice
     end
     
     # Simple, desc question method.
-    def desc?
-      return false if @desc.nil?
-      true
-    end
+    def desc?() !!@desc end
 
     # Returns Option converted to an array.
     def to_a
-      array = []
-      @choices.each do |choice|
-        array << instance_variable_get("@#{choice}") if @choices.include? choice
+      @choices.inject([]) do |array, choice|
+        return array unless @choices.include? choice
+        array + [instance_variable_get("@#{choice}")]
       end
-      array
     end
     
     # Returns Option converted to a hash.
     def to_h
-      hash = {}
-      @choices.each do |choice|
-        hash[choice] = instance_variable_get("@#{choice}") if @choices.include? choice
+      @choices.inject({}) do |hash, choice|
+        return hash unless @choices.include? choice
+        hash.merge choice => instance_variable_get("@#{choice}") 
       end
-      hash
     end
     
     # In case someone tries to use a method we don't know about in their 

data/lib/choice/parser.rb

@@ -3,6 +3,7 @@ module Choice
   # The parser takes our option definitions and our arguments and produces
   # a hash of values.
   module Parser #:nodoc: all
+    extend self
     
     # What method to call on an object for each given 'cast' value.
     CAST_METHODS = { Integer => :to_i, String => :to_s, Float => :to_f,
@@ -13,17 +14,15 @@ module Choice
     # the option's name and the second element being a hash of the option's
     # info.  You also pass in your current arguments, so it knows what to
     # check against.
-    def self.parse(options, args)
+    def parse(options, args)
       # Return empty hash if the parsing adventure would be fruitless.
       return {} if options.nil? || !options || args.nil? || !args.is_a?(Array)
       
       # If we are passed an array, make the best of it by converting it
       # to a hash.
-      if options.is_a?(Array)
-        new_options = {}
-        options.each { |o| new_options[o[0]] = o[1] if o.is_a?(Array) }
-        options = new_options
-      end
+      options = options.inject({}) do |hash, value|
+        value.is_a?(Array) ? hash.merge(value.first => value[1]) : hash
+      end if options.is_a? Array
       
       # Define local hashes we're going to use.  choices is where we store
       # the actual values we've pulled from the argument list.
@@ -39,11 +38,8 @@ module Choice
         name = name.to_s
 
         # Only take hashes or hash-like duck objects.
-        if obj.respond_to?(:to_h)
-          obj = obj.to_h 
-        else
-          raise HashExpectedForOption
-        end
+        raise HashExpectedForOption unless obj.respond_to? :to_h
+        obj = obj.to_h 
 
         # Is this option required?
         hard_required[name] = true if obj['required']
@@ -53,11 +49,11 @@ module Choice
         
         # If there is a validate statement, save it as a regex.
         # If it's present but can't pull off a to_s (wtf?), raise an error.
-        if obj['validate'] && obj['validate'].respond_to?(:to_s)
-          validators[name] = Regexp.new(obj['validate'].to_s)
-        elsif obj['validate']
-          raise ValidateExpectsRegexp
-        end
+        validators[name] = case obj['validate']
+                           when Proc then obj['validate']
+                           when Regexp, String then Regexp.new(obj['validate'].to_s)
+                           else raise ValidateExpectsRegexpOrBlock
+                           end if obj['validate'] 
         
         # Parse the long option. If it contains a =, figure out if the 
         # argument is required or optional.  Optional arguments are formed
@@ -149,7 +145,6 @@ module Choice
         else
           # If we're here, we have no idea what the passed argument is.  Die.
           raise UnknownOption if arg =~ /^-/
-
         end
       end
 
@@ -159,8 +154,13 @@ module Choice
         # Check to make sure we have all the required arguments.
         raise ArgumentRequired if required[name] && value === true
 
-        # Validate the argument if we need to.
-        raise ArgumentValidationFails if validators[name] && validators[name] !~ value
+        # Validate the argument if we need to, against a regexp or a block.
+        if validators[name]
+          if validators[name].is_a?(Regexp) && validators[name] =~ value 
+          elsif validators[name].is_a?(Proc) && validators[name].call(value)
+          else raise ArgumentValidationFails 
+          end
+        end
 
         # Make sure the argument is valid
         raise InvalidArgument unless value.to_a.all? { |v| hashes['valids'][name].include?(v) } if hashes['valids'][name] 
@@ -197,7 +197,7 @@ module Choice
 
   private
     # Turns trailing command line arguments into an array for an arrayed value
-    def self.arrayize_arguments(name, args)
+    def arrayize_arguments(name, args)
       # Go through trailing arguments and suck them in if they don't seem
       # to have an owner.
       array = []
@@ -213,7 +213,7 @@ module Choice
     class HashExpectedForOption < Exception; end
     class UnknownOption < ParseError; end      
     class ArgumentRequired < ParseError; end
-    class ValidateExpectsRegexp < ParseError; end
+    class ValidateExpectsRegexpOrBlock < ParseError; end
     class ArgumentValidationFails < ParseError; end
     class InvalidArgument < ParseError; end
     class ArgumentRequiredWithValid < ParseError; end

data/lib/choice/version.rb

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

data/test/test_choice.rb

@@ -7,7 +7,7 @@ $VERBOSE = nil
 class TestChoice < Test::Unit::TestCase
   
   def setup
-    Choice.reset
+    Choice.reset!
     Choice.dont_exit_on_help = true
     Choice.send(:class_variable_set, '@@choices', true)
   end
@@ -156,4 +156,28 @@ HELP
     
     assert_equal help_string, REQUIRED_STRING
   end
+
+  def test_shorthand_choices
+    Choice.options do
+      header "Tell me about yourself?"
+      header ""
+      options :band => { :short => "-b", :long => "--band=BAND", :cast => String, :desc => ["Your favorite band.", "Something cool."],
+                        :validate => /\w+/ },
+              :animal => { :short => "-a", :long => "--animal=ANIMAL", :cast => String, :desc => "Your favorite animal." }
+      
+      footer ""
+      footer "--help This message"
+    end
+    
+    band = 'LedZeppelin'
+    animal = 'Reindeer'
+    
+    args = ['-b', band, "--animal=#{animal}"]
+    Choice.args = args
+    
+    assert_equal band, Choice.choices['band']
+    assert_equal animal, Choice.choices[:animal]
+    assert_equal ["Tell me about yourself?", ""], Choice.header
+    assert_equal ["", "--help This message"], Choice.footer
+  end
 end

data/test/test_option.rb

@@ -5,7 +5,7 @@ require 'choice/option'
 
 class TestOption < Test::Unit::TestCase
   def setup
-    Choice.reset
+    Choice.reset!
     @option = Choice::Option.new
   end
   
@@ -72,6 +72,13 @@ class TestOption < Test::Unit::TestCase
     end
     
     assert_equal /^\w+$/, @option.validate
+
+    block = proc { |f| File.exists? f }
+    @option = Choice::Option.new do
+      validate &block
+    end
+
+    assert_equal block, @option.validate
   end  
   
   def test_dsl
@@ -108,10 +115,10 @@ class TestOption < Test::Unit::TestCase
         
     assert_equal Choice::Option, @option.class
     assert_equal Array, array.class
-    assert array.include?([desc])
-    assert array.include?(short)
-    assert array.include?(long)
-    assert array.include?(default)
+    assert array.include? [desc]
+    assert array.include? short
+    assert array.include? long
+    assert array.include? default
     assert_equal proc { 1 + 1 }.call, array.select { |a| a.is_a? Proc }.first.call
   end
   

data/test/test_parser.rb

@@ -163,7 +163,7 @@ class TestParser < Test::Unit::TestCase
     assert choices['chunky']
   end
   
-  def test_validate
+  def test_validate_regexp
     @options['email'] = Choice::Option.new do
       short '-e'
       long '--email=EMAIL'
@@ -185,6 +185,30 @@ class TestParser < Test::Unit::TestCase
     assert_equal email_good, choices['email']
   end
   
+  def test_validate_block
+    @options['file'] = Choice::Option.new do
+      short '-f'
+      long '--file=FILE'
+      desc 'Your valid email addy.'
+      validate do |arg|
+        File.exists? arg
+      end
+    end
+
+    file_bad = 'not_a_file.rb'
+    file_good = __FILE__
+    
+    args = ['-f', file_bad]
+    assert_raise(Choice::Parser::ArgumentValidationFails) do
+      choices = Choice::Parser.parse(@options, args)
+    end
+
+    args = ['-f', file_good]
+    choices = Choice::Parser.parse(@options, args)
+    
+    assert_equal file_good, choices['file']
+  end
+
   def test_unknown_argument
     @options['cd'] = Choice::Option.new do
       short '-c'

data/test/test_writer.rb

@@ -5,7 +5,7 @@ require 'choice'
 class TestWriter < Test::Unit::TestCase
   
   def setup
-    Choice.reset
+    Choice.reset!
   end
   
   HELP_OUT = ''

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: choice
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2006-07-22 00:00:00 -07:00
+  version: 0.1.2
+date: 2006-11-05 00:00:00 -08:00
 summary: Choice is a command line option parser.
 require_paths: 
 - lib