trick_bag 0.39.0 → 0.40.0

data/RELEASE_NOTES.md

@@ -1,3 +1,9 @@
+## v0.40.0
+
+* Added Validations.raise_on_invalid_value.
+* Moved all validations into same module.
+
+
 ## v0.39.0
 
 * Added CoreTypes.clone_hash_except.

data/lib/trick_bag/validations/hash_validations.rb

@@ -1,6 +1,6 @@
 module TrickBag
 module Validations
-module HashValidations
+
   module_function
 
   # Looks to see which keys, if any, are missing from the hash.
@@ -32,5 +32,4 @@ module HashValidations
   end
 end
 end
-end
 

data/lib/trick_bag/validations/object_validations.rb

@@ -1,6 +1,5 @@
 module TrickBag
 module Validations
-module ObjectValidations
 
   module_function
 
@@ -23,4 +22,3 @@ module ObjectValidations
   end
 end
 end
-end

data/lib/trick_bag/validations/other_validations.rb

@@ -0,0 +1,34 @@
+module TrickBag
+module Validations
+
+  module_function
+
+  # Used to succinctly (for the caller) check to see that a value provided by the caller
+  # is included in the passed enumerable.  Raises an error if not, e.g.:
+  #
+  # raise_on_invalid_value('foo', [:bar, :baz], 'manufacturer')
+  #
+  # will raise an error with the following message:
+  #
+  # Invalid manufacturer 'foo'; must be one of: [:bar, :baz].
+  #
+  # If the passed value is included in the valid values, this method returns silently.
+  #
+  # @param value the value to check against the valid values
+  # @param the valid values, of which the value should be one
+  # @param label a string to include in the error message after "Invalid ", default to 'value'
+  # @param output_with_inspect if true, the values' inspect method will be called for the
+  #           error string; this will preserve the colon in symbols; if false, to_s will be used.
+  def raise_on_invalid_value(value, valid_values, label = 'value', output_with_inspect = true)
+    missing = ! valid_values.include?(value)
+
+    if missing
+      values_display_array = output_with_inspect ? valid_values.map(&:inspect) : valid_values.map(&:to_s)
+      message = "Invalid #{label} '#{value}'; must be one of: [#{values_display_array.join(', ')}]."
+      raise message
+    end
+  end
+
+end
+end
+

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = "0.39.0"
+  VERSION = "0.40.0"
 end

data/spec/trick_bag/validations/hashes_validations_spec.rb

@@ -3,10 +3,10 @@ require_relative '../../spec_helper.rb'
 require 'trick_bag/validations/hash_validations'
 
 module TrickBag
-module Validations
-  describe HashValidations do
 
-  include HashValidations
+describe Validations do
+
+  include Validations
 
   context '.missing_hash_entries' do
 
@@ -65,5 +65,4 @@ module Validations
   end
 end
 end
-end
 

data/spec/trick_bag/validations/object_validations_spec.rb

@@ -3,21 +3,20 @@ require_relative '../../spec_helper.rb'
 require 'trick_bag/validations/object_validations'
 
 module TrickBag
-module Validations
-  describe ObjectValidations do
 
-    include ObjectValidations
+  describe Validations do
 
-      specify 'a missing instance variable should raise an error' do
-        vars = [:@this_name_could_not_possibly_be_defined_as_a_real_variable]
-        expect(-> { raise_on_nil_instance_vars(self, vars) }).to raise_error
-      end
+    include Validations
 
-      specify 'an existing instance variable should NOT raise an error' do
-        vars = [:@foo]
-        -> { class AbCdEfG; def initialize; @foo = 'hi'; end; end }.()
-        expect(-> { raise_on_nil_instance_vars(AbCdEfG.new, vars) }).not_to raise_error
-      end
+    specify 'a missing instance variable should raise an error' do
+      vars = [:@this_name_could_not_possibly_be_defined_as_a_real_variable]
+      expect(-> { raise_on_nil_instance_vars(self, vars) }).to raise_error
     end
-end
+
+    specify 'an existing instance variable should NOT raise an error' do
+      vars = [:@foo]
+      -> { class AbCdEfG; def initialize; @foo = 'hi'; end; end }.()
+      expect(-> { raise_on_nil_instance_vars(AbCdEfG.new, vars) }).not_to raise_error
+    end
+  end
 end

data/spec/trick_bag/validations/other_validations_spec.rb

@@ -0,0 +1,30 @@
+require_relative '../../spec_helper.rb'
+
+require 'trick_bag/validations/other_validations'
+
+module TrickBag
+
+  describe Validations do
+
+    include Validations
+
+    specify "*no* error is raised if the value is included" do
+      expect(->{raise_on_invalid_value('foo', ['foo']) }).not_to raise_error
+    end
+
+    specify "an error *is* raised if the value is not included" do
+      expect(->{raise_on_invalid_value('foo', []) }).to raise_error
+    end
+
+    specify "the error message is correct" do
+      begin
+        raise_on_invalid_value('foo', [:bar, :baz], 'manufacturer')
+        fail "Should have raised an error"
+      rescue => error
+        expect(/manufacturer/ === error.message).to be_true
+        expect(/:bar/ === error.message).to be_true
+        expect(error.message).to eq("Invalid manufacturer 'foo'; must be one of: [:bar, :baz].")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.40.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -141,6 +141,7 @@ files:
 - lib/trick_bag/timing/timing.rb
 - lib/trick_bag/validations/hash_validations.rb
 - lib/trick_bag/validations/object_validations.rb
+- lib/trick_bag/validations/other_validations.rb
 - lib/trick_bag/version.rb
 - spec/spec_helper.rb
 - spec/trick_bag/collections/linked_list_spec.rb
@@ -162,6 +163,7 @@ files:
 - spec/trick_bag/timing/timing_spec.rb
 - spec/trick_bag/validations/hashes_validations_spec.rb
 - spec/trick_bag/validations/object_validations_spec.rb
+- spec/trick_bag/validations/other_validations_spec.rb
 - trick_bag.gemspec
 homepage: https://github.com/keithrbennett/trick_bag
 licenses:
@@ -209,4 +211,5 @@ test_files:
 - spec/trick_bag/timing/timing_spec.rb
 - spec/trick_bag/validations/hashes_validations_spec.rb
 - spec/trick_bag/validations/object_validations_spec.rb
+- spec/trick_bag/validations/other_validations_spec.rb
 has_rdoc: