foreign_key_validation 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTRkMDgxMDUxZmJiN2ViODhiNjc2MjlkMjkwNzU3NWE1NGYyNDMxMw==
+    ZDU3ZTY0MGMyNmIzYTJiOWFjMjZjMzE5NjllMWM1MjAyNmI5MTcwOA==
   data.tar.gz: !binary |-
-    NWRmMDQzMmRkNTM4OTE5MGIzZTRmMjk3ODllMDU1ZmYyOGZjZTkyMw==
+    OTRhOTc5NzlmZDBjODAxNmE4Mzk4NjM1ZDQ2NDJhMjkyMTFhZWY4YQ==
 SHA512:
   metadata.gz: !binary |-
-    M2NhODc1MzQ0NDEwNGMwZmU0MzRkN2E2ZWJjZDg5OTlhYzFkYzhlYWEyM2Yx
-    MTUwMTQ3ZWU3ZGM0OTIxNTZhZTQ1MTMyZTk5ZDUzOGI2NzhjZTA1Nzg0MTk2
-    NWNhNjQzYzllOTIwYWJlNGM1ODk1NjIwY2ZhZDc0YzczYjRiNmY=
+    ODdiYzEzM2FhNTE1ZGVjZmMzYWY2ZmMxMGFmZDM2NTIxZjlmYjcxMGY1Njdk
+    NmZmN2Q3ZmY1YTkzN2NlYjZiNzhhNjhmNDUwNTAxOTkyYjMwMzRlYjg1NWU3
+    ZTc2ZWE1ZTAxZDYzMzQ1MmRkNmVmYmZkOGViOGZjNTRiNGNhYTY=
   data.tar.gz: !binary |-
-    ODBhMWQ2MmZiMmE2N2NkZDc3YmJmYjU2MGQwYjQzYTliNjg3NzBlMGJjMGIw
-    OGVjYjQ2YTk2ZDA1MzdmNzFkNDdiMTU0ODE1MWUwYzlkNmJiMGY4ZDI0YTUy
-    ZjFiMjRhNWNmMjc0N2Y0NDNiYjhhMjljYTkyM2ZkZDM1NzI4Yzg=
+    NTczZTBjNGFjNTgyYThkNThlZTQwZDUzNTZlZTQ3ZTk2MGIzMDY1ODRhMTg1
+    OWE2MDRhMGUxYzA5Yzg2NTEwYmEzMDk2NDUzOTU3MjhjNjNiMmFlY2NiOTc0
+    OTUxNTMwMmQzZDNhZTEyNjk3MWRhN2JhMmVlODE4NzczZGI2MDk=

data/README.md

@@ -35,6 +35,15 @@ Change behaviour by calling `validate_foreign_keys` with arguments hash.
 
 This would only check `model.project.admin_user_id` to match `model.admin_user_id` before saving the record.
 
+## Configuration
+
+You can customize the behaviour of the gem by calling the `configure` method on the module with a block (e.g. initializer).
+
+    ForeignKeyValidation.configure do |config|
+      config.error_message      = proc { |key, name, object| "My custom msg!" }
+      config.inject_subclasses  = true
+    end
+
 ## Note
 
 Only tested with ActiveRecord

data/lib/foreign_key_validation.rb

@@ -4,5 +4,28 @@ require "foreign_key_validation/collector"
 require "foreign_key_validation/filter"
 require "foreign_key_validation/validator"
 require "foreign_key_validation/model_extension"
+require "ostruct"
+
+module ForeignKeyValidation
+
+  DEFAULT_CONFIG = {
+    inject_subclasses: true,
+    error_message: proc { |validate_against_key, reflection_name, object|
+      "#{validate_against_key} of #{reflection_name} does not match #{object.class.name.tableize} #{validate_against_key}."
+    }
+  }
+
+  class << self
+    attr_writer :configuration
+
+    def configure(&blk)
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= OpenStruct.new(DEFAULT_CONFIG)
+    end
+  end
+end
 
 ActiveRecord::Base.send :include, ForeignKeyValidation::ModelExtension

data/lib/foreign_key_validation/collector.rb

@@ -1,17 +1,12 @@
 module ForeignKeyValidation
 
   class Collector
-    attr_accessor :klass, :validate_against, :reflections, :reflection_names, :validate_against_key, :validate_with
+    attr_accessor :options
 
     DEFAULT_VALIDATE_AGAINST = :user
 
     def initialize(opt={})
-      self.klass                 = opt[:klass]
-      self.validate_against      = find_validate_against(opt[:on])
-      self.reflections           = klass.reflect_on_all_associations(:belongs_to)
-      self.reflection_names      = reflections.map(&:name).map(&:to_s)
-      self.validate_against_key  = find_validate_against_key
-      self.validate_with         = find_validate_with(opt[:with])
+      self.options = opt
     end
 
     def check!
@@ -21,18 +16,28 @@ module ForeignKeyValidation
       true
     end
 
-    private
+    def klass
+      @klass ||= options[:klass]
+    end
+
+    def validate_against
+      @validate_against ||= (options[:on] || DEFAULT_VALIDATE_AGAINST).to_s
+    end
+
+    def validate_with
+      @validate_with ||= ((Array(options[:with]).map(&:to_s) if options[:with]) || reflection_names).reject {|n| n == validate_against}
+    end
 
-    def find_validate_against(on)
-      (on || DEFAULT_VALIDATE_AGAINST).to_s
+    def reflections
+      @reflections ||= klass.reflect_on_all_associations(:belongs_to)
     end
 
-    def find_validate_with(with)
-      ((Array(with).map(&:to_s) if with) || reflection_names).reject {|n| n == validate_against}
+    def reflection_names
+      @reflection_names ||= reflections.map {|r| r.name.to_s }
     end
 
-    def find_validate_against_key
-      reflections.select {|r| r.name.to_s == validate_against}.first.try(:foreign_key)
+    def validate_against_key
+      @validate_against_key ||= reflections.select {|r| r.name.to_s == validate_against}.first.try(:foreign_key)
     end
 
   end

data/lib/foreign_key_validation/filter.rb

@@ -10,6 +10,7 @@ module ForeignKeyValidation
     def before_filter(&block)
       collector.klass.send :define_method, filter_name do
         self.instance_eval &block
+        return true
       end
       collector.klass.send :private, filter_name.to_sym
       collector.klass.send :before_validation, filter_name

data/lib/foreign_key_validation/model_extension.rb

@@ -5,13 +5,13 @@ module ForeignKeyValidation
     module ClassMethods
 
       def validate_foreign_keys(opt={})
-        subclasses.map {|klass| klass.send(:validate_foreign_keys, opt)}
+        subclasses.map {|klass| klass.send(:validate_foreign_keys, opt)} if ForeignKeyValidation.configuration.inject_subclasses
 
         collector = Collector.new(opt.merge(klass: self))
         collector.check!
 
         Filter.new(collector).before_filter do
-          Validator.validate(validate_against_key: collector.validate_against_key, reflection_names: collector.validate_with, object: self)
+          Validator.new(validate_against_key: collector.validate_against_key, reflection_names: collector.validate_with, object: self).validate
         end
       end
 

data/lib/foreign_key_validation/validator.rb

@@ -2,16 +2,46 @@ module ForeignKeyValidation
 
   class Validator
 
-    def self.validate(opt={})
-      validate_against_key, reflection_names, object = opt[:validate_against_key], opt[:reflection_names], opt[:object]
+    attr_accessor :validate_against_key, :reflection_names, :object
 
-      reflection_names.each do |reflection_name|
-        next if object.send(reflection_name).try(validate_against_key).nil? or object.try(validate_against_key).nil?
+    def initialize(opt={})
+      self.validate_against_key = opt[:validate_against_key]
+      self.reflection_names     = opt[:reflection_names] || []
+      self.object               = opt[:object]
+    end
 
-        if object.send(reflection_name).send(validate_against_key) != object.send(validate_against_key)
-          object.errors.add(validate_against_key, "#{validate_against_key} of #{reflection_name} does not match #{object.class.name.tableize} #{validate_against_key}.")
+    def validate
+      has_errors = false
+      reflection_names.each do |reflection_name|
+        next unless keys_present?(reflection_name)
+        if keys_different?(reflection_name)
+          attach_error(reflection_name)
+          has_errors = true
         end
       end
+      has_errors
+    end
+
+    private
+
+    def key_on_relation(relation)
+      object.send(relation).try(validate_against_key)
+    end
+
+    def key_on_object
+      object.try(validate_against_key)
+    end
+
+    def keys_present?(relation)
+      key_on_object.present? and key_on_relation(relation).present?
+    end
+
+    def keys_different?(relation)
+      key_on_object != key_on_relation(relation)
+    end
+
+    def attach_error(reflection_name)
+      object.errors.add(validate_against_key, ForeignKeyValidation.configuration.error_message.call(validate_against_key, reflection_name, object))
     end
 
   end

data/lib/foreign_key_validation/version.rb

@@ -1,3 +1,3 @@
 module ForeignKeyValidation
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/collector/base_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ForeignKeyValidation::Collector do
+
+  let(:user) { User.create }
+  let(:other_user) { User.create }
+
+  describe ".new" do
+
+    subject { ForeignKeyValidation::Collector }
+
+    it "initializes new validator" do
+      expect(subject.new).to be_instance_of ForeignKeyValidation::Collector
+    end
+
+  end
+
+  describe "#check!" do
+
+    it "returns true for known class" do
+      expect(ForeignKeyValidation::Collector.new(klass: Issue).check!).to be true
+    end
+
+    it "raises error for class without relations" do
+      expect{ForeignKeyValidation::Collector.new(klass: Dummy).check!}.to raise_error(ForeignKeyValidation::Errors::NoReleationFoundError)
+    end
+
+  end
+
+end

data/spec/model_extension/validation_with_config_block_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe ForeignKeyValidation::ModelExtension do
+
+  let(:user) { User.create }
+  let(:other_user) { User.create }
+
+  let(:manager) { Manager.create user: user }
+  let(:other_manager) { Manager.create user: User.create }
+  let(:developer) { Developer.create user: user, boss: manager }
+
+  context "with custom error message without vars" do
+
+    before do
+      ForeignKeyValidation.configure {|c| c.error_message = proc {"CUSTOM MSG!"} }
+      Member.send :validate_foreign_keys
+    end
+
+    it "does not allow to rewrite user id of developer" do
+      developer.user_id = other_user.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to include("CUSTOM MSG!")
+      expect(developer.reload.user_id).to_not eq(other_user.id)
+    end
+
+    it "does not allow to rewrite boss id of developer" do
+      developer.custom_boss_id = other_manager.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to include("CUSTOM MSG!")
+      expect(developer.reload.custom_boss_id).to_not eq(other_manager.id)
+    end
+
+  end
+
+  context "with custom error message with vars" do
+
+    before do
+      ForeignKeyValidation.configure {|c| c.error_message = proc {|a,b,c| "#{a} #{b} #{c.id}"} }
+      Member.send :validate_foreign_keys
+    end
+
+    it "does not allow to rewrite user id of developer" do
+      developer.user_id = other_user.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to include("user_id boss #{developer.id}")
+      expect(developer.reload.user_id).to_not eq(other_user.id)
+    end
+
+    it "does not allow to rewrite boss id of developer" do
+      developer.custom_boss_id = other_manager.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to include("user_id boss #{developer.id}")
+      expect(developer.reload.custom_boss_id).to_not eq(other_manager.id)
+    end
+
+  end
+
+  context "without injecting subclasses via config block" do
+
+    before do
+      Member.send :validate_foreign_keys
+    end
+
+    it "does not allow to rewrite user id of developer" do
+      developer.user_id = other_user.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to include("user_id of boss does not match developers user_id.")
+      expect(developer.reload.user_id).to_not eq(other_user.id)
+    end
+
+    it "does not allow to rewrite boss id of developer" do
+      developer.custom_boss_id = other_manager.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to include("user_id of boss does not match developers user_id.")
+      expect(developer.reload.custom_boss_id).to_not eq(other_manager.id)
+    end
+
+  end
+
+  context "with injecting subclasses set to true via config block" do
+
+    before do
+      ForeignKeyValidation.configure {|c| c.inject_subclasses = true }
+      Member.send :validate_foreign_keys
+    end
+
+    it "does not allow to rewrite user id of developer" do
+      developer.user_id = other_user.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to include("user_id of boss does not match developers user_id.")
+      expect(developer.reload.user_id).to_not eq(other_user.id)
+    end
+
+    it "does not allow to rewrite boss id of developer" do
+      developer.custom_boss_id = other_manager.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to include("user_id of boss does not match developers user_id.")
+      expect(developer.reload.custom_boss_id).to_not eq(other_manager.id)
+    end
+
+  end
+
+
+  context "with injecting subclasses set to false via config block" do
+
+    before do
+      ForeignKeyValidation.configure {|c| c.inject_subclasses = false }
+      Member.send :validate_foreign_keys
+    end
+
+    it "does allow to rewrite user id of developer" do
+      developer.user_id = other_user.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to_not include("user_id of boss does not match developers user_id.")
+      expect(developer.reload.user_id).to eq(other_user.id)
+    end
+
+    it "does allow to rewrite boss id of developer" do
+      developer.custom_boss_id = other_manager.id
+      developer.save
+      expect(developer.errors.messages.values.flatten).to_not include("user_id of boss does not match developers user_id.")
+      expect(developer.reload.custom_boss_id).to eq(other_manager.id)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -14,6 +14,7 @@ RSpec.configure do |config|
 
   # reset and reload model classes for each run
   config.before(:each) do
+    ForeignKeyValidation.configuration = nil
     load "support/reset_models.rb"
     load "support/load_models.rb"
   end

data/spec/validator/base_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe ForeignKeyValidation::Validator do
+
+  let(:user) { User.create }
+  let(:other_user) { User.create }
+
+  describe ".new" do
+
+    subject { ForeignKeyValidation::Validator }
+
+    it "initializes new validator" do
+      expect(subject.new).to be_instance_of ForeignKeyValidation::Validator
+    end
+
+  end
+
+  describe "#validate" do
+
+    subject { ForeignKeyValidation::Validator }
+
+    it "creates no validations if params blank" do
+      expect(subject.new.validate).to be false
+    end
+
+    it "creates no validations if object is valid" do
+      object = Issue.create(user: user, project: Project.create(user: user))
+      expect(subject.new(validate_against_key: :user_id, reflection_names: [:project], object: object).validate).to be false
+    end
+
+    it "creates validations if object is invalid" do
+      object = Issue.create(user: user, project: Project.create(user: other_user))
+      expect(subject.new(validate_against_key: :user_id, reflection_names: [:project], object: object).validate).to be true
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreign_key_validation
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Marcus Geißler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -167,15 +167,18 @@ files:
 - lib/foreign_key_validation/model_extension.rb
 - lib/foreign_key_validation/validator.rb
 - lib/foreign_key_validation/version.rb
-- spec/models/validation_with_custom_attrs_spec.rb
-- spec/models/validation_with_exceptions_spec.rb
-- spec/models/validation_with_missing_foreign_key_spec.rb
-- spec/models/validation_without_attrs_spec.rb
-- spec/models/without_validation_spec.rb
+- spec/collector/base_spec.rb
+- spec/model_extension/validation_with_config_block_spec.rb
+- spec/model_extension/validation_with_custom_attrs_spec.rb
+- spec/model_extension/validation_with_exceptions_spec.rb
+- spec/model_extension/validation_with_missing_foreign_key_spec.rb
+- spec/model_extension/validation_without_attrs_spec.rb
+- spec/model_extension/without_validation_spec.rb
 - spec/spec_helper.rb
 - spec/support/load_models.rb
 - spec/support/reset_models.rb
 - spec/support/schema.rb
+- spec/validator/base_spec.rb
 homepage: https://github.com/marcusg/foreign_key_validation
 licenses:
 - MIT
@@ -201,12 +204,15 @@ signing_key:
 specification_version: 4
 summary: Protect the foreign keys in your Rails models.
 test_files:
-- spec/models/validation_with_custom_attrs_spec.rb
-- spec/models/validation_with_exceptions_spec.rb
-- spec/models/validation_with_missing_foreign_key_spec.rb
-- spec/models/validation_without_attrs_spec.rb
-- spec/models/without_validation_spec.rb
+- spec/collector/base_spec.rb
+- spec/model_extension/validation_with_config_block_spec.rb
+- spec/model_extension/validation_with_custom_attrs_spec.rb
+- spec/model_extension/validation_with_exceptions_spec.rb
+- spec/model_extension/validation_with_missing_foreign_key_spec.rb
+- spec/model_extension/validation_without_attrs_spec.rb
+- spec/model_extension/without_validation_spec.rb
 - spec/spec_helper.rb
 - spec/support/load_models.rb
 - spec/support/reset_models.rb
 - spec/support/schema.rb
+- spec/validator/base_spec.rb