slop 1.6.1 → 1.7.0

data/CHANGES.md

@@ -1,3 +1,10 @@
+1.7.0 (2011-06-06)
+------------------
+
+* Feature: Autocreate (auto create options at parse time, making assumptions)
+* Feature: When parsing options as arrays, push multiple arguments into a
+  single array
+
 1.6.1 (2011-06-01)
 ------------------
 

data/README.md

@@ -193,26 +193,8 @@ You can of course also parse lists into options. Here's how:
     # ARGV is `--people lee,john,bill`
     opts[:people] #=> ['lee', 'john', 'bill']
 
-You can also change both the split delimiter and limit
-
-    opts = Slop.parse do
-      opt :people, true, :as => Array, :delimiter => ':', :limit => 2)
-    end
-
-    # ARGV is `--people lee:injekt:bob`
-    opts[:people] #=> ["lee", "injekt:bob"]
-
-Ranges
-------
-
-What would Slop be if it didn't know what ranges were?
-
-    opts = Slop.parse do
-      opt :r, :range, true, :as => Range
-    end
-
-    # ARGV is `--range 1..10` or 1-10, or 1,10 (yes Slop supports them all)
-    opts[:range].to_a #=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+Slop supports a few styles of list parsing. Check out
+[this wiki page](https://github.com/injekt/slop/wiki/Lists) for more info.
 
 Smart
 -----
@@ -278,6 +260,14 @@ Here's how commands might look:
 * `run.rb -v       #=> version 1`
 * `run.rb clean -v #=> Enabled verbose mode for clean`
 
+Features
+--------
+
+Check out the following wiki pages for more features:
+
+* [Ranges](https://github.com/injekt/slop/wiki/Ranges)
+* [Auto Create](https://github.com/injekt/slop/wiki/Auto-Create)
+
 Woah woah, why you hating on OptionParser?
 ------------------------------------------
 
@@ -314,4 +304,4 @@ thing in Slop:
       on :a, :age, 'Your age', true, :as => :int
     end
 
-    opts.to_hash(true) #=> { :name => 'lee', :age => 105 }
+    opts.to_hash(true) #=> { :name => 'lee', :age => 105 }

data/lib/slop.rb

@@ -16,7 +16,7 @@ class Slop
   class InvalidOptionError < RuntimeError; end
 
   # @return [String] The current version string
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 
   # Parses the items from a CLI format into a friendly object.
   #
@@ -71,6 +71,8 @@ class Slop
   # @option opts [Boolean] :ignore_case (false) Ignore options case
   # @option opts [Proc, #call] :on_noopts Trigger an event when no options
   #   are found
+  # @option opts [Boolean] :autocreate (false) Autocreate options depending
+  #   on the Array passed to {parse}
   def initialize(*opts, &block)
     sloptions = opts.last.is_a?(Hash) ? opts.pop : {}
     sloptions[:banner] = opts.shift if opts[0].respond_to? :to_str
@@ -86,6 +88,7 @@ class Slop
     @strict = sloptions[:strict]
     @ignore_case = sloptions[:ignore_case]
     @multiple_switches = sloptions[:multiple_switches]
+    @autocreate = sloptions[:autocreate]
     @on_empty = sloptions[:on_empty]
     @on_noopts = sloptions[:on_noopts] || sloptions[:on_optionless]
     @sloptions = sloptions
@@ -327,6 +330,7 @@ class Slop
     items.each_with_index do |item, index|
       item = item.to_s
       flag = item.sub(/\A--?/, '')
+      autocreate(flag, index, items) if @autocreate
       option, argument = extract_option(item, flag)
       next if @multiple_switches
 
@@ -439,6 +443,13 @@ class Slop
     end
   end
 
+  def autocreate(flag, index, items)
+    return if present? flag
+    short, long = clean_options Array(flag)
+    arg = (items[index + 1] && items[index + 1] !~ /\A--?/)
+    @options << Option.new(self, short, long, nil, arg, {})
+  end
+
   def clean_options(args)
     options = []
 

data/lib/slop/option.rb

@@ -22,12 +22,7 @@ class Slop
     attr_reader :help
 
     # @return [Boolean] true if this options argument value has been forced
-    attr_reader :forced
-
-    # @overload argument_value=(value)
-    #   Set this options argument value
-    #   @param [Object] value The value you'd like applied to this option
-    attr_writer :argument_value
+    attr_accessor :forced
 
     # @return [Integer] The amount of times this option has been invoked
     attr_accessor :count
@@ -61,6 +56,7 @@ class Slop
       @delimiter = options.fetch(:delimiter, ',')
       @limit = options.fetch(:limit, 0)
       @help = options.fetch(:help, true)
+      @argument_type = options[:as].to_s.downcase
 
       @forced = false
       @argument_value = nil
@@ -87,6 +83,24 @@ class Slop
       @long_flag || @short_flag
     end
 
+    # Set this options argument value.
+    #
+    # If this options argument type is expected to be an Array, this
+    # method will split the value and concat elements into the original
+    # argument value
+    #
+    # @param [Object] value The value to set this options argument to
+    def argument_value=(value)
+      if @argument_type == 'array'
+        @argument_value ||= []
+        if value.respond_to?(:to_str)
+          @argument_value.concat value.split(@delimiter, @limit)
+        end
+      else
+        @argument_value = value
+      end
+    end
+
     # @return [Object] the argument value after it's been cast
     #   according to the `:as` option
     def argument_value
@@ -94,8 +108,8 @@ class Slop
       value = @argument_value || @options[:default]
       return if value.nil?
 
-      case @options[:as].to_s.downcase
-      when 'array'; value.split @delimiter, @limit
+      case @argument_type
+      when 'array'; @argument_value
       when 'range'; value_to_range value
       when 'float'; value.to_s.to_f
       when 'string', 'str';  value.to_s
@@ -159,7 +173,7 @@ class Slop
     # @return [String]
     def inspect
       "#<Slop::Option short_flag=#{@short_flag.inspect} " +
-      "long_flag=#{@long_flag.inspect} " +
+      "long_flag=#{@long_flag.inspect} argument=#{@argument.inspect} " +
       "description=#{@description.inspect}>"
     end
 

data/slop.gemspec

@@ -1,9 +1,6 @@
-$:.push File.expand_path('../lib', __FILE__)
-require 'slop'
-
 Gem::Specification.new do |s|
   s.name = 'slop'
-  s.version = Slop::VERSION
+  s.version = '1.7.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/helper.rb

@@ -6,11 +6,6 @@ end
 require 'minitest/autorun'
 require 'stringio'
 
-begin
-  require 'turn'
-rescue LoadError
-end
-
 class TestCase < MiniTest::Unit::TestCase
   def self.test(name, &block)
     test_name = "test_#{name.gsub(/\s+/, '_')}".to_sym

data/test/slop_test.rb

@@ -384,4 +384,27 @@ class SlopTest < TestCase
     opts.parse %w/--NAME lee/
     assert_equal 'lee', opts[:name]
   end
+
+  test 'autocreating options' do
+    opts = Slop.new(:autocreate => true) do |o|
+      o.on '--lorem', true
+    end
+    opts.parse %w/--hello --foo bar -a --lorem ipsum/
+
+    assert opts.hello?
+    assert opts.foo?
+    assert_equal 'bar', opts[:foo]
+    assert opts.a?
+    assert_equal 'ipsum', opts[:lorem]
+  end
+
+  test 'multiple elements for array option' do
+    opts = Slop.new do
+      on :a, true, :as => Array
+    end
+    opts.parse %w/-a foo -a bar baz -a etc/
+
+    assert_equal %w/foo bar etc/, opts[:a]
+  end
+
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: slop
 version: !ruby/object:Gem::Version 
-  hash: 13
   prerelease: 
-  segments: 
-  - 1
-  - 6
-  - 1
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-01 00:00:00 +01:00
-default_executable: 
+date: 2011-06-06 00:00:00 Z
 dependencies: []
 
 description: A simple DSL for gathering options and parsing the command line
@@ -43,7 +37,6 @@ files:
 - test/helper.rb
 - test/option_test.rb
 - test/slop_test.rb
-has_rdoc: true
 homepage: http://github.com/injekt/slop
 licenses: []
 
@@ -57,23 +50,17 @@ required_ruby_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 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: Option gathering made easy