poro_validator 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072a8e275c97616be8b4b507107f78f01738b5bb
-  data.tar.gz: 278dc6e7841a98f5e713e0257096ab30aa5a7658
+  metadata.gz: c80c300291ed684162f3d39b73486788444c542e
+  data.tar.gz: c174bca416c79b2daad6503aa1d0f212238e107e
 SHA512:
-  metadata.gz: 982f54f710bf94743d207f6be12375d3a4b7a9f287c37a4962f981d6c49b172c61d436c69ede5db32df11d8c4536328d9d1039c957169a31b7f3fb4d4c1bd313
-  data.tar.gz: 868f211a49e50d7be95c3c2d259db8d9e6f52b6c80c72a6680db16bd59808561311b1b7fcf4c648b05ca54be5a85fe4c38e1677ba61dba9b08aa159ef9902e7a
+  metadata.gz: ee06bdb65a1513e9850a2ee6f6732698870bce95751224aff49f853a270b77dd38331a5ead47c2dedecfc81a42513114e58e91331184d5edd41b14f8aa93d076
+  data.tar.gz: 48b39457c43c797397c946723e4a7880b17af87c5f839df66534ce855add51668543012a21e9cd3ffd6f82fd1d8be441597ee67da40e350e4991779fe60168ed

data/README.md

@@ -31,6 +31,7 @@ you want to validate we define it in a seperate class making it *subjective*.
 ## Features ##
 - **Familiar, simple and consistent API.**
 - **Framework agnostic, all you need is a PORO**.
+- **Validate Hash objects! Good for params, json objects what have you!**
 - **Validation logic is decoupled from business logic by creating seperate *validator* classes
   which allows easy testing for the validator class**.
 - **No magic, caller is in control.**
@@ -64,7 +65,7 @@ $ gem install poro_validator
 
 ## Usage ##
 
-### Creating and using the validator ###
+### Creating and using a validator ###
 ```ruby
 # Create a validator
 class CustomerValidator
@@ -75,11 +76,15 @@ class CustomerValidator
   validates :age, numeric: { min: 18 }
 end
 
-customer = CustomerDetail.new
+validator = CustomerValidator.new
 
 # Validate entity
+customer = CustomerDetail.new
+validator.valid?(customer) # => false
+validator.errors.full_messages # => ["last name is not present", "..."]
 
-validator = CustomerValidator.new
+# Validate hash
+customer = {}
 validator.valid?(customer) # => false
 validator.errors.full_messages # => ["last name is not present", "..."]
 ```

data/lib/poro_validator/utils/deep_fetch.rb

@@ -0,0 +1,38 @@
+module PoroValidator
+  module Utils
+    # Searches a deeply nested datastructure for a key path, and returns
+    # the associated value.
+    #
+    # @param args [Array] collection of keys/attributes
+    # @param block [Proc] block to set value if nil
+    #
+    # @return associated value or if nil value from passed block.
+    #
+    # @example fetches a value from a hash or deeply nested hash
+    #  options = { user: { location: { address: '123 Street' } } }
+    #  options.deep_fetch(:user, :location, :address) #=> '123 Street'
+    #
+    #  options.deep_fetch(:user, :non_existent_key) do
+    #   'a value'
+    #  end #=> 'a value'
+    module DeepFetch
+      class UndefinedPathError < StandardError; end
+
+      def deep_fetch(*args, &block)
+        args.reduce(self) do |obj, arg|
+          begin
+            arg = Integer(arg) if obj.is_a?(Array)
+            obj.fetch(arg)
+          rescue ArgumentError, IndexError, NoMethodError => e
+            break block.call(arg) if block
+            raise(
+              UndefinedPathError,
+              "Could not fetch path (#{args.join(' > ')}) at #{arg}",
+              e.backtrace
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/poro_validator/validators/base_class.rb

@@ -17,7 +17,7 @@ module PoroValidator
       end
 
       def errors
-        @errors ||= context.errors
+        @errors
       end
 
       def context
@@ -35,17 +35,33 @@ module PoroValidator
       end
 
       def value
+        if entity_is_hash = context.entity.is_a?(::Hash)
+          context.entity.extend(::PoroValidator::Utils::DeepFetch)
+        end
+
         if nested?
-          @value = attribute.flatten.inject(context.entity, :public_send)
+          if entity_is_hash
+            @value = context.entity.deep_fetch(*attribute.flatten) do
+              nil
+            end
+          else
+            @value = attribute.flatten.inject(context.entity, :public_send)
+          end
         else
-          @value = context.entity.public_send(attribute)
+          if entity_is_hash
+            @value = context.entity.deep_fetch(attribute) do
+              nil
+            end
+          else
+            @value = context.entity.public_send(attribute)
+          end
         end
       end
 
       # @private
       def __validate__(validator_context)
         @context = validator_context
-        @errors  = context.errors
+        @errors  = validator_context.errors
         validate(attribute, value, options)
       end
     end

data/lib/poro_validator/version.rb

@@ -1,3 +1,3 @@
 module PoroValidator
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/poro_validator.rb

@@ -50,5 +50,8 @@ require "poro_validator/validators/float_validator"
 require "poro_validator/validators/length_validator"
 require "poro_validator/validators/numeric_validator"
 
+# Utils
+require "poro_validator/utils/deep_fetch"
+
 # Modules
 require "poro_validator/validator"

data/poro_validator.gemspec

@@ -46,6 +46,7 @@ Gem::Specification.new do |spec|
     lib/poro_validator/error_store.rb
     lib/poro_validator/errors.rb
     lib/poro_validator/exceptions.rb
+    lib/poro_validator/utils/deep_fetch.rb
     lib/poro_validator/validator.rb
     lib/poro_validator/validator/base_class.rb
     lib/poro_validator/validator/conditions.rb
@@ -69,9 +70,11 @@ Gem::Specification.new do |spec|
     spec/features/composable_validations_spec.rb
     spec/features/inheritable_spec.rb
     spec/features/nested_validations_spec.rb
+    spec/features/validate_hash_object_spec.rb
     spec/lib/poro_validator/configuration_spec.rb
     spec/lib/poro_validator/error_store_spec.rb
     spec/lib/poro_validator/errors_spec.rb
+    spec/lib/poro_validator/utils/deep_fetch_spec.rb
     spec/lib/poro_validator/validator/base_class_spec.rb
     spec/lib/poro_validator/validator/conditions_spec.rb
     spec/lib/poro_validator/validator/factory_spec.rb

data/spec/features/validate_hash_object_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+RSpec.describe "validates hash object", type: :feature do
+  context "allows nested structure validations" do
+    subject(:validator) do
+      Class.new do
+        include PoroValidator.validator
+
+        validates :customer_id, presence: true
+
+        validates :customer do
+          validates :first_name, presence: true
+          validates :last_name,  presence: true
+        end
+
+        validates :address do
+          validates :line1, presence: true
+          validates :line2, presence: true
+          validates :city,  presence: true
+          validates :country do
+            validates :iso_code,   presence: true
+            validates :short_name, presence: true
+            validates :coordinates do
+              validates :longtitude, presence: true
+              validates :latitude,   presence:true
+              validates :planet do
+                validates :name, presence: true
+              end
+            end
+          end
+        end
+      end
+    end
+
+    context "if validation fails" do
+      let(:validator) { subject.new }
+
+      let(:invalid_entity) do
+        {
+          customer: {
+            first_name: "Man Bear",
+            last_name: nil,
+          },
+          address: {
+            line1: "175 West Jackson Boulevard",
+            line2: "5th Floor",
+            city: "Chicago",
+            country: {
+              iso_code: "33CHIC",
+              short_name: "CHICAGOUSA",
+              coordinates: {
+                latitude: nil,
+                planet: {
+                  name: nil
+                }
+              }
+            }
+          }
+        }
+      end
+
+      it "validates a hash object" do
+        expect(invalid_entity).to be_kind_of(::Hash)
+      end
+
+      describe "#valid?" do
+        it "returns false" do
+          expect(validator.valid?(invalid_entity)).to be_falsey
+        end
+
+        context "empty hash" do
+          let(:invalid_entity) { {} }
+
+          it "validates an empty hash" do
+            expect(invalid_entity).to be_empty
+          end
+
+          it "returns false" do
+            expect(validator.valid?({})).to be_falsey
+          end
+        end
+      end
+
+      describe "#errors" do
+        it "returns a non empty error hash" do
+          validator.valid?(invalid_entity)
+          expect(validator.errors.count).to be > 0
+        end
+      end
+    end
+  end
+end

data/spec/lib/poro_validator/utils/deep_fetch_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+RSpec.describe PoroValidator::Utils::DeepFetch do
+  subject { Class.new(Hash) { include ::PoroValidator::Utils::DeepFetch } }
+  let(:hash) do
+    {
+      library: {
+        books: [
+          { title: 'Call of the Wild' },
+          { title: 'Moby Dick' }
+        ],
+        shelves: nil,
+        location: {
+          address: '123 Library St.'
+        }
+      }
+    }
+  end
+  let(:instance) { subject.new.update(hash) }
+
+  describe '#deep_fetch' do
+    it 'extracts a value from a nested hash' do
+      expect(instance.deep_fetch(:library, :location, :address)).to eq('123 Library St.')
+    end
+
+    it 'extracts a value from a nested array' do
+      expect(instance.deep_fetch(:library, :books, 1, :title)).to eq('Moby Dick')
+    end
+
+    context 'when one of the keys is not present' do
+      context 'when a block is provided' do
+        it 'returns the value of the block' do
+          value = instance.deep_fetch(:library, :unknown_key, :location) { 'block value' }
+          expect(value).to eq('block value')
+        end
+      end
+
+      context 'when a block is not provided' do
+        context 'when the nested object is an array' do
+          it 'raises an UndefinedPathError' do
+            expect do
+              instance.deep_fetch(:library, :books, 2)
+            end.to(
+              raise_error(
+                ::PoroValidator::Utils::DeepFetch::UndefinedPathError,
+                'Could not fetch path (library > books > 2) at 2'
+              )
+            )
+          end
+        end
+
+        context 'when the nested object is a hash' do
+          it 'raises a UndefinedPathError' do
+            expect do
+              instance.deep_fetch(:library, :location, :unknown_key)
+            end.to(
+              raise_error(
+                ::PoroValidator::Utils::DeepFetch::UndefinedPathError,
+                'Could not fetch path (library > location > unknown_key) at unknown_key'
+              )
+            )
+          end
+        end
+
+        context 'when the nested object is missing' do
+          it 'raises an UndefinedPathError' do
+            expect do
+              instance.deep_fetch(:library, :unknown_key, :books)
+            end.to(
+              raise_error(
+                ::PoroValidator::Utils::DeepFetch::UndefinedPathError,
+                'Could not fetch path (library > unknown_key > books) at unknown_key'
+              )
+            )
+          end
+        end
+
+        context 'when the nested object is nil' do
+          it 'raises an UndefinedPathError' do
+            expect do
+              instance.deep_fetch(:library, :shelves, :address)
+            end.to(
+              raise_error(
+                ::PoroValidator::Utils::DeepFetch::UndefinedPathError,
+                'Could not fetch path (library > shelves > address) at address'
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poro_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Kareem Gan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-09 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,6 +125,7 @@ files:
 - lib/poro_validator/error_store.rb
 - lib/poro_validator/errors.rb
 - lib/poro_validator/exceptions.rb
+- lib/poro_validator/utils/deep_fetch.rb
 - lib/poro_validator/validator.rb
 - lib/poro_validator/validator/base_class.rb
 - lib/poro_validator/validator/conditions.rb
@@ -148,9 +149,11 @@ files:
 - spec/features/composable_validations_spec.rb
 - spec/features/inheritable_spec.rb
 - spec/features/nested_validations_spec.rb
+- spec/features/validate_hash_object_spec.rb
 - spec/lib/poro_validator/configuration_spec.rb
 - spec/lib/poro_validator/error_store_spec.rb
 - spec/lib/poro_validator/errors_spec.rb
+- spec/lib/poro_validator/utils/deep_fetch_spec.rb
 - spec/lib/poro_validator/validator/base_class_spec.rb
 - spec/lib/poro_validator/validator/conditions_spec.rb
 - spec/lib/poro_validator/validator/factory_spec.rb