clip 0.0.2 → 0.0.3

data/README.txt

@@ -3,9 +3,9 @@
 == DESCRIPTION:
 
 Yeah yeah yeah. Why in heaven's name do we need yet another
-command-line parser? Well, OptionParser is all well and good, but
-doesn't grease the skids as much as I'd like. So I wrote this little
-library... driven completely by specs.
+command-line parser? Well, OptionParser is all well and good[1], but
+doesn't grease the skids as much as I'd like. Simple things should be
+dead simple (1 LOC), and more flexibility is there if you need it.
 
 Cheers!
 
@@ -68,6 +68,19 @@ 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.
 
+Sometimes even passing a block is overkill. Say you want to grab just
+a hash from a set of name/value argument pairs provided:
+
+  $ my_clip_script subcommand -c config.yml # Allows:
+  Clip.hash == { 'c' => 'config.yml' }
+
+  $ my_clip_script -c config.yml --mode optimistic # Allows:
+   Clip.hash == { 'c' => 'config.yml', 'mode' => 'optimistic' }
+
+----------------------------------------
+
+[1] - Not really.
+
 == LICENSE:
 
 (The MIT License)

data/lib/clip.rb

@@ -13,7 +13,7 @@ def Clip(args=ARGV)
 end
 
 module Clip
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
   ##
   # Indicates that the parser was incorrectly configured in the
@@ -338,4 +338,27 @@ module Clip
       sprintf('-%-2s --%-10s %s', @short, @long, @description)
     end
   end
-end
+
+  HASHER_REGEX = /^--?\w+/
+  ##
+  # Turns ARGV into a hash.
+  #
+  #  my_clip_script -c config.yml # Clip.hash == { 'c' => 'config.yml' }
+  #  my_clip_script command -c config.yml # Clip.hash == { 'c' => 'config.yml' }
+  #  my_clip_script com -c config.yml -d # Clip.hash == { 'c' => 'config.yml' }
+  #  my_clip_script -c config.yml --mode optimistic
+  #  # Clip.hash == { 'c' => 'config.yml', 'mode' => 'optimistic' }
+  def self.hash(argv = ARGV.dup, values = [])
+    @hash ||= begin
+      argv.shift until argv.first =~ HASHER_REGEX
+      while argv.first =~ HASHER_REGEX and argv.size >= 2 do
+        values += [argv.shift.sub(/^--?/, ''), argv.shift]
+      end
+      Hash[*values]
+    end
+  end
+
+  ##
+  # Clear the cached hash value. Probably only useful for tests, but whatever.
+  def Clip.reset_hash!; @hash = nil end
+end

data/spec/clip_spec.rb

@@ -288,4 +288,27 @@ describe Clip do
       opts.value.should == 123
     end
   end
+
+  describe "when parsing ARGV as a hash" do
+    setup { Clip.reset_hash! }
+    
+    it "should make sense of '-c my_config.yml'" do
+      Clip.hash(['-c', 'config.yml']).should == { 'c' => 'config.yml' }
+    end
+
+    it "should only use pairs of dash + value args" do
+      Clip.hash(['-c', 'config.yml',
+                 '-d']).should == { 'c' => 'config.yml' }
+    end
+
+    it "should ignore leading/trailing non-dashed arguments" do
+      Clip.hash(['subcommand', '-c', 'config.yml',
+                 'do']).should == { 'c' => 'config.yml' }
+    end
+
+    it "should allow -s (short) or --long arguments" do
+      Clip.hash(['-c', 'config.yml', '--mode', 'optimistic']).
+        should == { 'c' => 'config.yml', 'mode' => 'optimistic' }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clip
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Alex Vollmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-20 00:00:00 -07:00
+date: 2008-06-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: clip
-rubygems_version: 1.1.0
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: Command-line parsing made short and sweet