clip 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,10 @@
+=== 1.0.2 / 2009-10-02
+
+* Merged patches from Adam Salter:
+  * Added new "presence" method for options.
+  * Updated rspec usage to match the latest & greatest syntax
+  * Make descriptions optional for flags and options
+
 === 1.0.1 / 2009-01-06
 
 * Fixed a bug where generating help resulted in an infinite-loop

data/README.txt

@@ -42,7 +42,7 @@ And it goes a little something like this...
 
   if options.valid?
     if options.verbose?
-      puts options.host
+      puts options.server if options.server?
       puts options.port
       puts 'files:'
       options.files.each do |f|

data/Rakefile

@@ -4,7 +4,8 @@ require 'rubygems'
 require 'hoe'
 require './lib/clip.rb'
 
-Hoe.new('clip', Clip::VERSION) do |p|
+Hoe.spec('clip') do |p|
+  p.version = Clip::VERSION
   p.name = 'clip'
   p.developer('Alex Vollmer', 'alex.vollmer@gmail.com')
   p.description = p.paragraphs_of('README.txt', 5..5).join("\n\n")

data/lib/clip.rb

@@ -15,7 +15,7 @@ def Clip(args=ARGV)
 end
 
 module Clip
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 
   ##
   # Indicates that the parser was incorrectly configured in the
@@ -47,11 +47,12 @@ module Clip
 
     ##
     # Declare an optional parameter for your parser. This creates an accessor
-    # method matching the <tt>long</tt> parameter. The <tt>short</tt> parameter
-    # indicates the single-letter equivalent. Options that use the '-'
+    # method matching the <tt>long</tt> parameter and a present method
+    # <tt>long?</tt>. The <tt>short</tt> parameter indicates
+    # the single-letter equivalent. Options that use the '-'
     # character as a word separator are converted to method names using
-    # '_'. For example the name 'exclude-files' would create a method named
-    # <tt>exclude_files</tt>.
+    # '_'. For example the name 'exclude-files' would create two methods named
+    # <tt>exclude_files</tt> and <tt>exclude_files?</tt>.
     #
     # When the <tt>:multi</tt> option is enabled, the associated accessor
     # method will return an <tt>Array</tt> instead of a single scalar value.
@@ -87,6 +88,10 @@ module Clip
         define_method(long.to_sym) do
           instance_variable_get(var_name)
         end
+
+        define_method("#{long}?") do
+          !instance_variable_get(var_name).nil?
+        end
       end
 
       self.options[short] = self.options[long] =
@@ -339,7 +344,7 @@ module Clip
     def initialize(short, long, options)
       @short = short
       @long = long
-      @description = options[:desc]
+      @description = options[:desc] || ""
       @default = options[:default]
       @required = options[:required]
       @multi = options[:multi]

data/spec/clip_spec.rb

@@ -67,10 +67,13 @@ describe Clip do
       parser = parse('')
       parser.should respond_to(:server)
       parser.should respond_to(:server=)
+      parser.should respond_to(:server?)
       parser.should respond_to(:port)
-      parser.should respond_to(:port)
+      parser.should respond_to(:port=)
+      parser.should respond_to(:port?)
       parser.should respond_to(:files)
       parser.should respond_to(:files=)
+      parser.should respond_to(:files?)
       parser.should respond_to(:verbose?)
       parser.should respond_to(:flag_verbose)
       parser.should respond_to(:allow_dashes?)
@@ -87,7 +90,9 @@ describe Clip do
     it "should set fields for flags with the given values" do
       parser = parse('--server localhost --port 8080 --files foo')
       parser.server.should eql("localhost")
+      parser.server?.should eql(true)
       parser.port.should eql("8080")
+      parser.port?.should eql(true)
       parser.should be_valid
       parser.should_not have_errors
     end
@@ -95,6 +100,7 @@ describe Clip do
     it "should map options with '-' to methods with '_'" do
       parser = parse('--exclude-from /Users --files foo')
       parser.exclude_from.should eql("/Users")
+      parser.exclude_from?.should eql(true)
       parser.should be_valid
       parser.should_not have_errors
     end
@@ -108,12 +114,15 @@ describe Clip do
     it "should map options with multiple '-' to methods with '_'" do
       parser = parse('--exclude-from-all /Users --files foo')
       parser.exclude_from_all.should eql("/Users")
+      parser.exclude_from_all?.should eql(true)
       parser.should be_valid
       parser.should_not have_errors
     end
 
     it "should be invalid for unknown options" do
       parser = parse('--non-existent')
+      parser.exclude_from_all?.should eql(false)
+      parser.exclude_from?.should eql(false)
       parser.should_not be_valid
       parser.should have_errors_on(:non_existent)
     end
@@ -133,7 +142,9 @@ describe Clip do
       parser.should_not have_errors
       parser.should be_valid
       parser.server.should eql("localhost")
+      parser.server?.should eql(true)
       parser.port.should eql("8080")
+      parser.port?.should eql(true)
       parser.should_not be_verbose
     end
   end
@@ -186,6 +197,14 @@ describe Clip do
       end
     end
 
+    it "should work if no description given" do
+      opts = Clip do |o|
+        o.opt 'X', 'no-description'
+      end
+      help = opts.to_s.split("\n")
+      help[1].should == "-X  --no-description  "
+    end
+
     it "should print out some sensible usage info for to_s" do
       help = opts("-s localhost").to_s.split("\n")
       help[0].should match(/Usage/)
@@ -301,7 +320,7 @@ describe Clip do
     end
   end
   describe "Remaining arguments for Clip.hash" do
-    setup { Clip.reset_hash! }
+    before(:each) { Clip.reset_hash! }
 
     it "should be populated" do
       Clip.hash(['captain', 'lieutenant', '-c', 'jorge']).remainder.
@@ -448,7 +467,7 @@ describe Clip do
   end
 
   describe "when parsing ARGV as a hash" do
-    setup { Clip.reset_hash! }
+    before(:each) { Clip.reset_hash! }
 
     it "should make sense of '-c my_config.yml'" do
       Clip.hash(['-c', 'config.yml']).should == { 'c' => 'config.yml' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clip
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Alex Vollmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-06 00:00:00 -08:00
+date: 2009-10-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,9 +20,14 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 2.3.3
     version: 
-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?
+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: []
@@ -43,6 +48,8 @@ files:
 - spec/clip_spec.rb
 has_rdoc: true
 homepage: http://clip.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -64,9 +71,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: clip
-rubygems_version: 1.3.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Command-line parsing made short and sweet
 test_files: []