ratatouille 1.2.2 → 1.2.4

data/README.md

@@ -158,6 +158,28 @@ Used to ensure that the list of keys exist in the Hash.
 
 
 
+### required\_key
+
+Used to ensure given key exists in the Hash.
+
+* Eliminates the need to perform "given\_key" methods within a "required\_keys" block.
+* Block is optional
+
+
+#### Syntax
+
+```ruby
+    # Validate that the keys exist and perform validation if they do
+    required_key(:foo) do
+      # Validation provided that :foo exists in Hash
+    end
+
+    # Validate that the keys exist
+    required_key(:foo)
+```
+
+
+
 ### is\_empty
 
 * Self-explanatory

data/lib/ratatouille/hash.rb

@@ -80,6 +80,33 @@ module Ratatouille
     end#required_keys
 
 
+    # Perform validation on a key that must be present in the Hash to validate. Otherwise,
+    # an error will be added.
+    #
+    # @param [String,Symbol] req_key Required Key
+    # @return [void]
+    def required_key(req_key, &block)
+      if req_key.nil?
+        validation_error("required_key needs key argument")
+        return
+      end
+
+      unless @ratifiable_object.has_key?(req_key)
+        case req_key
+        when Symbol then validation_error("Missing key :#{req_key}")
+        when String then validation_error("Missing key #{req_key}")
+        when respond_to?(:to_s)
+          validation_error("Missing key #{req_key.to_s}")
+        end
+        return
+      end
+
+      instance_eval(&block) if block_given?
+    rescue Exception => e
+      validation_error("#{e.message}")
+    end
+
+
     # Provide a list of keys to choose from and a choice size (default 1). 
     # When the Hash does not contain at least 'choice_size' keys of the key 
     # list provided, an error will be added.

data/lib/ratatouille/version.rb

@@ -1,4 +1,4 @@
 module Ratatouille
   # Gem Version
-  VERSION = "1.2.2"
+  VERSION = "1.2.4"
 end

data/spec/lib/ratatouille/hash_spec.rb

@@ -63,6 +63,24 @@ describe "Ratatouille::HashMethods" do
     end
   end
 
+  describe "required_key" do
+    it "should be invalid when given a key for an empty hash" do
+      RatifierTest.new({}){ required_key(:foo) }.should_not be_valid
+    end
+
+    it "should be invalid when given a key that doesn't exist in the hash" do
+      RatifierTest.new({:foo => "foo"}){ required_key(:bar) }.should_not be_valid
+    end
+
+    it "should not progress into block if invalid" do
+      f = false
+      RatifierTest.new({}) do
+        required_key(:foo) { f = true }
+      end
+      f.should be_false
+    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 = ""

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ratatouille
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 1
   - 2
-  - 2
-  version: 1.2.2
+  - 4
+  version: 1.2.4
 platform: ruby
 authors: 
 - Ryan Johnson