option_list 0.1.6 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTZjYWUzNDczZmFlZTFhNTNlNTU0YmEzZjYzNGM1OTUzZDJmNTdjNw==
+    MGE1NTkyMWExYjVhYmY1MzJjZmQyOWM2ODVlNmMwNWNmNjVhM2QxYg==
   data.tar.gz: !binary |-
-    OTljOTcyODI0MDIyNzgxYjE3ZTkzNjQyOWUwZDk5NTgyZGVjYTAzMQ==
-!binary "U0hBNTEy":
+    NjAyN2M4NWQ2OGRiZGRjNWY5MTU5MGE4NjMwYjUzNzYwZjNhMDI3MQ==
+SHA512:
   metadata.gz: !binary |-
-    ODg1OWYxZGU0YmU1MmYyYjRmMTZlOGE1NGZlYWYzMDlmOTY2MjRlZmM1NzM3
-    YTRjODM2ZDUyYzk2MDRiOGY3OWY3MmM4Zjk4ZTJiMWU3ZTRkMDcyZDQwZmZk
-    OWUwMzRiYTMyNjcyZmZmNzYzOGYyMGZmMWNmZmQ3OWQyM2JhMGU=
+    MzljNzk3MzI0NjM5ZTM5NmZiZDY4YjlmMWUzNThiODc5ZjJmZmE5NjliMTk0
+    NGQ3ZThjNThiNTE0ZTExNGVkYmRlMGZkNzYyNDcxZjcwOWZiMTAxMjIzYmI5
+    YmI1OWZjNjM4MjFjNDJkMTVjM2EwNzc3NDExNDc3OWZjMTJiMTk=
   data.tar.gz: !binary |-
-    Y2VhZjdhNDFhMjlhNDdlZjRjNTJhMmFkM2NlMTE4YTg5YzE4YmVkYWY5M2I0
-    NmVmMWFhMWE0OWQ1YTdlZDEyNmZkZDNkZWI3MjM4NjFhYmEwNjFlNGIxZWJi
-    MDU0OTMwODUyNDQzZDI5ZGQzN2MyYmUyZGU2ZGRiODk3MWIxNzA=
+    M2E4MmM2NjdjNjQ4MDA0ZmRjNDcyZGE1YTVmZjU0NmY4NTA4MDcxZDJkOGYy
+    YWI5ODBiNTMzNTU4ZjIxZTQzMjI1YjNmNTkwNjc0ZDAwNWQ5ODJhOGFlNzFi
+    YjRmMTkyYThhYTdmNDYwNThhM2ZiNDhjYWNiNTA3ODg3MzI4MjM=

data/option_list.rb

@@ -69,6 +69,10 @@ class OptionList
   #==== Parameters:
   #* option_specs - The comma separated option specs, made into an array by the
   #  splat operator.
+  #* select_block - An optional block of code that is called when selections
+  #  have been made. This allows for custom validations to be applied at that
+  #  point. This block should accept one argument, a reference to the option
+  #  list object that is calling it for validation.
   #==== Dynamic Methods:
   #As option specs are added, new methods are created to allow for easy access
   #to the option information. If the above example were processed, the following
@@ -79,11 +83,12 @@ class OptionList
   #* page_len - would return the value of the :page_len category.
   #==== Exceptions:
   #* ArgumentError for a number of invalid argument conditions.
-  def initialize(*option_specs)
+  def initialize(*option_specs, &select_block)
     @categories = Hash.new
     @default    = Hash.new
     @selected   = Hash.new
     do_add_specs(option_specs)
+    @select_block = select_block
   end
   
   #Add additonal option specifications to the option list. See the method new
@@ -198,9 +203,13 @@ class OptionList
   #  all of the default values will be selected.
   #==== Exceptions:
   #* ArgumentError for a number of invalid argument conditions.
+  #==== Notes:
+  #After processing the selections, the selection block is called if one was
+  #defined in by the constructor.
   def select(selections=[])
     @selected = @default.clone
     add_selections(selections)
+    @select_block.call(self) unless @select_block.nil?
   end
 
   #Add/override additional selections to the option_list. See the select method
@@ -220,6 +229,12 @@ class OptionList
     end
   end
   
+  #Call the selection block if one was defined in by the constructor. This 
+  #method must be used if selections are added with add_selections.
+  def validate
+    @select_block.call(self) unless @select_block.nil?
+  end
+  
   private  #Some more privacy, please!
   
   #Process a symbolic option selection.
@@ -252,6 +267,8 @@ class OptionList
       @selected[cat] = value
     end
   end
+
+  public
   
   #Fail with an argument error.
   def fAE(msg)

data/option_list_test.rb

@@ -5,9 +5,25 @@ require_relative 'option_list'
 require          'minitest/autorun'
 
 class OptionListTester < MiniTest::Unit::TestCase
+  $do_this_only_one_time = true
+  
+  def initialize(*all)
+    if $do_this_only_one_time
+      puts "Testing file: option_list.rb" 
+      $do_this_only_one_time = false
+    end
+    
+    super(*all)
+  end
+
   def setup
     @ol1 = OptionList.new([:history, :history, :nohistory], {:pg_len => 42})
     @ol2 = OptionList.new([:history, nil, :history, :nohistory]) 
+    @ol3 = OptionList.new([:history, nil, :history, :nohistory],
+                          {:fuel1=>:matter, :fuel2=>:antimatter}) do |opt|
+      opt.fAE "The :history option must be set." if opt.history.nil?
+      opt.fAE "Improper fuel mix." unless opt.fuel1 == :matter && opt.fuel2 == :antimatter
+    end
   end
 
   def test_that_it_rejects_bad_specs
@@ -241,4 +257,9 @@ class OptionListTester < MiniTest::Unit::TestCase
     refute(@ol2.nohistory?)
     assert(@ol2.history.nil?)
   end
+  
+  def test_that_the_select_block_works
+    assert_raises(ArgumentError) { @ol3.select() }    
+    assert_raises(ArgumentError) { @ol3.select({:history=>:nohistory, :fuel2=>:matter}) }    
+  end
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: option_list
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-09-22 00:00:00.000000000 Z
 dependencies: []
-description: A unified handler for flexible function option parameters.
+description: A unified handler for flexible function option parameters. Please see
+  the homepage for docs.
 email: peter.c.camilleri@gmail.com
 executables: []
 extensions: []
@@ -18,16 +19,14 @@ extra_rdoc_files: []
 files:
 - option_list.rb
 - option_list_test.rb
-homepage: http://teuthida-technologies.com/
+homepage: http://teuthida-technologies.com/?p=1506
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- --output=doc
-- option_list.rb
+rdoc_options: []
 require_paths:
-- lib
+- .
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
@@ -41,7 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - No special requirements.
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.1.4
 signing_key: 
 specification_version: 4
 summary: A unified handler for flexible function option parameters.