hash_plus 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b8089cb1816245c13ded8dcdac34a849fc238c2
-  data.tar.gz: 5fd853a1998fae2acbe01159b984537d2ba97349
+  metadata.gz: 4a9ee112603cf5e53624d742b8aa0766f8cffe66
+  data.tar.gz: 62ec2046c0189ed12b5de9ec1c62d7e260d2e355
 SHA512:
-  metadata.gz: 2503486bfd1dab699afb6cbf80b5e21c7d127a3150a737d19579b178b2e67ab41393d5167fe0f50575623656e0b103a49ba2d4cadf8a2d4859fb60c7a4bce83e
-  data.tar.gz: 6d81568afeafd111cd10725defb07084c2cc31c973da1c8e72070f28dae2da05d1e84a4f5189d871f1264a0e0646685d76ba95a2010d59a4552a5034bf68f37e
+  metadata.gz: f3760630a4355e71a459f38682e5c36726da97b37bfb429248890f25eacde4b42400e1b094aeec02c4557ce6660ab9abbca223bc24aef781076a503a7ff5f606
+  data.tar.gz: deba6420e34df63658d30176ff9eaab86f0239397e863bafeee7bdb7350d8467b0594b45322b6076ead04375f773b83681c901f4fe04db62b91aca98ebbbfda4

data/hash_plus.gemspec

@@ -4,7 +4,7 @@ require "hash_plus"
 
 Gem::Specification.new do |gem|
   gem.name          = "hash_plus"
-  gem.version       = '1.1'
+  gem.version       = '1.2'
   gem.authors       = ["Glenn Nagel"]
   gem.email         = ["glenn@mercury-wireless.com"]
   gem.homepage      = "https://github.com/gnagel/hash_plus"

data/lib/hash_plus.rb

@@ -1,18 +1,26 @@
 class Hash
-  # Short hand methods
-  def requires(*cols); requires_fields(*cols); end
-  def missing(*cols);  missing_fields(*cols);  end
-
-  # Raise an ArgumentError if there are missing columns
-  def requires_fields(*cols)
-    missing = missing_fields(*cols)
-    unless missing.empty?
-      raise ArgumentError, "Missing value for keys=#{missing.join(',')} in opts=#{self.inspect}" 
+  # Requires that the key simply be present
+  # The hash can contain any value for these keys
+  def requires_keys_are_present(*_keys)
+    invalid_keys = _keys - self.keys
+    unless invalid_keys.empty?
+      raise ArgumentError, "Missing keys=#{invalid_keys.join(',')} in opts=#{self.inspect}"
     end
   end
-
-  # Return the missing columns
-  def missing_fields(*cols)
-    cols.select { |required_key| self[required_key].nil? }
+  
+  # Requires that the values for these keys be non-nil
+  def requires_keys_are_not_nil(*_keys)
+    invalid_keys = _keys.select { |k| self[k].nil? }
+    unless invalid_keys.empty?
+      raise ArgumentError, "Nil values for keys=#{invalid_keys.join(',')} in opts=#{self.inspect}"
+    end
+  end
+  
+  # Requires that the values for these keys be nil
+  def requires_keys_are_nil(*_keys)
+    invalid_keys = _keys.reject { |k| self[k].nil? }
+    unless invalid_keys.empty?
+      raise ArgumentError, "Non-Nil values for keys=#{invalid_keys.join(',')} in opts=#{self.inspect}"
+    end
   end
 end

data/spec/hash_plus_spec.rb

@@ -7,21 +7,57 @@ $:.push File.expand_path("../lib", File.dirname(__FILE__))
 require 'hash_plus'
 
 describe Hash do
-  context "empty hash" do
-    subject(:hash) { Hash.new }
-    it { hash.missing_fields(:a).first.should === :a }
-    it { hash.missing_fields(:a, :b, :c).should =~ [:a, :b, :c] }
+  let(:sample_columns) { [:a, :b, :c] }
+  
+  describe "requires_keys_are_nil" do
+    it "shouldn't raise error" do
+      hash = {}
+      hash.requires_keys_are_nil(*sample_columns)
+    end
+    
+    it "should raise error for 1 column" do
+      hash = { :a => 123, :b => nil }
+      expect{ hash.requires_keys_are_nil(*sample_columns) }.to raise_error ArgumentError, "Non-Nil values for keys=a in opts=#{hash.inspect}"
+    end
     
-    it { expect { hash.requires_fields(:a) }.to raise_error ArgumentError, "Missing value for keys=a in opts={}" }
+    it "should raise error for 2 columns" do
+      hash = { :a => 123, :b => 456 }
+      expect{ hash.requires_keys_are_nil(*sample_columns) }.to raise_error ArgumentError, "Non-Nil values for keys=a,b in opts=#{hash.inspect}"
+    end
   end
   
-  context "hash containing values" do
-    subject(:hash) { {:a => 'b', :c => 'd'} }
-    it { hash.missing_fields(:a).should be_empty }
-    it { hash.missing_fields(:a, :c).should be_empty }
-    it { hash.missing_fields(:a, :b, :c).should =~ [:b] }
+  describe "requires_keys_are_not_nil" do
+    it "shouldn't raise error" do
+      hash = { :a => 123, :b => 456, :c => 'hello world' }
+      hash.requires_keys_are_not_nil(*sample_columns)
+    end
+    
+    it "should raise error for 1 column" do
+      hash = { :a => 123, :b => 456, :c => nil }
+      expect{ hash.requires_keys_are_not_nil(*sample_columns) }.to raise_error ArgumentError, "Nil values for keys=c in opts=#{hash.inspect}"
+    end
+    
+    it "should raise error for 2 columns" do
+      hash = { :a => 123, :b => nil, :c => nil }
+      expect{ hash.requires_keys_are_not_nil(*sample_columns) }.to raise_error ArgumentError, "Nil values for keys=b,c in opts=#{hash.inspect}"
+    end
+  end
+  
+  describe "requires_keys_are_present" do
+    it "shouldn't raise error" do
+      hash = { :a => 123, :b => 456, :c => nil }
+      hash.requires_keys_are_present(*sample_columns)
+    end
+    
+    it "should raise error for 1 column" do
+      hash = { :a => 123, :b => nil }
+      expect{ hash.requires_keys_are_present(*sample_columns) }.to raise_error ArgumentError, "Missing keys=c in opts=#{hash.inspect}"
+    end
     
-    it { expect { hash.requires_fields(:b) }.to raise_error ArgumentError, "Missing value for keys=b in opts=#{hash.inspect}" }
+    it "should raise error for 2 columns" do
+      hash = { :a => 123 }
+      expect{ hash.requires_keys_are_present(*sample_columns) }.to raise_error ArgumentError, "Missing keys=b,c in opts=#{hash.inspect}"
+    end
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_plus
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Glenn Nagel