ratatouille 1.0.0 → 1.2.0

data/.gitignore

@@ -4,6 +4,7 @@
 .bundle
 .config
 .yardoc
+.rvmrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis-yml

@@ -4,5 +4,5 @@ rvm:
   - 1.8.7
   - 1.9.2
   - ree
-  - rbx
-  - jruby
+  - rbx-18mode
+  - jruby-18mode

data/README.md

@@ -1,7 +1,10 @@
-# Ratatouille [![Build Status](http://travis-ci.org/CITguy/ratatouille.png)](http://travis-ci.org/CITguy/ratatouille)
+# Ratatouille 
 
 DSL for validation of complex Hashes
 
+## Travis CI Status: 
+[![Build Status](https://secure.travis-ci.org/CITguy/ratatouille.png?branch=master)](http://travis-ci.org/CITguy/ratatouille)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/ratatouille/array.rb

@@ -5,22 +5,26 @@ module Ratatouille
     # @return [void]
     def is_empty(&block)
       unless @ratifiable_object.empty?
-        validation_error("Array is not empty")  
+        validation_error("not empty")  
         return
       end
 
       instance_eval(&block) if block_given?
+    rescue Exception => e
+      validation_error("#{e.message}")
     end#is_empty
 
 
     # @return [void]
     def is_not_empty(&block)
       if @ratifiable_object.empty?
-        validation_error("Array is empty")
+        validation_error("empty")
         return
       end
 
       instance_eval(&block) if block_given?
+    rescue Exception => e
+      validation_error("#{e.message}")
     end#is_not_empty
 
 
@@ -78,6 +82,8 @@ module Ratatouille
       end
 
       instance_eval(&block) if block_given?
+    rescue Exception => e
+      validation_error("#{e.message}")
     end#length_between
   private
 
@@ -89,7 +95,7 @@ module Ratatouille
       end
 
       unless @ratifiable_object.size >= min_size.to_i
-        validation_error("Array length must be #{min_size} or more") 
+        validation_error("length must be #{min_size} or more") 
         return false
       end
       return true
@@ -106,7 +112,7 @@ module Ratatouille
       end
 
       if @ratifiable_object.size > max_size.to_i
-        validation_error("Array length must be less than #{max_size.to_i}")
+        validation_error("length must be less than #{max_size.to_i}")
         return false
       end
 

data/lib/ratatouille/hash.rb

@@ -5,33 +5,42 @@ module Ratatouille
     # Runs validation in block against object for the given key.
     #
     # @param [String, Symbol] key
-    def given_key(key, &block)
+    # @param [Hash] options
+    def given_key(key, options={}, &block)
+      options[:name] = options.fetch(:name, (Symbol === key ? ":#{key}" : key.to_s) )
+
       if @ratifiable_object.has_key?(key) && block_given?
-        child_object = Ratatouille::Ratifier.new(@ratifiable_object[key], &block)
+        child_object = Ratatouille::Ratifier.new(@ratifiable_object[key], options, &block)
         @errors[key] = child_object.errors unless child_object.valid?
       end
+    rescue Exception => e
+      validation_error("#{e.message}")
     end#given_key
 
 
     # @return [void]
     def is_empty(&block)
       unless @ratifiable_object.empty?
-        validation_error("Hash is not empty")  
+        validation_error("not empty")  
         return
       end
 
       instance_eval(&block) if block_given?
+    rescue Exception => e
+      validation_error("#{e.message}")
     end#is_empty
 
 
     # @return [void]
     def is_not_empty(&block)
       if @ratifiable_object.empty?
-        validation_error("Hash is empty")      
+        validation_error("empty")      
         return
       end
 
       instance_eval(&block) if block_given?
+    rescue Exception => e
+      validation_error("#{e.message}")
     end#is_not_empty
 
 
@@ -44,12 +53,12 @@ module Ratatouille
       common_keys = (@ratifiable_object.keys & req_keys)
 
       if @ratifiable_object.empty?
-        validation_error("Cannot find required keys in empty hash.")
+        validation_error("Cannot find required keys")
         return
       end
 
       if req_keys.nil? || req_keys.empty?
-        validation_error("No required keys given to compare Hash against.")
+        validation_error("No required keys given to compare against.")
         return
       end
 
@@ -66,6 +75,8 @@ module Ratatouille
       end
 
       instance_eval(&block) if block_given?
+    rescue Exception => e
+      validation_error("#{e.message}")
     end#required_keys
 
 
@@ -79,13 +90,29 @@ module Ratatouille
     #   All other values are ignored.
     # @return [void]
     def choice_of(choice_size=1, *key_list, &block)
-      unless key_list.nil? || key_list.empty?
+      if key_list.nil? || key_list.empty?
         validation_error("choice_of requires a key list to choose from")
         return
       end
+      key_list.flatten!
+
+      # I can work with a non-zero integer or any object that responds
+      case choice_size
+      when Integer
+        unless choice_size > 0
+          validation_error("choice_of requires a positive integer for choice size")
+          return
+        end
+      else
+        unless choice_size.respond_to?(:to_i)
+          validation_error("choice_of requires an object that responds to :to_i for choice size")
+          return
+        end
+        choice_size = choice_size.to_i
+      end
 
-      unless choice_size =~ /\d+/ && choice_size > 0
-        validation_error("choice_of requires a positive integer for choice size")
+      unless choice_size > 0
+        validation_error("choice size for choice_of must be positive non-zero number")
         return
       end
 
@@ -96,12 +123,19 @@ module Ratatouille
       
       common_keys = (@ratifiable_object.keys & key_list)
       unless common_keys.size == choice_size
-        choices = key_list.collect{|a| String === a || Symbol === a}
+        choices = key_list.collect{|a| 
+          case a
+          when Symbol then ":#{a}"
+          when String then "#{a}"
+          end
+        }
         validation_error("Require #{choice_size} of the following: #{choices.join(', ')}")
         return
       end
 
       instance_eval(&block) if block_given?
+    rescue Exception => e
+      validation_error("#{e.message}")
     end#choice_of
   end#HashMethods
 

data/lib/ratatouille/ratifier.rb

@@ -7,9 +7,11 @@ module Ratatouille
 
     # A new instance of Ratifier
     # @param [Hash, Array] obj Object to validate
+    # @param [Hash] options
     def initialize(obj, options={}, &block)
       @errors = { "/" => [] }
       @ratifiable_object = obj
+      self.name = options[:name]
 
       case obj
       when Hash  then extend Ratatouille::HashMethods
@@ -24,6 +26,27 @@ module Ratatouille
     end#initialize
 
 
+    # Name of instance
+    #
+    # @return [String]
+    def name
+      @name ||= @ratifiable_object.class.to_s
+    end
+
+
+    # Set name of instance
+    #
+    # @param [String] namein
+    # @return [String] name of Ratatouille::Ratifier instance
+    def name=(namein)
+      case namein
+      when String
+        @name = namein unless namein.blank?
+      end
+      @name
+    end
+
+
     # Add validation error. Useful for custom validations.
     # @param [String] str
     # @param [String] context
@@ -33,10 +56,10 @@ module Ratatouille
       when String
         return if err_in.blank?
         @errors[context] = [] unless @errors[context]
-        @errors[context] << err_in
+        @errors[context] << "#{@name}: #{err_in}"
       end
     rescue Exception => e
-      @errors["/"] << e.message
+      @errors["/"] << "#{@name}: #{e.message}"
     end#validation_error
 
 
@@ -54,7 +77,7 @@ module Ratatouille
     def cleanup_errors 
       @errors = {} if errors_array.empty?
     rescue Exception => e
-      @errors["/"] << e.message
+      validation_error("#{e.message}", '/')
     end#cleanup_errors
 
 

data/lib/ratatouille/version.rb

@@ -1,4 +1,4 @@
 module Ratatouille
   # Gem Version
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/lib/ratatouille.rb

@@ -10,9 +10,10 @@ require "ratatouille/string"
 module Ratatouille
 
   # @param [Hash, Array] obj Object to validate
+  # @param [Hash] options
   # @return [Validatable::Ratifier]
-  def ratify(obj, &block)
-    Ratatouille::Ratifier.new(obj, &block)
+  def ratify(obj, options={}, &block)
+    Ratatouille::Ratifier.new(obj, options, &block)
   end#ratify
 
 end

data/spec/lib/ratatouille/hash_spec.rb

@@ -33,14 +33,28 @@ describe "Ratatouille::HashMethods" do
     it "should be invalid if choice list is not 1 more than choice size" do
       RatifierTest.new({}) { choice_of(1, [:foo]) }.should_not be_valid
     end
+
+    it "should be valid when given hash has 1 key in a choice list of 2 or more" do
+      RatifierTest.new({:foo => "bar"}){ choice_of(1, [:foo, :bar]) }.should be_valid
+    end
+
+    it "should be valid when given hash has 2 keys in choice list of 3 or more" do
+      RatifierTest.new({:foo => "foo", :bar => "bar"}){ 
+        choice_of(2, [:foo, :bar, :biz]) 
+      }.should be_valid
+
+      RatifierTest.new({:foo => "foo", :bar => "bar"}){ 
+        choice_of(2, [:foo, :bar, :biz, :bang]) 
+      }.should be_valid
+    end
   end
 
   describe "required_keys" do
-    it "should be valid if Has contains all required keys" do
+    it "should be valid if Hash contains all required keys" do
       RatifierTest.new({:foo => "foo"}) { required_keys(:foo, :bar) }.should_not be_valid
     end
 
-    it "should be invalid if hash is empty and key list is not" do
+    it "should be invalid if Hash is empty and key list is not" do
       RatifierTest.new({}) { required_keys(:foo) }.should_not be_valid
     end
 
@@ -48,4 +62,34 @@ describe "Ratatouille::HashMethods" do
       RatifierTest.new({:foo => "foo"}) { required_keys(:foo, :bar) }.should_not be_valid
     end
   end
+
+  describe "given_key" do
+    it "should change the scope name to default to the key if no name passed as option" do
+      n = ""
+      RatifierTest.new({:foo => "bar"}) do
+        given_key(:foo) { n = name }
+      end
+      n.should == ":foo"
+    end
+
+    it "should change the scope name when passed as an option" do
+      o = n = ""
+      RatifierTest.new({:foo => "bar"}, :name => "Outer") do
+        o = name
+        given_key(:foo, :name => "None") { n = name }
+      end
+      o.should == "Outer"
+      n.should == "None"
+    end
+
+    it "should not change the outer scope's name" do
+      o = n = ""
+      RatifierTest.new({:foo => "bar"}) do
+        given_key(:foo) { n = name }
+        o = name
+      end
+      o.should == "Hash"
+      n.should == ":foo"
+    end
+  end
 end

data/spec/lib/ratatouille/ratifier_spec.rb

@@ -120,4 +120,34 @@ describe Ratatouille::Ratifier do
       end
     end
   end
+
+  describe "name" do
+    it "should return the same value if called twice in a row" do
+      r = RatifierTest.new({})
+      r.name.should == r.name
+    end
+
+    it "should always return a String" do
+      RatifierTest.new({}).name.should be_a String
+    end
+
+    it "should return the class of the object if :name isn't passed into options" do
+      RatifierTest.new({}).name.should == "Hash"
+      RatifierTest.new(Object.new).name.should == "Object"
+    end
+
+    it "should return the name as passed into options of new instance" do
+      RatifierTest.new({}, :name => "Foo").name.should == "Foo"
+    end
+  end
+
+  describe "name=" do
+    it "should not change the name if passed a non-string name" do
+      r = RatifierTest.new({})
+      r.name = NilClass
+      r.name = Object.new
+      r.name = nil
+      r.name.should == 'Hash'
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ratatouille
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 31
   prerelease: 
   segments: 
   - 1
+  - 2
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Ryan Johnson
@@ -58,7 +58,6 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- .rvmrc
 - .travis-yml
 - .yardopts
 - Gemfile

data/.rvmrc

@@ -1 +0,0 @@
-rvm --create use 1.8.7@ratatouille