methodic 1.1 → 1.2

data/COPYRIGHT

@@ -1,4 +1,4 @@
-methodic Copyright (c) 2012 Ultragreen Software, Romain GEORGES
+methodic Copyright (c) 2012-2013 Ultragreen Software, Romain GEORGES
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/ChangeLog

@@ -15,3 +15,7 @@ methodic :
 - patched version
  - version 1.1 (RC2)
 	Romain GEORGES
+- stable version ( production ready)
+ - version 1.2 (stable)
+	Romain GEORGES
+   - NEW : conditions support see manual

data/Rakefile

@@ -15,7 +15,7 @@ require "roodi_task"
  
  
 RoodiTask.new() do | t |
-t.patterns = %w(lib/**/*.rb spec/**/*.rb features/**/*.rb)
+t.patterns = %w(lib/**/*.rb)
 t.config = "ultragreen_roodi_coding_convention.yml"
 end
 

data/doc/manual.rdoc

@@ -35,6 +35,8 @@ In a valid Ruby environment :
     myOptions = Methodic::get_options(_options) do |m|                                                                                                                                           
       m.specify_default_value_of :country => 'France'                                                                                                                                            
       m.specify_classes_of :name => String, :surname => String, :age => Fixnum, :country => String                                                                                               
+      aCond = Proc::new {|option| case options when 'Doe' then true else false end }                                                                                                                
+      m.specify_condition_for :name => aCond
       m.specify_presence_of :name                                                                                                                                                                
       m.specify_presence_of :surname                                                                                                                                                             
       m.specify_formats_of :name => /\w+/, :surname => /\w+/, :country => /\w+/                                                                                                                  
@@ -53,7 +55,9 @@ In a valid Ruby environment :
   def amethod ( _options = {})                                                                                                                                                                   
     myOptions = Methodic::get_options(_options,true) do |m|
       # all others definitions MUST be included in known options list (explained in Spec), so :                                                                                                             m.specify_known_options [:country,:name,:surname, :age]          
-      m.specify_default_value_of :country => 'France'                                                                                                                                            
+      m.specify_default_value_of :country => 'France'
+      aCond = Proc::new {|option| case options when 'Doe' then true else false end }                                                                                                                
+      m.specify_condition_for :name => aCond                                                                                                                                            
       m.specify_classes_of :name => String, :surname => String, :age => Fixnum, :country => String                                                                                               
       m.specify_presence_of :name                                                                                                                                                                
       m.specify_presence_of :surname                                                                                                                                                             
@@ -64,8 +68,30 @@ In a valid Ruby environment :
   end                                                                                                                                                                                    
   [...]  
 
+=== Remarque about conditions 
+
+
+* Condition MUST :
+
+- be ruby code
+- be a Proc Object
+- have an argument |option| who provide the option symbol, like :an_option
+- return true or false
+
+* Make your condition like
+
+
+   aCond = Proc::new do |option| 
+           case options
+             when .... then ...
+             when .... then ...
+             else ...
+           end
+   end
+ 
+
 
 == Copyright
 
-<pre>Methodic (c) 2012 Romain GEORGES <romain@ultragreen.net> for Ultragreen Software </pre>
+<pre>Methodic (c) 2012-2013 Romain GEORGES <romain@ultragreen.net> for Ultragreen Software </pre>
 

data/lib/methodic.rb

@@ -1,11 +1,35 @@
 #!/usr/bin/env ruby
-# Copyright Ultragreen (c) 2012
+# -*- coding: undecided -*-
+# Copyright Ultragreen (c) 2012-2�013
 #---
 # Author : Romain GEORGES 
 # type : gem component library 
 # obj : Methodic Module
 #---
 
+# inherited List class from Array to patch push for uniqness carateristique 
+class List < Array
+
+  # override of push for uniqness and flatten return
+  def push(*value) 
+    super(value)
+    self.flatten!
+    self.uniq!
+    return self
+  end
+
+
+  # override of << for uniqness and flatten return
+  def <<(*value)
+    super(value)
+    self.flatten!
+    self.uniq!
+    return self
+  end
+
+end
+
+
 # module Methodic 
 # @author Romain GEORGES <romain@ultragreen.net>
 # @see http://www.ultragreen.net/projects/methodic
@@ -20,6 +44,8 @@
 #      myOptions = Methodic::get_options(_options,true) do |m|
 #        m.specify_known_options [:country,:name,:surname,:age]
 #        m.specify_default_value :country => 'France'
+#        aCond = Proc::new {|option| case options when 'Doe' then true else false end } 
+#        m.specify_condition_for :name => aCond
 #        m.specify_classes_of :name => String, :surname => String, :age => Fixnum, :country => String
 #        m.specify_presence_of :name
 #        m.specify_presence_of :surname
@@ -43,6 +69,8 @@ module Methodic
   #      myOptions = Methodic::get_options(_options,true) do |m|
   #        m.specify_known_options [:country,:name,:surname,:age]
   #        m.specify_default_value :country => 'France'
+  #        aCond = Proc::new {|option| case options when 'Doe' then true else false end } 
+  #        m.specify_condition_for :name => aCond
   #        m.specify_classes_of :name => String, :surname => String, :age => Fixnum, :country => String
   #        m.specify_presence_of :name
   #        m.specify_presence_of :surname
@@ -98,12 +126,22 @@ module Methodic
     # @example writing
     #   myOptions = Methodic::get_options(options)
     #   myOptions.formats = {:name => /\w+/ }
-    #   myOptions.defaults[:surname] = /\w+/
+    #   myOptions.formats[:surname] = /\w+/
     # @example reading
     #   p myOptions.defaults 
     #   => { :name => /\w+/, :surname => /\w+/ }
     attr_accessor :formats
     
+    # @attr [Hash] conditions a hash table of some conditions with their corresponding
+    # @example writing
+    #   myOptions = Methodic::get_options(options)
+    #   myOptions.conditions = {:name => aProcObject }
+    #   myOptions.conditions[:surname] = aProcObject
+    # @example reading
+    #   p myOptions.defaults 
+    #   => { :name => /\w+/, :surname => /\w+/ }
+    attr_accessor :conditions
+
     # initializer for [Options]
     # @note please do not use standalone, build from module method Methodic::get_options
     # @param [Hash] _options the options hash (define for the method you would prototype)
@@ -116,11 +154,12 @@ module Methodic
       raise ArgumentError::new('Argument _options must be a Hash') unless _options.class == Hash or _options.class == Methodic::Options # ;) reintrance and cascading
       raise ArgumentError::new('keys must be Symbol') unless _options.keys.select{|i| i.class == Symbol }.size ==  _options.keys.size 
       self.replace _options
+      @conditions = Hash::new
       @defaults = Hash::new
       @formats = Hash::new
       @classes = Hash::new
-      @known = Array::new
-      @mandatories = Array::new
+      @known = List::new
+      @mandatories = List::new
       @validate_known_options = _validate_known_options
       yield self if block_given?
     end
@@ -161,13 +200,27 @@ module Methodic
     #    myOptions.specify_class_of :name => String
     #    myOptions.specify_classes_of :name => String, :surname => String
     def specify_class_of(values)
-
       @classes.merge! values
-
       return @classes
-
     end
     alias :specify_classes_of :specify_class_of
+
+    # pretty accessor for specifying conditions for options
+    # @param [Hash] values a Conditions Proc definition, keys are symbols
+    # @return [hash] @conditions merged with values
+    # @note Conditions must be precised in Ruby as a Proc Object returning a boolean
+    # @note Convention : Proc MUST return true or false ONLY ( false trigged the exception raising )
+    # @example usage
+    #    myOptions = Methodic::get_options(_options)
+    #    myOptions.specify_condition_for :name => aProcObject
+    #    myOptions.specify_conditions_for :name => aProcObject, :surname => aProcObject
+    def specify_condition_for(values)
+      @conditions.merge! values
+      return @conditions
+    end
+    alias :specify_conditions_for :specify_condition_for
+
+
     
     # pretty accessor for specifying mandatories options
     # @param [Array] values a Array of symbols or a unique symbol
@@ -176,7 +229,7 @@ module Methodic
     #    myOptions = Methodic::get_options(_options)
     #    myOptions.specify_presence_of :name 
     #    myOptions.specify_presences_of [ :name, :surname ]
-    def specify_presence_of(values) 
+    def specify_presence_of(*values) 
       @mandatories << values
       @mandatories.flatten!
       @mandatories.uniq!
@@ -192,7 +245,7 @@ module Methodic
     #    myOptions = Methodic::get_options(_options)
     #    myOptions.specify_known_option :name 
     #    myOptions.specify_known_options [ :name, :surname ]
-    def specify_known_option(values) 
+    def specify_known_option(*values) 
       @known << values
       @known.flatten!
       @known.uniq!
@@ -214,12 +267,6 @@ module Methodic
     end
     alias :specify_formats_of :specify_format_of
     
-    # pretty accessor for specifying condition for options
-    # @todo implementation of conditions
-    def specify_condition_for
-      raise NotYetImplemented
-    end
-    alias :specify_conditions_for :specify_condition_for
     
     # default values merge method 
     # merge @defaults with self 
@@ -248,7 +295,7 @@ module Methodic
       table.push validate_classes unless @classes.empty?
       table.push validate_presences unless @mandatories.empty?
       table.push validate_formats unless @formats.empty?
-
+      table.push validate_conditions unless @conditions.empty?
       return true unless table.include?(false) 
     end
     alias :validate! :validate
@@ -289,10 +336,20 @@ module Methodic
       end
       return true
     end
-    
+
+    # private method for conditions validation step
+    def validate_conditions
+      @conditions.each do |option,cond|
+        raise ArgumentError::new("Option : #{option} condition failed") and return false unless cond.call(self[option]) == true
+      end
+      return true
+    end
+
+
     # private method for classes validation step
     def validate_classes
       @classes.each do |option,value|
+
         raise ArgumentError::new("Option : #{option} type mismatch must be a #{value}") and return false unless self[option].class == value
       end
       return true
@@ -311,8 +368,5 @@ module Methodic
     return Methodic::Options::new(_options,_validate_known_options)
   end
  
-  # Exception Class for not yet implemented methods Exceptions
-  class NotYetImplemented < Exception; end
-
 
 end

data/methodic.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = %q{methodic}
   s.author = "Romain GEORGES"
-  s.version = "1.1"
-  s.date = %q{2013-02-14}
+  s.version = "1.2"
+  s.date = %q{2013-02-18}
   s.summary = %q{Methodic : Hash table options specification and validation componant}
   s.email = %q{romain@ultragreen.net}
   s.homepage = %q{http://www.ultragreen.net}

data/spec/methodic_spec.rb

@@ -9,7 +9,7 @@ describe Methodic do
     $test_methodic_options_with_known_options = Methodic::get_options({:name => 'Doe', :surname => 'John'},true)
   end
   before :each do 
-    $test_methodic_options.mandatories = []
+    $test_methodic_options.mandatories.clear
     $test_methodic_options.formats = {}
     $test_methodic_options.defaults = {}
     $test_methodic_options.classes = {}
@@ -91,33 +91,70 @@ describe Methodic do
         end
       end
 
+      context "#conditions R/W" do
+        it { $test_methodic_options.should respond_to("conditions") }
+        it { $test_methodic_options.should respond_to("conditions=") }
+        
+        it "should be true that #conditions must return a Hash" do
+            $test_methodic_options.conditions.class.should eq(Hash)
+        end
+        it "#formats[] affectation must be possible and #formats must respond this affectation" do
+          aCond = Proc::new do |option| case option
+                                         when 'Doe' then true
+                                         else false
+                                       end
+          end
+          $test_methodic_options.conditions[:name] = aCond 
+          $test_methodic_options.conditions.should eq({ :name => aCond })
+        end
+      end
+
       context "#mandatories R/W" do
         it { $test_methodic_options.should respond_to("mandatories") }
         it { $test_methodic_options.should respond_to("mandatories=") }
 
-        it "should be true that #mandatories must return a Array" do
-            $test_methodic_options.mandatories.class.should eq(Array)
+        it "should be true that #mandatories must return a List < Array" do
+            $test_methodic_options.mandatories.class.should eq(List)
         end
         it "#mandatories.push affectation must be possible and #mandatories must respond this affectation" do
           $test_methodic_options.mandatories.push :test
           $test_methodic_options.mandatories.should eq([:test])
         end
+        context "#mandatories.push" do
+          it "should not duplicate entry"do
+            $test_methodic_options.mandatories.push :test
+            $test_methodic_options.mandatories.push :test
+            $test_methodic_options.mandatories.count(:test).should eq 1
+          end
+        end
       end
+
+
       context "#known R/W" do
         it { $test_methodic_options.should respond_to("known") }
         it { $test_methodic_options.should respond_to("known=") }
         
-        it "should be true that #known must return a Array" do
-            $test_methodic_options.known.class.should eq(Array)
+        it "should be true that #known must return a List < Array" do
+            $test_methodic_options.known.class.should eq(List)
         end
         it "#known.push affectation must be possible and #known must respond this affectation" do
           $test_methodic_options.known.push :test
           $test_methodic_options.known.should include :test
         end
+        context "#known.push" do
+          it "should not duplicate entry" do
+            $test_methodic_options.known.push :test
+            $test_methodic_options.known.push :test
+            $test_methodic_options.known.count(:test).should eq 1
+          end
+        end
       end
     end
     context "Instance methods" do
       
+
+
+
       context "#options" do
         it { $test_methodic_options.should respond_to("options") }
         it "should be true that #options must return a Array" do
@@ -172,7 +209,33 @@ describe Methodic do
       context "#specify_condition_for" do
         it { $test_methodic_options.should respond_to("specify_condition_for") }
         it { $test_methodic_options.should respond_to("specify_conditions_for") }
-        it { lambda{ $test_methodic_options.specify_condition_for}.should raise_error Methodic::NotYetImplemented }
+        it "should merge condition hash record in conditions attribut" do
+          aCond = Proc::new do |option| case option
+                                         when "Doe" then true
+                                         else false
+                                       end
+          end
+          $test_methodic_options.specify_condition_for :name => aCond 
+          $test_methodic_options.conditions[:name].should eq aCond
+          $test_methodic_options.conditions.count.should eq 1
+        end
+        it "should redefine a new class value for a previous key" do
+          aCond = Proc::new do |option| case option
+                                         when "Doe" then true
+                                         else false
+                                       end
+          end
+          newCond = Proc::new do |option| case option
+                                         when "DoeLittle" then true
+                                         else false
+                                       end
+          end
+          $test_methodic_options.specify_condition_for :name => aCond 
+          $test_methodic_options.conditions[:name].should eq aCond
+          $test_methodic_options.specify_condition_for :name => newCond 
+          $test_methodic_options.conditions[:name].should eq newCond
+          $test_methodic_options.conditions = {}
+        end
       end
 
       context "#specify_format_of" do
@@ -203,6 +266,10 @@ describe Methodic do
           $test_methodic_options.mandatories.should include(:test)
           $test_methodic_options.mandatories.count.should eq 1
         end
+        it "should be possible to give arguments list of symbols" do
+          $test_methodic_options.specify_presences_of :test2, :test3, :test4
+          $test_methodic_options.specify_presences_of [ :test5, :test6 ], :test7
+        end
       end
 
       context "#specify_known_option" do
@@ -216,6 +283,11 @@ describe Methodic do
           $test_methodic_options.known.should include(:test)
           $test_methodic_options.known.count.should eq 1
         end
+        it "should be possible to give arguments list of symbols" do
+          $test_methodic_options.specify_known_options :test2, :test3, :test4
+          $test_methodic_options.specify_known_options [ :test5, :test6 ], :test7
+          
+        end
       end
 
       context "#validate" do
@@ -337,6 +409,30 @@ describe Methodic do
             lambda{$test_methodic_options.validate!}.should_not raise_error ArgumentError
           end
         end
+        context "5/ validate conditions" do
+          it "should raise ArgumentError if an option in options list not validate a registered condition" do
+            $test_methodic_options.conditions = {}
+            aCond = Proc::new do |option| case option
+                                            when 'DoeLittle' then true
+                                            else false
+                                          end
+            end
+            $test_methodic_options.specify_condition_for :name => aCond
+            lambda{$test_methodic_options.validate!}.should raise_error ArgumentError
+
+          end
+          it "should not raise if all options in options list match formats definitions " do
+           $test_methodic_options.conditions = {}
+            aCond = Proc::new do |option| case option
+                                          when 'Doe' then true
+                                          else false
+                                          end
+            end
+            $test_methodic_options.specify_condition_for :name => aCond
+            lambda{$test_methodic_options.validate!}.should_not raise_error ArgumentError
+          end
+        end
+
 
 
       end 

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: methodic
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 11
+  prerelease: 
   segments: 
   - 1
-  - 1
-  version: "1.1"
+  - 2
+  version: "1.2"
 platform: ruby
 authors: 
 - Romain GEORGES
@@ -13,16 +14,18 @@ autorequire:
 bindir: 
 cert_chain: []
 
-date: 2013-02-14 00:00:00 +01:00
+date: 2013-02-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
         - 0
@@ -67,25 +70,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 53
       segments: 
       - 1
       - 8
       - 1
       version: 1.8.1
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.3.6
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: "Methodic : Hash table options specification and validation componant"