methodic 1.2 → 1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1707f3f27d5350def0846240d4c4f7582b05b2b1f3b6aac5b7d9415be25f81fc
+  data.tar.gz: 74cbf27c2cbbb5cb62864200b8589d68ecc9a40ea723a1dbe97dfaa0b0a5e630
+SHA512:
+  metadata.gz: 6b9bbf2c528d99307321a8d687be03907aabbd8cba955feddfe739744ae1fc22f020a8f95cb5b30cd003700774bee08945a1a82f4d10f1d533c45719a4f04bf1
+  data.tar.gz: 8749230565c40f51376ac2a444e7422297f87186184e2f14edd3769b02cbd3960df19f00fc5cef84083826def98615ccc0655f15c367b079fd98874fb07bd4ba

data/ChangeLog

@@ -16,6 +16,8 @@ methodic :
  - version 1.1 (RC2)
 	Romain GEORGES
 - stable version ( production ready)
- - version 1.2 (stable)
+ - version 1.2 (depricated)
 	Romain GEORGES
    - NEW : conditions support see manual
+ - version 1.3 (STABLE)
+  - update for compatibility

data/Gemfile

@@ -4,5 +4,4 @@ gem "rspec", :require => "spec"
 gem "rake"
 gem "yard"
 gem "rdoc"
-gem "rcov"
 gem "roodi"

data/{doc/manual.rdoc → README.md}

@@ -1,32 +1,39 @@
-=Methodic
+# Methodic
 
-== Content
+## Content
 
-Author:: Romain GEORGES <romain@ultragreen.net> 
-Version:: 1.2
-WWW:: http://www.ultragreen.net/projects/methodic
+* Author : Romain GEORGES <romain@ultragreen.net> 
+* Version : 1.2
+* WWW : http://www.ultragreen.net/projects/methodic
 
-== Description 
+
+[![Build Status](https://travis-ci.org/lecid/methodic.png?branch=master)](https://travis-ci.org/lecid/methodic) [![CodeClimate](https://codeclimate.com/github/lecid/methodic.png)](https://codeclimate.com/github/lecid/methodic)
+[![Dependency Status](https://gemnasium.com/lecid/methodic.png)](https://gemnasium.com/lecid/methodic)
+[![Gem Version](https://badge.fury.io/rb/methodic.png)](http://badge.fury.io/rb/methodic)
+
+## Description 
 
 Methodic is a macro-like utility to help test, validate, control options passed by an Hash param to a method, it could help you to merge with defaults values, 
 It raise explained exceptions and return false if the validations steps failed.
 
-== Installation
+## Installation
 
 In a valid Ruby environment :
 
+```
    $ sudo zsh
    # gem ins methodic
-
-== Implementation 
+```
+## Implementation 
 
 * [Methodic]
 * [Methodic::Options]
 
-== Example
+## Examples
 
-=== Without known options control
+### Without known options control
 
+```ruby
   require 'rubygems'                                                                                                                                                                             
   require 'methodic'
   [...]                                                                                                                                                                                          
@@ -45,9 +52,11 @@ In a valid Ruby environment :
     # processing method                                                                                                                                                                          
   end                                                                                                                                                                                    
   [...]  
+```
 
-=== With known options control
+### With known options control
 
+```ruby
   require 'rubygems'                                                                                                                                                                             
   require 'methodic'
   [...]                                                                                                                                                                                          
@@ -67,8 +76,9 @@ In a valid Ruby environment :
     # processing method                                                                                                                                                                          
   end                                                                                                                                                                                    
   [...]  
+```
 
-=== Remarque about conditions 
+### Remarque about conditions 
 
 
 * Condition MUST :
@@ -80,7 +90,7 @@ In a valid Ruby environment :
 
 * Make your condition like
 
-
+```ruby
    aCond = Proc::new do |option| 
            case options
              when .... then ...
@@ -88,10 +98,10 @@ In a valid Ruby environment :
              else ...
            end
    end
- 
+```
 
 
-== Copyright
+## Copyright
 
 <pre>Methodic (c) 2012-2013 Romain GEORGES <romain@ultragreen.net> for Ultragreen Software </pre>
 

data/Rakefile

@@ -1,19 +1,19 @@
+# coding: utf-8
+require "bundler/gem_tasks"
 require 'rubygems'
-
 require 'rspec'
 require 'rake'
 require "rake/clean"
 require "rubygems/package_task"
 require "rdoc/task"
-require 'code_statistics'
 require 'rspec/core/rake_task'
 require 'yard'
 require 'yard/rake/yardoc_task.rb'
 require "rake/tasklib"
 require "roodi"
 require "roodi_task"
- 
- 
+require 'code_statistics'
+
 RoodiTask.new() do | t |
 t.patterns = %w(lib/**/*.rb)
 t.config = "ultragreen_roodi_coding_convention.yml"
@@ -32,12 +32,12 @@ RSpec::Core::RakeTask.new('spec')
 
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = [ 'lib/**/*.rb', '-', 'doc/**/*','spec/**/*_spec.rb']			   
+  t.files   = [ 'lib/**/*.rb', '-', 'doc/**/*','spec/**/*_spec.rb']
   t.options += ['--title', "Gem Documentation"]
   t.options += ['-o', "yardoc"]
   t.options += ['-r', "doc/manual.rdoc"]
 end
-YARD::Config.load_plugin('yard-rspec') 
+YARD::Config.load_plugin('yard-rspec')
 
 namespace :yardoc do
   task :clobber do
@@ -60,4 +60,10 @@ Rake::RDocTask.new('rdoc') do |d|
   d.options << '--line-numbers' << '--diagram' << '-SHN'
 end
 
-task :default => [:gem]
+task :default => [:gem]
+
+task :stage do
+  Rake::Task["clean"].invoke
+  Rake::Task["clobber"].invoke
+  Rake::Task["install"].invoke
+end

data/lib/methodic.rb

@@ -1,17 +1,18 @@
-#!/usr/bin/env ruby
-# -*- coding: undecided -*-
-# Copyright Ultragreen (c) 2012-2�013
+# coding: utf-8
+# Copyright Ultragreen (c) 2012-2Â013
 #---
-# Author : Romain GEORGES 
-# type : gem component library 
+# Author : Romain GEORGES
+# type : gem component library
 # obj : Methodic Module
 #---
 
-# inherited List class from Array to patch push for uniqness carateristique 
+require 'drb'
+
+# 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) 
+  def push(*value)
     super(value)
     self.flatten!
     self.uniq!
@@ -30,12 +31,12 @@ class List < Array
 end
 
 
-# module Methodic 
+# module Methodic
 # @author Romain GEORGES <romain@ultragreen.net>
 # @see http://www.ultragreen.net/projects/methodic
 # @version 0.2
 # @note this module include a class, but please use the module method Methodic::get_options to Build a Methodic::Options instance
-# @example Complete usage 
+# @example Complete usage
 #    require 'rubygems'
 #    require 'methodic'
 #    [...]
@@ -44,7 +45,7 @@ end
 #      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 } 
+#        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
@@ -60,7 +61,7 @@ module Methodic
   # class Options
   # an Options utility class
   # @note please do not instantiate with Options::new use Methodic::get_options
-  # @example Complete usage 
+  # @example Complete usage
   #    require 'rubygems'
   #    require 'methodic'
   #    [...]
@@ -69,7 +70,7 @@ 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 } 
+  #        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
@@ -87,17 +88,17 @@ module Methodic
     #   myOptions.known = [:name]
     #   myOptions.known.push :surname
     # @example reading
-    #   p myOptions.known 
+    #   p myOptions.known
     #   => [ :name, :surname ]
-    # @attr [Hash] the list of all options assumed for a method 
+    # @attr [Hash] the list of all options assumed for a method
    attr_accessor :known
-    
+
     # @example writing
     #   myOptions = Methodic::get_options(options)
     #   myOptions.classes = {:name => String }
     #   myOptions.classes[:surname] = String
     # @example reading
-    #   p myOptions.classes 
+    #   p myOptions.classes
     #   => { :name => String, :surname => String }
     # @attr [Hash] classes a hash table of some options associated with their corresponding types or classes
    attr_accessor :classes
@@ -108,7 +109,7 @@ module Methodic
     #   myOptions.mandatories = [:name]
     #   myOptions.mandatories.push :surname
     # @example reading
-    #   p myOptions.mandatories 
+    #   p myOptions.mandatories
     #   => [ :name, :surname ]
     attr_accessor :mandatories
 
@@ -118,7 +119,7 @@ module Methodic
     #   myOptions.defaults = {:name => 'John' }
     #   myOptions.defaults[:surname] = 'Doe'
     # @example reading
-    #   p myOptions.defaults 
+    #   p myOptions.defaults
     #   => { :name => 'John', :surname => 'Doe' }
     attr_accessor :defaults
 
@@ -128,17 +129,18 @@ module Methodic
     #   myOptions.formats = {:name => /\w+/ }
     #   myOptions.formats[:surname] = /\w+/
     # @example reading
-    #   p myOptions.defaults 
+    #   p myOptions.defaults
     #   => { :name => /\w+/, :surname => /\w+/ }
     attr_accessor :formats
-    
+    attr_accessor :toto
+
     # @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 
+    #   p myOptions.defaults
     #   => { :name => /\w+/, :surname => /\w+/ }
     attr_accessor :conditions
 
@@ -151,9 +153,18 @@ module Methodic
     # @return [Options] self
     def initialize(_options = {},_validate_known_options = false)
 
-      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
+      raise ArgumentError::new('Argument _options must be a Hash') unless _options.class == Hash or _options.class == Methodic::Options or _options.class == DRb::DRbObject
+      # ;) reintrance and cascading
+      raise ArgumentError::new('keys must be Symbol') unless _options.keys.select{|i| i.class == Symbol }.size ==  _options.keys.size
+      if _options.class == DRb::DRbObject then
+        self.clear
+        _options.each  do |key,value|
+          self[key] = value
+        end
+      else
+        self.replace _options
+      end
+
       @conditions = Hash::new
       @defaults = Hash::new
       @formats = Hash::new
@@ -163,7 +174,7 @@ module Methodic
       @validate_known_options = _validate_known_options
       yield self if block_given?
     end
-    
+
 
     # read only accessor on the [Hash] slef keys
     # @return [Array] self.keys the keys of The Options object itself
@@ -171,13 +182,13 @@ module Methodic
     #   options = {:name => 'Doe', :surname => 'John'}
     #   p myOptions = Methodic::get_options(options)
     #   => { :name => String, :surname => String }
-    #   p myOptions.options 
+    #   p myOptions.options
     #   => [:name, :surname]
-    def options 
+    def options
       return self.keys
     end
 
-    
+
     # pretty accessor for specifying the default(s) value(s)  for options
     # @param [Hash] values a value definition, keys are symbols
     # @return [hash] @defaults merged with values
@@ -190,7 +201,7 @@ module Methodic
       return @defaults
    end
     alias :specify_defaults_values :specify_default_value
-    
+
     # pretty accessor for specifying classes of options
     # @param [Hash] values a value definition, keys are symbols
     # @return [hash] @classes merged with values
@@ -221,19 +232,19 @@ module Methodic
     alias :specify_conditions_for :specify_condition_for
 
 
-    
+
     # pretty accessor for specifying mandatories options
     # @param [Array] values a Array of symbols or a unique symbol
     # @return [Array] @mandatories merged with values
     # @example usage
     #    myOptions = Methodic::get_options(_options)
-    #    myOptions.specify_presence_of :name 
+    #    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!
-      return @mandatories 
+      return @mandatories
     end
     alias :specify_presences_of :specify_presence_of
 
@@ -243,16 +254,16 @@ module Methodic
     # @return [Array] @known merged with values
     # @example usage
     #    myOptions = Methodic::get_options(_options)
-    #    myOptions.specify_known_option :name 
+    #    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!
-      return @known 
+      return @known
     end
     alias :specify_known_options :specify_known_option
-    
+
     # pretty accessor for specifying the format of options
     # @param [Hash] values a value definition, keys are symbols
     # @return [hash] @formats merged with values
@@ -266,19 +277,19 @@ module Methodic
       return @formats
     end
     alias :specify_formats_of :specify_format_of
-    
-    
-    # default values merge method 
-    # merge @defaults with self 
+
+
+    # default values merge method
+    # merge @defaults with self
     # @return [self|Options]
     # @example usage
     #    myOptions = Methodic::get_options(:name = 'Walker')
     #    myOptions.specify_default_value_of :surname => 'John'
-    #    p myOptions                                                                                                                                                                                  
+    #    p myOptions
     #      # =>{:surname=>"John", :name=>"Doe"}
     #    myOptions.merge
     #    p myOptions
-    #      # =>{:surname=>"John", :name=>"Walker"} 
+    #      # =>{:surname=>"John", :name=>"Walker"}
     def merge_with_defaults
       self.replace( @defaults.merge self)
       return self
@@ -296,19 +307,20 @@ module Methodic
       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) 
+      return true unless table.include?(false)
     end
     alias :validate! :validate
-    
+
+    # here become private
     private
     # private method for the formats validation step
     def validate_formats
       self.each do |option,value|
         if @formats.key? option then
-          raise ArgumentError::new("Option : #{option} don't match  /#{@formats[option]}/") and return false unless value =~ @formats[option] 
+          raise ArgumentError::new("Option : #{option} don't match  /#{@formats[option]}/") and return false unless value =~ @formats[option]
         end
       end
-      
+
       return true
     end
 
@@ -367,6 +379,6 @@ module Methodic
   def Methodic::get_options(_options = {},_validate_known_options=false)
     return Methodic::Options::new(_options,_validate_known_options)
   end
- 
+
 
 end