slop 2.1.0 → 2.2.0

data/CHANGES.md

@@ -1,3 +1,13 @@
+2.2.0 (2011-11-02)
+------------------
+
+* Support `bup.options` style optspec parsing
+    * http://apenwarr.ca/log/?m=201111
+
+* Allow `:as` to accept a `count` value (Conrad Irwin):
+
+    `on :v, :verbose, :as => :count # -vv; opts[:verbose] #=> 2`
+
 2.1.0 (2011-08-03)
 ------------------
 

data/lib/slop.rb

@@ -1,6 +1,9 @@
 class Slop
   include Enumerable
 
+  # @return [String] The current version string
+  VERSION = '2.2.0'
+
   # Slops standard Error class. All exception classes should
   # inherit from this class
   class Error < StandardError; end
@@ -20,8 +23,7 @@ class Slop
   class InvalidOptionError < Error; end
 
   # Each option specified in `Slop#opt` creates an instance of this class
-  class Option < Struct.new(:short_flag, :long_flag, :description,
-    :tail, :match, :help, :required, :forced, :count)
+  class Option < Struct.new(:short_flag, :long_flag, :description, :tail, :match, :help, :required, :forced, :count)
 
     # @param [Slop] slop The Slop object this Option belongs to
     #
@@ -143,6 +145,9 @@ class Slop
     #   according to the `:as` option
     def argument_value
       return @argument_value if forced
+      # Check for count first to prefer 0 over nil
+      return count if @argument_type == 'count'
+
       value = @argument_value || @options[:default]
       return if value.nil?
 
@@ -219,10 +224,8 @@ class Slop
 
     def value_to_range(value)
       case value.to_s
-      when /\A(-?\d+?)(?:\.\.|-|,)(-?\d+)\z/
-        $1.to_i .. $2.to_i
-      when /\A(-?\d+?)\.\.\.(-?\d+)\z/
-        $1.to_i ... $2.to_i
+      when /\A(-?\d+?)(\.\.\.?|-|,)(-?\d+)\z/
+        Range.new($1.to_i, $3.to_i, $2 == '...')
       when /\A-?\d+\z/
         value.to_i
       else
@@ -262,9 +265,6 @@ class Slop
     end
   end
 
-  # @return [String] The current version string
-  VERSION = '2.1.0'
-
   # Parses the items from a CLI format into a friendly object
   #
   # @param [Array] items Items to parse into options.
@@ -287,6 +287,30 @@ class Slop
     initialize_and_parse items, true, options, &block
   end
 
+  # Build options from an optspec string
+  #
+  # @param [String] optspec The option spec string
+  # @param [Array]  options A list of options to forward to Slop.new
+  # @return [Slop]  A new instance of Slop
+  def self.optspec(optspec, *options)
+    if optspec[/^--+$/]
+      banner, optspec = optspec.split(/^--+$/, 2)
+    end
+
+    lines = optspec.split("\n").reject(&:empty?)
+    opts  = Slop.new(banner, *options)
+
+    lines.each do |line|
+      opt, description = line.split(' ', 2)
+      short, long = opt.split(',').map { |s| s.sub(/\A--?/, '') }
+      argument = long && long[/\=$/]
+      long.sub!(/\=$/, '') if argument
+      opts.on short, long, description, argument
+    end
+
+    opts
+  end
+
   # @return [Options]
   attr_reader :options
 
@@ -522,7 +546,7 @@ class Slop
   # @raise [ArgumentError] When this command already exists
   # @return [Slop] a new instance of Slop namespaced to +label+
   def command(label, options={}, &block)
-    if @commands[label]
+    if @commands.key?(label)
       raise ArgumentError, "command `#{label}` already exists"
     end
 
@@ -866,25 +890,22 @@ class Slop
     end
   end
 
-  # wrap and indent a string, used to wrap and indent a description string
   def wrap_and_indent(string, width, indentation)
     string.lines.map do |paragraph|
       lines = []
       line = ''
 
       paragraph.split(/\s/).each do |word|
-        # Begin new line if it's too long
         if (line + ' ' + word).length >= width
           lines << line
           line = ''
         end
 
-        # Add word to line
         line << (line == '' ? '' : ' ' ) + word
       end
       lines << line
 
-      lines.map { |l| ' '*indentation + l }.join("\n")
+      lines.map { |l| ' ' * indentation + l }.join("\n")
     end.join("\n")
   end
 
@@ -927,7 +948,7 @@ class Slop
     if str
       command = @commands.keys.find { |c| c.to_s == str.to_s }
 
-      if !command && @completion
+      if @completion and not command
         cmds = @commands.keys.select { |c| c.to_s[0, str.length] == str }
 
         if cmds.size > 1

data/slop.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'slop'
-  s.version = '2.1.0'
+  s.version = '2.2.0'
   s.summary = 'Option gathering made easy'
   s.description = 'A simple DSL for gathering options and parsing the command line'
   s.author = 'Lee Jarvis'

data/test/option_test.rb

@@ -75,6 +75,11 @@ class OptionTest < TestCase
     assert_equal -1, option_value(%w/-i -1.1/, :i, true, :as => Integer)
     assert_equal "-1.1", option_value(%w/-i -1.1/, :i, true, :as => Float).to_s
     assert_equal "foo", option_value(%w/--foo1 foo/, :foo1, true)
+
+    assert_equal 0, option_value(%w//, :v, :verbose, :as => :count)
+    assert_equal 1, option_value(%w/--verbose/, :v, :verbose, :as => :count)
+    assert_equal 2, option_value(%w/--verbose -v/, :v, :verbose, :as => :count)
+    assert_equal 3, option_value(%w/-vvv/, :v, :verbose, :as => :count)
   end
 
   test 'ranges' do

data/test/slop_test.rb

@@ -552,4 +552,23 @@ class SlopTest < TestCase
 
     assert_equal %w[ bar c ], slop.missing
   end
+
+  test 'parsing an optspec and building options' do
+    optspec = <<-SPEC
+    ruby foo.rb [options]
+    --
+    v,verbose  enable verbose mode
+    q,quiet   enable quiet mode
+    debug      enable debug mode
+    H          enable hax mode (srsly)
+    n,name=    set your name
+    -a,--age= set your age
+    SPEC
+    opts = Slop.optspec(optspec.gsub(/^\s+/, ''))
+    opts.parse %w[ --verbose --name Lee ]
+
+    assert_equal 'Lee', opts[:name]
+    assert opts.verbose?
+    assert_equal 'enable quiet mode', opts.options[:quiet].description
+  end
 end

metadata

@@ -1,23 +1,32 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: slop
-version: !ruby/object:Gem::Version
-  version: 2.1.0
+version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: 
+  segments: 
+  - 2
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
-authors:
+authors: 
 - Lee Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-03 00:00:00.000000000 +01:00
-default_executable: 
+
+date: 2011-11-02 00:00:00 Z
 dependencies: []
+
 description: A simple DSL for gathering options and parsing the command line
 email: lee@jarvis.co
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gemtest
 - .gitignore
 - .yardopts
@@ -31,32 +40,40 @@ files:
 - test/helper.rb
 - test/option_test.rb
 - test/slop_test.rb
-has_rdoc: true
 homepage: http://github.com/injekt/slop
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Option gathering made easy
-test_files:
+test_files: 
 - test/commands_test.rb
 - test/helper.rb
 - test/option_test.rb