clip 0.0.1 → 0.0.2

data/History.txt

@@ -1,4 +1,8 @@
-=== 0.0.1 / 2008-04-03
+=== 0.0.1 / 2008-04-10
 
-* Initial release for y'all to throw rotten veggies at
+* Initial release for y'all to throw rotten veggies at.
 
+=== 0.0.2 / 2008-05-20
+
+* Cleaned up README
+* Added support for late-binding option processing with blocks

data/README.txt

@@ -12,12 +12,12 @@ Cheers!
 == FEATURES
 
 You like command-line parsing, but you hate all of the bloat. Why
-should you have to create a Hash, then create a parser, then fill
-that Hash out then throw the parser away (unless you want to print
-out a usage message) and deal with a Hash? Why, for Pete's sake, should
-the parser and the parsed values be handled by two different objects?
+should you have to create a Hash, then create a parser, fill the Hash
+out then throw the parser away (unless you want to print out a usage
+message) and deal with a Hash? Why, for Pete's sake, should the parser
+and the parsed values be handled by two different objects?
 
-Well, now they don't...
+Introducing Clip...
 
 == SYNOPSIS:
 
@@ -26,31 +26,38 @@ And it goes a little something like this...
   require "rubygems"
   require "clip"
 
-  parser = Clip do |p|
+  options = Clip do |p|
     p.optional 's', 'server', :desc => 'The server name', :default => 'localhost'
-    p.optional 'p', 'port', :desc => 'The port', :default => 8080
+    p.optional 'p', 'port', :desc => 'The port', :default => 8080 do |v|
+      v.to_i # always deal with integers
+    end
     p.required 'f', 'files', :multi => true, :desc => 'Files to send'
     p.flag     'v', 'verbose', :desc => 'Make it chatty'
   end
 
-  if parser.valid?
-    if parser.verbose?
-      puts parser.host
-      puts parser.port
+  if options.valid?
+    if options.verbose?
+      puts options.host
+      puts options.port
       puts 'files:'
-      parser.files.each do |f|
+      options.files.each do |f|
         puts "\t#{f}"
       end
     end
   else
     # print error message(s) and usage
-    $stderr.puts parser.to_s
+    $stderr.puts options.to_s
   end
 
 The names of the options and flags that you declare in the block are accessible
 as methods on the returned object, reducing the amount of objects you have to
 deal with when you're parsing command-line parameters.
 
+You can optionally process parsed arguments by passing a block to the
+<tt>required</tt> or <tt>optional</tt> methods which will set the value of the
+option to the result of the block. The block will receive the parsed value and
+should return whatever transformed value that is appropriate to your use case.
+
 Simply invoking the <tt>to_s</tt> method on a parser instance will dump both the
 correct usage and any errors encountered during parsing. No need for you to manage
 the state of what's required and what isn't by yourself. Also, '--help' and '-h'
@@ -61,13 +68,6 @@ a named option or flag. Whatever remains on the command line that doesn't fit
 either a flag or an option/value pair will be made available via the
 <tt>remainder</tt> method of the returned object.
 
-== PROBLEMS/DEFICIENCIES:
-
-OK, some of your favorite <tt>OptionParser</tt> features are simply not here.
-You know that cool thing you can do where you tell <tt>OptionParser</tt> the
-class of the kind of object you would like to get for a particular argument?
-Do you like that one? Well, too bad. We don't have that one. Deal with it.
-
 == LICENSE:
 
 (The MIT License)

data/bin/sample_parser

@@ -6,7 +6,9 @@ require File.join(File.dirname(__FILE__), "../lib/clip")
 # This is a very simple example of how to use Clip
 p = Clip do |c|
   c.optional 's', 'server', :desc => 'The server name', :default => 'localhost'
-  c.optional 'p', 'port', :desc => 'The port', :default => 8080
+  c.optional 'p', 'port', :desc => 'The port', :default => 8080 do |v|
+    v.to_i
+  end
   c.optional 'f', 'files', :desc => 'Files to upload', :multi => true
   c.flag 'v', 'verbose', :desc => 'Make it verbose, man'
 end

data/lib/clip.rb

@@ -13,7 +13,7 @@ def Clip(args=ARGV)
 end
 
 module Clip
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
   ##
   # Indicates that the parser was incorrectly configured in the
@@ -27,6 +27,12 @@ module Clip
     # because they were neither flags or option/value pairs
     attr_reader :remainder
 
+    ##
+    # Set the usage 'banner' displayed when calling <tt>to_s</tt> to
+    # display the usage message. If not set, the default will be used.
+    # If the value is set this completely replaces the default
+    attr_accessor :banner
+
     ##
     # Declare an optional parameter for your parser. This creates an accessor
     # method matching the <tt>long</tt> parameter. The <tt>short</tt> parameter
@@ -42,25 +48,31 @@ module Clip
     # * <tt>desc</tt>: a helpful description (used for printing usage)
     # * <tt>default</tt>: a default value to provide if one is not given
     # * <tt>multi</tt>: indicates that mulitple values are okay for this param.
+    # * <tt>block</tt>: an optional block to process the parsed value
     #
     # Note that specifying the <tt>:multi</tt> option means that the parameter
     # can be specified several times with different values, or that a single
     # comma-separated value can be specified which will then be broken up into
     # separate tokens.
-    def optional(short, long, options={})
+    def optional(short, long, options={}, &block)
       short = short.to_sym
       long = long.to_sym
       check_args(short, long)
 
-      eval <<-EOF
-        def #{long}=(val)
-          @#{long} = val
+      var_name = "@#{long}".to_sym
+      if block
+        self.class.send(:define_method, "#{long}=".to_sym) do |v|
+          instance_variable_set(var_name, block.call(v))
         end
-
-        def #{long}
-          @#{long}
+      else
+        self.class.send(:define_method, "#{long}=".to_sym) do |v|
+          instance_variable_set(var_name, v)
         end
-      EOF
+      end
+
+      self.class.send(:define_method, long.to_sym) do
+        instance_variable_get(var_name)        
+      end
 
       self.options[long] = Option.new(short, long, options)
       self.options[short] = self.options[long]
@@ -75,8 +87,8 @@ module Clip
     # will be invalid (i.e. where valid? returns <tt>false</tt>).
     #
     # This method takes the same options as the optional method.
-    def required(short, long, options={})
-      optional(short, long, options.merge({ :required => true }))
+    def required(short, long, options={}, &block)
+      optional(short, long, options.merge({ :required => true }), &block)
     end
 
     alias_method :req, :required
@@ -195,7 +207,12 @@ module Clip
     # Returns a formatted <tt>String</tt> indicating the usage of the parser
     def help
       out = ""
-      out << "Usage:\n"
+      if banner
+        out << "#{banner}\n"
+      else
+        out << "Usage:\n"
+      end
+
       order.each do |option|
         out << "#{option.usage}\n"
       end

data/spec/clip_spec.rb

@@ -174,6 +174,16 @@ describe Clip do
       out[1].should match(/missing required.*files/i)
       out[2..-1].join("\n").strip.should == parser.help.strip
     end
+
+    it "should support declaring a banner" do
+      opts = Clip('-v') do |p|
+        p.banner = "USAGE foo bar baz"
+        p.flag 'v', 'verbose', :desc => 'Provide verbose output'
+      end
+
+      out = opts.to_s.split("\n")
+      out[0].should == 'USAGE foo bar baz'
+    end
   end
 
   describe "Additional arguments" do
@@ -266,4 +276,16 @@ describe Clip do
       end
     end
   end
+
+  describe "when specifying a block for a parameter" do
+    it "should run the block" do
+      opts = Clip("-v 123") do |c|
+        c.req 'v', 'value', :desc => 'The value' do |v|
+          v.to_i
+        end
+      end
+      
+      opts.value.should == 123
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clip
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alex Vollmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-10 00:00:00 -07:00
+date: 2008-05-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.1
     version: 
-description: Command-line parsing made short and sweet
+description: You like command-line parsing, but you hate all of the bloat. Why should you have to create a Hash, then create a parser, fill the Hash out then throw the parser away (unless you want to print out a usage message) and deal with a Hash? Why, for Pete's sake, should the parser and the parsed values be handled by two different objects?
 email: 
 - alex.vollmer@gmail.com
 executables: