poro_validator 0.0.1

data/lib/poro_validator/validators/range_array_validator.rb

@@ -0,0 +1,19 @@
+module PoroValidator
+  module Validators
+    class RangeArrayValidator < BaseClass
+      def validate_option(option)
+        !option.nil? && (option.is_a?(::Range) || option.is_a?(::Array))
+      end
+
+      def covered?(range, value)
+        return unless range.respond_to?(:cover?)
+        range.cover?(value)
+      end
+
+      def included?(array, value)
+        return unless array.respond_to?(:include?)
+        array.include?(value)
+      end
+    end
+  end
+end

data/lib/poro_validator/validators/with_validator.rb

@@ -0,0 +1,21 @@
+module PoroValidator
+  module Validators
+    class WithValidator < BaseClass
+      def validate(attribute, value, options)
+        validator_class = options.fetch(:with)
+        case validator_class
+        when Class
+          klass = validator_class.new
+          klass.valid?(context.entity.public_send(attribute))
+          klass.errors.public_send(:store).data.each do |k,v|
+            errors.add([attribute, k.to_sym], v.pop)
+          end
+        else
+          raise ::PoroValidator::InvalidValidator.new(
+            "Requires a class object for this validator."
+          )
+        end
+      end
+    end
+  end
+end

data/lib/poro_validator/version.rb

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

data/poro_validator.gemspec

@@ -0,0 +1,97 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poro_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "poro_validator"
+  spec.version       = PoroValidator::VERSION
+  spec.authors       = ["Kareem Gan"]
+  spec.email         = ["kareemgan@gmail.com"]
+
+  spec.summary       = %q{A PORO (Plain Old Ruby Object) validator.}
+  spec.description   = %q{Validations for ruby objects or POROs.}
+  spec.homepage      = "https://github.com/magicalbanana/poro_validator"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("rspec")
+  spec.add_development_dependency('simplecov')
+  spec.add_development_dependency('coveralls')
+  spec.add_development_dependency('recursive-open-struct')
+  spec.add_development_dependency('nyan-cat-formatter')
+  # = MANIFEST =
+  spec.files = %w[
+    CODE_OF_CONDUCT.md
+    Gemfile
+    LICENSE.txt
+    README.md
+    Rakefile
+    lib/poro_validator.rb
+    lib/poro_validator/configuration.rb
+    lib/poro_validator/error_store.rb
+    lib/poro_validator/errors.rb
+    lib/poro_validator/exceptions.rb
+    lib/poro_validator/validator.rb
+    lib/poro_validator/validator/base_class.rb
+    lib/poro_validator/validator/conditions.rb
+    lib/poro_validator/validator/context.rb
+    lib/poro_validator/validator/factory.rb
+    lib/poro_validator/validator/validation.rb
+    lib/poro_validator/validator/validations.rb
+    lib/poro_validator/validators/base_class.rb
+    lib/poro_validator/validators/exclusion_validator.rb
+    lib/poro_validator/validators/float_validator.rb
+    lib/poro_validator/validators/format_validator.rb
+    lib/poro_validator/validators/inclusion_validator.rb
+    lib/poro_validator/validators/integer_validator.rb
+    lib/poro_validator/validators/length_validator.rb
+    lib/poro_validator/validators/numeric_validator.rb
+    lib/poro_validator/validators/presence_validator.rb
+    lib/poro_validator/validators/range_array_validator.rb
+    lib/poro_validator/validators/with_validator.rb
+    lib/poro_validator/version.rb
+    poro_validator.gemspec
+    spec/features/composable_validations_spec.rb
+    spec/features/inheritable_spec.rb
+    spec/features/nested_validations_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/validator/base_class_spec.rb
+    spec/lib/poro_validator/validator/conditions_spec.rb
+    spec/lib/poro_validator/validator/factory_spec.rb
+    spec/lib/poro_validator/validator/validation_spec.rb
+    spec/lib/poro_validator/validator/validations_spec.rb
+    spec/lib/poro_validator/validator_spec.rb
+    spec/lib/poro_validator/validators/base_class_spec.rb
+    spec/lib/poro_validator/validators/exclusion_validator_spec.rb
+    spec/lib/poro_validator/validators/float_validator_spec.rb
+    spec/lib/poro_validator/validators/format_validator_spec.rb
+    spec/lib/poro_validator/validators/inclusion_validator_spec.rb
+    spec/lib/poro_validator/validators/integer_validator_spec.rb
+    spec/lib/poro_validator/validators/length_validator_spec.rb
+    spec/lib/poro_validator/validators/numeric_validator_spec.rb
+    spec/lib/poro_validator/validators/presence_validator_spec.rb
+    spec/lib/poro_validator/validators/with_validator_spec.rb
+    spec/poro_validator_spec.rb
+    spec/spec_helper.rb
+    spec/support/spec_helpers/concerns.rb
+    spec/support/spec_helpers/validator_test_macros.rb
+  ]
+  # = MANIFEST =
+end

data/spec/features/composable_validations_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe "Compose validations using existing validations", type: :feature do
+  context "an existing validator already exists" do
+    AddressEntityValidator = Class.new do
+      include PoroValidator.validator
+
+      validates :line1,    presence: true
+      validates :line2,    presence: true
+      validates :city,     presence: true
+      validates :state,    presence: true
+      validates :zip_code, presence: true
+    end
+
+    it "uses the existing validator as for the validation" do
+      CustomerDetailEntityValidation = Class.new do
+        include PoroValidator.validator
+
+        validates :address, with: AddressEntityValidator
+      end
+
+      expect(CustomerDetailEntityValidation.validations.validators).
+        to eq({with: AddressEntityValidator})
+    end
+  end
+end

data/spec/features/inheritable_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe "Allows a validator class to be subclassed", type: :feature do
+  context "if an existing validator is subclassed" do
+    it "ensures that the validation rules are carried over" do
+      class PersonValidator
+        include PoroValidator.validator
+
+        validates :name, presence: true
+      end
+
+      class CustomerValidator < PersonValidator
+        validates :customer_id, presence: true
+      end
+
+      entity = Class.new do
+        attr_accessor :customer_id
+        attr_accessor :name
+      end.new
+
+      validator = CustomerValidator.new
+      validator.valid?(entity)
+
+      expect(validator.errors.count).to eq(2)
+      expect(validator.errors.full_messages).
+        to eq(["name is not present", "customer_id is not present"])
+    end
+  end
+end

data/spec/features/nested_validations_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+require 'recursive-open-struct'
+
+RSpec.describe "Allows nested validations to be setup", 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
+
+    it "creates validatons for the nested structure" do
+      expected_validations = [
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: :customer_id
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:customer, :first_name]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:customer, :last_name]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:address, :line1]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:address, :line2]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:address, :city]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:address, [:country, :iso_code]]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:address, [:country, :short_name]]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:address, [:country, [:coordinates, :longtitude]]]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:address, [:country, [:coordinates, :latitude]]]
+        },
+        {
+          validator: PoroValidator::Validators::PresenceValidator,
+          attribute: [:address, [:country, [:coordinates, [:planet, :name]]]]
+        }
+      ]
+
+      actual_validations = \
+        validator.validations.validations.inject([]) do |result, value|
+          result << { validator: value[:validator].class,
+                      attribute: value[:validator].attribute
+          }
+      end
+
+      expect(actual_validations).to eq(expected_validations)
+    end
+
+    context "if validation fails" do
+      let(:validator) { subject.new }
+
+      let(:invalid_entity) do
+        RecursiveOpenStruct.new(
+          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: {
+                longtitude: nil,
+                latitude: nil,
+                planet: {
+                  name: nil
+                }
+              }
+            }
+          }
+        )
+      end
+
+      describe "#valid?" do
+        it "returns false" do
+          expect(validator.valid?(invalid_entity)).to be_falsey
+        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/configuration_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe PoroValidator::Configuration do
+  describe described_class::Message do
+    let(:message) { described_class.new }
+
+    describe "#get" do
+      context "if the validator has a preset mesasge" do
+        it "gets the message for that validator" do
+          expect(message.get(:presence)).to eq("is not present")
+        end
+      end
+
+      context "if the validator does not have a preset message" do
+        it "gets the default message" do
+          expect(message.get(:man_bear_pig)).to eq("is not valid")
+        end
+      end
+    end
+
+    describe "#set" do
+      context "if a non proc class is passed in for the message" do
+        it "raises an exception of PoroValidator::ValidatorException" do
+          expect { message.set(:presence, "no message") }.
+            to raise_error(PoroValidator::ConfigError)
+        end
+      end
+
+      context "if a proc class is passed in for the message" do
+        it "sets the message for that validator" do
+          message.set(:presence, lambda { "custom message" })
+          expect(message.get(:presence)).to eq("custom message")
+        end
+      end
+    end
+  end
+end

data/spec/lib/poro_validator/error_store_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+RSpec.describe PoroValidator::ErrorStore do
+  describe "#initialize" do
+    context "if no data is loaded" do
+      it "returns an empty hash" do
+        store = described_class.new
+        expect(store.data).to eq({})
+      end
+    end
+
+    context "if data is loaded" do
+      it "returns the passed data" do
+        data = { "key" => "foo" }
+        store = described_class.new(data)
+        expect(store.data).to eq(data)
+      end
+    end
+  end
+
+  describe "#get" do
+    let(:store) { described_class.new }
+
+    context "if the key is valid" do
+      it "returns a value if set" do
+        store.set("name", "foo")
+        expect(store.get("name")).to eq("foo")
+      end
+
+      it "returns nil if the value is not set" do
+        expect(store.get("name")).to be_nil
+      end
+    end
+
+    context "if the key is not valid" do
+      it "raises TypeError exception" do
+        expect { store.get(1) }.to raise_error(
+          ::PoroValidator::InvalidType
+        )
+      end
+    end
+  end
+
+  describe "#set" do
+    let(:store) { described_class.new }
+    let(:key)   { "foo" }
+    let(:val)   { "fam" }
+
+    context "if the key is valid" do
+      it "does not raise a TypeError exception" do
+        expect { store.set(key, val) }.to_not raise_error
+      end
+
+      context "and the key has a value given" do
+        it "sets a key with the given value" do
+          store.set(key, val)
+          expect(store.get(key)).to eq(val)
+        end
+      end
+
+      context "and the key has no valie given" do
+        it "sets the key's value to nil" do
+          store.set(key)
+          expect(store.get(key)).to be_nil
+        end
+      end
+
+      context "and a block is passed is as a value" do
+        it "sets the value from the given block" do
+          store.set(key, val) { "block_val" }
+          expect(store.get(key)).to_not eq(val)
+          expect(store.get(key)).to eq("block_val")
+        end
+      end
+    end
+
+    context "if the key is not valid" do
+      it "raises a TypeError exception" do
+        expect { store.set(1, val) }.to raise_error(
+          ::PoroValidator::InvalidType
+        )
+      end
+    end
+  end
+
+  describe "#set?" do
+    let(:store) { described_class.new }
+    let(:key)   { "foo" }
+    let(:val)   { "fam" }
+
+    before(:each) do
+      store.set(key, val)
+    end
+
+    context "if a key has already been set" do
+      it "returns true" do
+        expect(store.set?(key)).to be_truthy
+      end
+    end
+
+    context "if the key has not been set" do
+      it "returns false" do
+        expect(store.set?("banana")).to be_falsey
+      end
+    end
+
+    context "if the key is not valid" do
+      it "raises a TypeError exception" do
+        expect { store.set?(1) }.to raise_error(
+          ::PoroValidator::InvalidType
+        )
+      end
+    end
+  end
+
+  describe "#reset" do
+    let(:store) { described_class.new }
+
+    it "clears the data stored" do
+      store.set(:foo, "foo")
+      expect(store.get(:foo)).to eq("foo")
+      expect(store.reset).to eq({})
+    end
+  end
+end