option_list 1.0.3 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDA0MjBiNDdkNWRhMzgzMzBkYWJiMjhiOGUxNTA3YmE5ZjI3Y2Q4OA==
+    OWQxY2I0ZTM2NjM1OTBiZDU2MWNmZDk4MjcyMDQ1ZGUzYWQzNDcyMA==
   data.tar.gz: !binary |-
-    MmIzZGRjZDc0YWRlYTgxNWUyY2VjMWI2MTBmNjg3NGIzZjFlMmMzMg==
+    NDUyZWQxNmQ5MzMwZTkzZThhZTFjNzhjMTNmN2Y4ZmY1NDU2N2RmNQ==
 SHA512:
   metadata.gz: !binary |-
-    MWE0ZjhiZmU0ZmMxYmUzY2VjMDFiZjM5MDU4MjQwODg2NjUwODExNzk0NWVh
-    NGU2ZmQ1OGU3NzRkOGQ1ZTY2ZDI2ODg2NWU3OGQ1YWU1N2E2ZGZlYTQzZWRm
-    NTUyYTdmM2VjYTVlOTcwYTFhODdjNTc4NzBhYjk5MDQyZWQ1MTU=
+    ZGNhMjA2NjExMzNjNDAzNzdjNmZmODJkODg1NmQwZDYzOTg2MTkxNTFiMDUx
+    MmU1NGFkMTMzZGE1MjI1MzU3MWE2M2U3MzEwMDEwYWYyNDI0YmIzYjk4MGQx
+    NDM3NjEwNTEwYzkxY2YxNjY5MWJmZjc0NDY3NmU3MmMyZmE4NGU=
   data.tar.gz: !binary |-
-    NmRiN2NmMjM3OGFkYjcwMThjNjc5MzU1MjM3ODlkODIzNGE4YzZhMTliYzhh
-    YWNkZTNhNjE4MDgwZTc2NzE0Y2QzNzkzOWIwYTJiOWQzMmU0NGEzOTI1MTFl
-    ZTUxZTAwOTAzZTc0YjBmMTYyNTEyOGMxODI4NTFmYjI5ZWE2ZmI=
+    ZDViOTVkN2U5NjMyZDNlYjliZDdlODk2NTM2MzFiZTJmMDExOThjNzhhOTMw
+    MTM1Yjk5ZTEwNjBiYTE2NmQzNzRkYWI4OWIyM2JhNGIwMGY2NzRiNGE2Zjli
+    MGJmMjMyYjliNDAzNmVmYmY2MGM1MzBmMzg1ODE1NGEwMDgzZTM=

data/{option_list.rb → lib/option_list.rb}

@@ -38,11 +38,15 @@ require 'set'
 #\OptionList class itself, it is reasonable to assume that a function option
 #handler could very easily end up embedded in such an environment. In fact, my
 #first major test of the class ran into this exact issue.
+#=== Version 1.1.0
+#Added a default value of false to signify that no default exists for a 
+#mandatory parameter.
+#Modified processing of array specs to avoid side effects in the parameters.
 class OptionList
 
   #The option list code version.
   def self.version
-    '1.0.1'
+    '1.1.0'
   end
   
   #The option list code version. This is a redirect to the class method.
@@ -60,8 +64,12 @@ class OptionList
   #In this form of specification, the first element of the array is the
   #category of the option, and the second and following entries are the 
   #allowed values for that category. The second element has a special role. It
-  #is the default value for the category. Only this value may be nil to have 
-  #no default value. The symbols used in each category must be unique.
+  #is the default value for the category. This value may be one of:
+  #* A symbol - The default symbolic value for this option.
+  #* nil - The default value is nil and this setting is optional.
+  #* false - There is no default value and this setting is mandatory.
+  #The symbols used in each category must be unique across
+  #all of the categories in the option list.
   #==== Hash Specification
   #Hash specifications are used to specify options that do not have a fixed set
   #of possible values. In this form of specification, the hash key symbol is 
@@ -89,6 +97,7 @@ class OptionList
   #* ArgumentError for a number of invalid argument conditions.
   def initialize(*option_specs, &select_block)
     fAE "Missing option specifications." if option_specs.empty?
+    @mandatory  = Array.new
     @categories = Hash.new
     @default    = Hash.new
     
@@ -118,10 +127,9 @@ class OptionList
   #Some examples:
   # o = foo(:sedan, :turbo)
   # o = foo({:style=>:sedan})
-  # o = foo({:page_len=>60})
-  # o = foo(:sedan, :turbo, {:page_len=>60})
-  # o = foo({:style=>:sedan, :page_len=>60})
-  # o = foo({:style=>:sedan}, {:page_len=>60})
+  # o = foo(page_len: 60) 
+  # o = foo(:sedan, :turbo, page_len: 60)
+  # o = foo(style: :sedan, page_len: 60)
   #=== Passing in option data:
   #The caller of this method may pass these options in a number of ways:
   #==== Array (via a splat)
@@ -144,6 +152,7 @@ class OptionList
   #==== Hash
   #Options may also be passed via a hash.
   # test(34, 53, 76, 'hike!', {:history=>:history, :page_len=>55})
+  # test(34, 53, 76, 'hike!', history: :history, page_len: 55)
   #==== Symbol
   #If only a single option is required, it can be passed simply as:
   # test(34, 53, 76, 'hike!', :history)
@@ -152,7 +161,7 @@ class OptionList
   #  with the splat operator. Note that if select is called with no arguments,
   #  all of the default values will be selected.
   #==== Returns:
-  #An option value object wich is a singleton subclass of the Hash class.
+  #An option value object which is a singleton subclass of the Hash class.
   #==== Exceptions:
   #* ArgumentError for a number of invalid argument conditions.
   #==== Notes:
@@ -173,6 +182,10 @@ class OptionList
       end
     end
     
+    @mandatory.each do |cat|
+      fAE "Missing mandatory setting #{cat}" unless selected[cat]
+    end
+    
     @select_block.call(selected) unless @select_block.nil?
     selected
   end
@@ -187,14 +200,16 @@ class OptionList
   #Process an array spec that lists all the valid values for an option. See
   #the new method for more information on these specs.
   def array_spec(spec)
-    cat = spec.delete_at(0)
+    cat = spec[0]
+    spec = spec[1...spec.length]
+    
     fAE "Found #{cat.class}, expected Symbol." unless cat.is_a?(Symbol)   
     fAE "Duplicate category: #{cat}" if @default.has_key?(cat)
     fAE "Invalid number of entries for #{cat}." unless spec.length > 1
     @default.define_singleton_method(cat) { self[cat] }
-
+    
     spec.each_with_index do |opt, index|
-      if opt != nil
+      if opt
         fAE "Found #{opt.class}, expected Symbol." unless opt.is_a?(Symbol)   
         fAE "Duplicate option: #{opt}" if @categories.has_key?(opt)
         
@@ -203,9 +218,10 @@ class OptionList
         @default.define_singleton_method(qry) { self[cat] == opt }
         @default[cat] = opt if index == 0
       elsif index == 0
-        @default[cat] = nil
+        @default[cat] = opt
+        @mandatory << cat if opt == false
       else
-        fAE "The value nil is only allowed as the default option."
+        fAE "The values nil/false are only allowed as the default option."
       end
     end
   end
@@ -222,7 +238,7 @@ class OptionList
       @default.define_singleton_method(cat) { self[cat] }
       @categories[cat] = value_entry
       @default[cat] = value    
-    end  
+    end
   end
   
   #Process a symbolic option selection.

data/rakefile.rb

@@ -5,11 +5,11 @@ require 'rdoc/task'
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = "rdoc"
   #rdoc.main = "option_list.rb"
-  rdoc.rdoc_files = ['option_list.rb', 'option_list_test.rb', 'license.txt']
+  rdoc.rdoc_files = ['lib/option_list.rb', 'tests/option_list_test.rb', 'license.txt']
   rdoc.options << '--visibility' << 'private'
 end
 
 Rake::TestTask.new do |t|
-  t.test_files = ['option_list_test.rb']
+  t.test_files = ['tests/option_list_test.rb']
   t.verbose = false
 end

data/{option_list_test.rb → tests/option_list_test.rb}

@@ -1,7 +1,7 @@
 #A formal testing frame for the option list class.
 #Execute this file to perform the tests.
 
-require_relative 'option_list'
+require_relative '../lib/option_list'
 require          'minitest/autorun'
 
 class OptionTest
@@ -197,6 +197,29 @@ class OptionListTester < MiniTest::Unit::TestCase
     assert(o.history.nil?)
   end
   
+  def test_that_mandatory_parms_work
+    ol2 = OptionList.new([:history, false, :history, :nohistory]) 
+
+    o = ol2.select([:history])
+    assert(o.history?)
+    refute(o.nohistory?)
+    assert_equal(o.history, :history)
+
+    o = ol2.select([:nohistory])
+    assert(o.nohistory?)
+    refute(o.history?)
+    assert_equal(o.history, :nohistory)
+
+    assert_raises(ArgumentError) { ol2.select() }
+  end
+  
+  def test_that_it_does_not_munge_parms
+    parm1 = [:history, false, :history, :nohistory]
+    parm2 = parm1.clone
+    ol2 = OptionList.new(parm1)
+    assert_equal(parm1, parm2)
+  end
+  
   def test_that_the_select_block_works
     ol3 = OptionList.new([:history, nil, :history, :nohistory],
                           fuel1: :matter, fuel2: :antimatter) do |opt|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: option_list
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,18 +45,18 @@ extensions: []
 extra_rdoc_files:
 - license.txt
 files:
-- option_list.rb
-- option_list_test.rb
+- lib/option_list.rb
+- tests/option_list_test.rb
 - rakefile.rb
 - license.txt
-homepage: http://teuthida-technologies.com/?p=1506
+homepage: http://teuthida-technologies.com/
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- .
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
@@ -74,4 +74,4 @@ signing_key:
 specification_version: 4
 summary: A unified handler for flexible function option parameters.
 test_files:
-- option_list_test.rb
+- tests/option_list_test.rb