opt-simple 0.9.12 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3396db6ba0716fea38377347f6831c74c372324523123b0934c8356796b8b230
+  data.tar.gz: 60ef677dc68de3ea9459b8b6d428e2a235178187fddb4850405dd9567e3055cc
+SHA512:
+  metadata.gz: 85f93bd1282c725161c2db2106ff7f3ca19fe1b97f86313b73b0cd000540b8e2f5832b6523aaf087b59ef977921fe7e6aba6a193a852827d8a47635fef77f972
+  data.tar.gz: 16a47cde44882e07c1ae688db17be9e6df212f34b3227d958510b08f7e79e47bc0346f3e0a19109c75af4aa87af4237eba77204f8e180da35c6660a5b8c8ec6e

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (C) 2011  Ethan Stryker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/{README → README.md}

@@ -1,6 +1,6 @@
-== OptSimple provides a very simple interface to command line parsing. 
+## OptSimple provides a very simple interface to command line parsing. 
 
-== Description
+## Description
 Parameter specification, validity checking and argument transformations
 can be put in one place, default parameters are easily set, and an automatic
 usage statement is constructed.
@@ -25,19 +25,22 @@ The order in which the parameters are defined dictate their order on the command
 
 User defined help banners, summaries or the whole usage statement can be defined. 
 
-== Documentation
+## Documentation
 
 See OptSimple for the API specification
 
-== Installation
+## Installation
 
 It is recommended to install OptSimple using RubyGems:
 
+```
  $ sudo gem install opt-simple
+```
 
-== Examples
+## Examples
 
-=== One example that shows most of the behavior you might use
+### One example that shows most of the behavior you might use
+```ruby
  require 'opt_simple'
  
  defaults = {  
@@ -103,7 +106,9 @@ It is recommended to install OptSimple using RubyGems:
  puts "Range: #{opts.range.first} #{opts.range.last}"
 
  puts "Things: #{opts.things.inspect}"
+```
 
+```
 Which prints out an automatic usage statement:
  Usage: opt_ex.rb [options]
  
@@ -124,9 +129,9 @@ Which prints out an automatic usage statement:
          -t, --things THINGS                         Some things - variable number allowed 
 
      -h, --help                                  (for this help message)
-
-=== A very simple example with no error checking. Use at your own risk!
-
+```
+### A very simple example with no error checking. Use at your own risk!
+``` ruby
  require 'opt_simple'
  
  defaults = {
@@ -137,9 +142,9 @@ Which prints out an automatic usage statement:
  
  puts "Options"
  puts options
- 
-=== An example using all default behavior 
- 
+```
+### An example using all default behavior 
+```ruby 
  require 'opt_simple'
  
  options = OptSimple.new.parse_opts! do 
@@ -151,9 +156,9 @@ Which prints out an automatic usage statement:
  
  puts "Options"
  puts options
-
-=== An example that shows how to set the banner string, and add a summary.
-
+```
+### An example that shows how to set the banner string, and add a summary.
+```ruby
  require 'opt_simple'
  
  defaults = {
@@ -172,9 +177,9 @@ Which prints out an automatic usage statement:
  
  puts "Options"
  puts options
-
-=== An example that shows that you can easily set your defaults in normal Ruby variables and provide your own help.
- 
+```
+### An example that shows that you can easily set your defaults in normal Ruby variables and provide your own help.
+```ruby 
  require 'opt_simple'
   
  in_file = nil
@@ -223,9 +228,9 @@ Which prints out an automatic usage statement:
  
  puts "ARGV"
  puts ARGV
-  
-=== An example showing how to register parms in multiple places before parsing the command line
-
+```  
+### An example showing how to register parms in multiple places before parsing the command line
+```ruby
  require 'opt_simple'
  
  min = 5
@@ -241,7 +246,7 @@ Which prints out an automatic usage statement:
    option %w[-p --pattern --glob-pattern], "glob pattern","PATTERN"
  end
  
- os.register_opts do 
+ os.register_opts({num: 7}) do 
    option %w[-n -num --num-values],"Number of val","VAL" do |arg|
      set_opt arg.to_i
    end
@@ -263,9 +268,10 @@ Which prints out an automatic usage statement:
  
  puts "Options"
  puts options
- 
-=== A totally contrived example showing how to change multiple options within an option specification block
+``` 
+### A totally contrived example showing how to change multiple options within an option specification block
 
+```ruby
  require 'opt_simple'
  
  allowed_odds = [1,3,5,7]
@@ -298,9 +304,10 @@ Which prints out an automatic usage statement:
  
  puts "Options"
  puts opts
- 
-== Questions and/or Comments
+```
+## Questions and/or Comments
   
-email {Ethan Stryker}[mailto:e.stryker@gmail.com]
+email [Ethan Stryker](mailto:e.stryker@gmail.com])
  
- 
+## License
+MIT - see [LICENSE](LICENSE.txt) 

data/lib/opt_simple.rb

@@ -27,14 +27,15 @@ class OptSimple
 
   # default keys should should be strings, 
   # args can be any list of strings, but defaults to ARGV
-  def initialize(defaults = {},args = ARGV)
+  def initialize(defaults: {},args:  ARGV)
     @mandatory_opts = []
     @optional_opts = []
     @parameters = []
     @param_names = {}
     @results = OptSimple::Result.new
     @longest_switch_len = 0 
-    @defaults = defaults
+    # set defaults to empty hash just in case user sets them to nil
+    @defaults = defaults || {}
     @args = args.to_a # especially for jruby
     @banner = "Usage: #{File.basename($0)} [options]"
     @summary = ""
@@ -58,10 +59,11 @@ class OptSimple
 
   # Simply register options without actually parsing them. 
   # This allows registering parms in multiple places in your code.
-  def register_opts(&block)
+  def register_opts(defaults: {}, &block)
     # call the block to register all the parameters and
     # their corresponding code blocks
     # We use instance_exec so that the API is cleaner. 
+    @defaults.merge!(defaults)
     instance_exec(@results,&block)
     self
   end
@@ -146,9 +148,8 @@ class OptSimple
 	  end
 	  
 	  chunks.each do | pieces |
-	    if parm.block.arity > 0 and 
-		(pieces.length < parm.block.arity or
-		 pieces.any? {|p| p.start_with?('-')})
+	    # Note that we remove the leading '-' restriction to allow for negative numbers in arguments
+	    if parm.block.arity > 0 and	(pieces.length < parm.block.arity) # or # pieces.any? {|p| p.start_with?('-')})
 	      raise OptSimple::ParameterUsageError.new "Not enough args following #{intersection}",self 
 	    end
 	    

data/lib/test_unit_extensions.rb

@@ -1,6 +1,6 @@
 module Test::Unit
   # Used to fix a minor minitest/unit incompatibility in flexmock 
-  AssertionFailedError = Class.new(StandardError)
+  # AssertionFailedError = Class.new(StandardError)
   
   class TestCase
    

data/test/test_arglist.rb

@@ -5,7 +5,7 @@ require 'test_unit_extensions'
 class ArglistTest < Test::Unit::TestCase
   def setup
     @args = %w[infile1 -v infile2 -o out.txt infile3 -- -infile4 infile5]
-    @os = OptSimple.new({},@args)
+    @os = OptSimple.new(defaults: {},args: @args)
     @block = Proc.new {
       flag '-v'
       argument '-o'

data/test/test_help.rb

@@ -8,14 +8,14 @@ class TestHelpStatement < Test::Unit::TestCase
     defaults = {
       :a => 1000
     }
-    os = OptSimple.new(defaults)
+    os = OptSimple.new(defaults: defaults)
     os.add_parameter(OptSimple::Option.new '-a' )
     
     assert os.to_s =~/default.*#{defaults['a']}/
   end
 
   must "order help according to specification order" do 
-    os = OptSimple.new({},['-h'])
+    os = OptSimple.new(defaults: {},args: ['-h'])
     os.add_parameter(OptSimple::Option.new '-a')
     os.add_parameter(OptSimple::Flag.new '-b')
     os.add_parameter(OptSimple::Option.new '-c')
@@ -28,7 +28,7 @@ class TestHelpStatement < Test::Unit::TestCase
 
   must "allow user defined help statements" do
     my_help = "Totally irrelevant"
-    os = OptSimple.new({},['-h'])
+    os = OptSimple.new(defaults: {},args: ['-h'])
     os.add_parameter(OptSimple::Option.new '-a')
     os.add_parameter(OptSimple::Flag.new '-b')
     os.help my_help
@@ -37,14 +37,14 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "provide user specified summary statement in help" do
-    os = OptSimple.new({},['-h'])
+    os = OptSimple.new(defaults: {},args: ['-h'])
     os.add_parameter(OptSimple::Option.new '-a')
     os.summary "My summary"
     assert os.to_s.match(Regexp.new("My summary",Regexp::MULTILINE))
   end
 
   must "add metavars to help statement" do 
-    os = OptSimple.new({},['-h'])
+    os = OptSimple.new(defaults: {},args: ['-h'])
     os.add_parameter(OptSimple::Option.new '-a',"some help","THING")
     assert os.to_s.match(Regexp.new("\-a.*THING.*some help",Regexp::MULTILINE))
   end

data/test/test_usage.rb

@@ -9,7 +9,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "throw parameter missing exception when the argument method is used but the parm isn't specified" do
-    os = OptSimple.new({})
+    os = OptSimple.new(defaults: {})
     assert_raise(OptSimple::MissingArgument) do
       os.parse_opts! do
 	argument '-a'
@@ -18,7 +18,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "throw missing parameter usage error when a parameter isn't followed by enough arguments" do
-    os = OptSimple.new({},['-a'])
+    os = OptSimple.new(defaults: {},args: ['-a'])
     assert_raise(OptSimple::ParameterUsageError) do
       os.parse_opts! do
 	argument '-a' do |arg| 
@@ -27,7 +27,7 @@ class TestHelpStatement < Test::Unit::TestCase
       end
     end
 
-    os = OptSimple.new({},%w[--range 5])
+    os = OptSimple.new(defaults: {},args: %w[--range 5])
     assert_raise(OptSimple::ParameterUsageError) do
       os.parse_opts! do
 	argument '--range' do |min,max| 
@@ -38,12 +38,12 @@ class TestHelpStatement < Test::Unit::TestCase
   end
   
   must "raise error when unknown option is given" do 
-    os = OptSimple.new({},['-not-specified'])
+    os = OptSimple.new(defaults: {},args: ['-not-specified'])
     assert_raise(OptSimple::InvalidOption) { os.parse_opts! { option %w[-a --awesome]  }  }
   end
 
   must "handle arguments with equals and commas" do
-    os = OptSimple.new({},['-a=2','--foo=4,5'])
+    os = OptSimple.new(defaults: {},args: ['-a=2','--foo=4,5'])
     x = nil
     y = nil
     opts= os.parse_opts! do
@@ -62,7 +62,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "accumulate lists of args when asked" do 
-    os = OptSimple.new({},%w[-i foo.bar --infile bar.in])
+    os = OptSimple.new(defaults: {},args: %w[-i foo.bar --infile bar.in])
     o = os.parse_opts! do 
       option %w[-i --infile], "Infile, multiple allowed", "FILE" do | arg |
 	accumulate_opt arg
@@ -74,7 +74,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "accumulate numbers of flags set when asked" do 
-    os = OptSimple.new({},%w[-v -v --verbose -v])
+    os = OptSimple.new(defaults: {},args: %w[-v -v --verbose -v])
     o = os.parse_opts! do 
       flag %w[-v  --verbose],"Verbosity. the more you set, the more we give" do 
 	accumulate_opt
@@ -85,7 +85,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "set last arg when duplicated when accumulate opt isn't used" do 
-    os = OptSimple.new({},%w[-i foo.bar --infile bar.in -i baz])
+    os = OptSimple.new(defaults: {},args: %w[-i foo.bar --infile bar.in -i baz])
     o = os.parse_opts! do 
       option %w[-i --infile], "Infile, multiple allowed", "FILE" do | arg |
 	set_opt arg
@@ -97,7 +97,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "allow parameters to be registered in multiple spots" do 
-    os = OptSimple.new({},%w[-i foo.bar --outfile bar.out])
+    os = OptSimple.new(defaults: {},args: %w[-i foo.bar --outfile bar.out])
     os.register_opts do 
       option %w[-i --infile], "Infile", "FILE" do | arg |
 	set_opt arg
@@ -115,6 +115,27 @@ class TestHelpStatement < Test::Unit::TestCase
     assert_equal o['o'],'bar.out'
   end
 
+  must "allow defaults when registering opts in multiple spots" do 
+    os = OptSimple.new(defaults: {outfile: 'old-default'},args: %w[-i foo.bar])
+
+    os.register_opts do 
+      option %w[-i --infile], "Infile", "FILE" do | arg |
+	set_opt arg
+      end
+    end
+
+    os.register_opts(defaults: {outfile: 'new-default'}) do 
+      option %w[-o --outfile], "outfile", "FILE" do | arg |
+	set_opt arg
+      end
+    end
+    o = os.parse_opts!
+    
+    assert_equal o['i'],'foo.bar'
+    assert_equal o['o'],'new-default'
+
+  end
+
   must "set flags to false by default" do
     os = OptSimple.new
     o = os.parse_opts! do 
@@ -125,7 +146,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "add undersore versions to all switch names that have a dash" do 
-    os = OptSimple.new({},%w[--some-stuff foo])
+    os = OptSimple.new(defaults: {},args: %w[--some-stuff foo])
     o = os.parse_opts! do 
       option %w[-s --some-stuff]
     end
@@ -135,7 +156,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "overwrite defaults when accumulate opt is used and option is seen on the CL" do
-    os = OptSimple.new({:some_stuff => ['bar']},%w[--some-stuff foo --some-stuff bar])
+    os = OptSimple.new(defaults: {:some_stuff => ['bar']},args: %w[--some-stuff foo --some-stuff bar])
     o = os.parse_opts! do 
       option %w[-s --some-stuff] do | arg |
 	accumulate_opt arg
@@ -146,7 +167,7 @@ class TestHelpStatement < Test::Unit::TestCase
   end
 
   must "successfully pull out two options following a switch when desired" do 
-    o = OptSimple.new(nil,%w[--range 4 9]).parse_opts! do 
+    o = OptSimple.new(defaults: nil,args: %w[--range 4 9]).parse_opts! do 
       argument "--range","min,max" do | arg1, arg2 |
 	set_opt [arg1.to_i,arg2.to_i]
       end
@@ -155,7 +176,17 @@ class TestHelpStatement < Test::Unit::TestCase
     assert_equal o.range.first, 4
     assert_equal o.range.last, 9
   end
-
+  
+  must "successfully pull out two options with negative numbers following a switch when desired" do 
+    o = OptSimple.new(defaults: nil,args: %w[--range -4 9]).parse_opts! do 
+      argument "--range","min,max" do | arg1, arg2 |
+	set_opt [arg1.to_i,arg2.to_i]
+      end
+    end
+    
+    assert_equal o.range.first, -4
+    assert_equal o.range.last, 9
+  end
 
   must "allow for a variable number of options following a switch when a splat is used" do 
 
@@ -166,7 +197,7 @@ class TestHelpStatement < Test::Unit::TestCase
     arg_lists.each do |args | 
       # Gotta account for  '--whatever and --things switch in there'
       expected_len = args.length - 2
-      os = OptSimple.new(nil,args).parse_opts! do  
+      os = OptSimple.new(defaults: nil,args: args).parse_opts! do  
 	argument "--things" do | *arg |
 	  arg.each do |a|
 	    accumulate_opt a
@@ -184,7 +215,7 @@ class TestHelpStatement < Test::Unit::TestCase
   # Hmm ... just want to be flexible here. perhaps not necessary
   # Note you still gotta initialize things to an empty list to make it not nil
   must "allow for no options following an option defined with a splat" do
-    os = OptSimple.new({:things => [] },%w[--whatever --things]).parse_opts! do  
+    os = OptSimple.new(defaults: {:things => [] },args: %w[--whatever --things]).parse_opts! do  
       option "--things" do | *arg |
 	arg.each do |a|
 	  accumulate_opt a
@@ -196,4 +227,3 @@ class TestHelpStatement < Test::Unit::TestCase
     assert os.things.empty?
   end
 end
-

metadata

@@ -1,66 +1,52 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: opt-simple
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.9.12
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Ethan Stryker
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-27 00:00:00 +00:00
-default_executable: 
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies: []
-
-description: "  Parameter specification, validity checking and argument transformations \n  can be put in one place, default parameters are easily set, and an \n  automatic usage statement is constructed.\n"
+description: "  Parameter specification, validity checking and argument transformations
+  \n  can be put in one place, default parameters are easily set, and an \n  automatic
+  usage statement is constructed.\n"
 email: e.stryker@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/test_unit_extensions.rb
+files:
+- LICENSE.txt
+- README.md
+- extensions/test_unit_extensions.rb
 - lib/opt_simple.rb
-- lib/tmp.rb
-- test/test_help.rb
-- test/test_usage.rb
+- lib/test_unit_extensions.rb
 - test/test_arglist.rb
-- test/test_internals.rb
+- test/test_help.rb
 - test/test_return.rb
-- extensions/test_unit_extensions.rb
-- README
-- GPLv2-LICENSE
-has_rdoc: true
+- test/test_usage.rb
 homepage: http://opt-simple.rubyforge.org/
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_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 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: opt-simple
-rubygems_version: 1.6.2
+rubygems_version: 3.3.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple and elegant command line option parser.
 test_files: []
-

data/GPLv2-LICENSE

@@ -1,18 +0,0 @@
-OptSimple is a utility for parsing command line arguments. 
-Copyright (C) 2011  Ethan Stryker
-
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-
-Questions/Comments on OptSimple can be mailed to Ethan Stryker, e.stryker@gmail.com

data/lib/tmp.rb

@@ -1,63 +0,0 @@
-# in parse_opts!
-# now actually parse the args, and call all the stored up blocks from the options
-      @parameters.each do | parm |
-	intersection = @args & parm.switches
-	
-	unless intersection.empty?
-	  mandatory_check.delete(parm.switches)
-	  
-	  arg_locations =  []
-	  @args.each_with_index {|arg,i| arg_locations << i if intersection.include?(arg) }
-	  # ...  
-  def flag(switches,help="",&block)
-    parm = Flag.new(switches,help,&block)
-    parm.set_opt false
-    add_parameter parm 
-
-    # add it to the results to make checking flags nicer. 
-    # use the first name b/c they are all aliased anyways.
-    @results.merge! parm.param_options
-  end
-  
-  def option(switches,help="",metavar="ARG",&block)
-    parm = Option.new(switches,help,metavar,&block)
-    
-    # set the defaults, if there are any in the defaults hash
-    intersection = parm.names & @defaults.keys
-    if intersection.length == 1
-      parm.set_opt @defaults[intersection.first]
-      @results.merge! parm.param_options
-    elsif intersection.length > 1
-      raise OptSimple::Error "Clashes in the defaults for #{parm.switches}"
-    end
-    
-    add_parameter(parm)
-  end
-  
-   class Option < Parameter
-    attr_reader = :metavar
-    def initialize(switches,help="",metavar="ARG",&block)
-      super(switches,help,&block)
-      @metavar = metavar
-      unless block_given?
-	@block = Proc.new {|arg| @param_options[names.first] = arg}
-      end
-      @first_call = true # use this so we can accumulate non-defaults
-    end
-    def switch_len #:nodoc:
-      metavar_space = @metavar.empty? ? 0 : @metavar.length + 1 
-      super + metavar_space
-    end
-    def switch_str #:nodoc:
-      super + " #{@metavar}"
-    end
-    # append val to the parameter list
-    def accumulate_opt(val)
-      if @first_call
-	@param_options[names.first] = [val].flatten
-      else
-	@param_options[names.first] << val
-      end
-      @first_call = false
-    end
-  end

data/test/test_internals.rb

@@ -1,21 +0,0 @@
-require 'opt_simple'
-require 'test/unit' 
-require 'test_unit_extensions'
-
-class InternalsTest < Test::Unit::TestCase
-  def setup
-    @args = %w[infile1 -v infile2 -o out.txt infile3 -- -infile4 infile5]
-    @os = OptSimple.new({},@args)
-    @block = Proc.new {
-      flag '-v'
-      argument '-o'
-    }
-  end
-
-  must "not freeze strings" do
-    options = @os.parse_opts! &@block
-    assert_nothing_raised do 
-      options[:o].gsub!('.txt','.out')
-    end
-  end
-end