foreign_key_validation 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Zjg4OGRlMzQzMTJhZmQyOWFhOGQzNTI2NDhhYTE0YThlZWM0Y2NjMg==
+    NjBhMDg4MzJhYjgzMjlkMDJkZDBiODI5ZGM1ZjE5MWQ2NmI1YzIxMw==
   data.tar.gz: !binary |-
-    NTRlZDQxNTUyMTdiZGRmYjQwNTlkMzkwOTUwMTMyMWNjZmUyYzBjZg==
+    ZTBiZTExNmE4NjM4MGRmM2QwYjI3MmExZDBlMmU3NjY4ZDlkYTIzMw==
 SHA512:
   metadata.gz: !binary |-
-    NDAyZjI0YzcxYzQzOGVmMThkYzk5MmUyNDcyZmY4YjA3OWU2NTc1OTA2ODc2
-    ODVjOWEwZDhhYWVjYjk3MzAyNzZlNzI5NTBmZDNjYjQ2Zjk4MTBlZTRhZjgx
-    M2U2NzBjY2QzYzEyNmEyNzFhYTE1ZDA2ODAwNjYyMTQ0ZDFhNzY=
+    ZDM4OGQ0ZDRhYjNhOTFhNzIzMTM4YzUxOWI1ZWJhZGNjYjNhNDgzNDEyMWVl
+    YzA1ODQwYzRjYjY5MGY2MTBlMTMxOGU5MDE2YjRlMjgyNmMyZWFkNGJlODJk
+    NjFiYjAyZjIyYTg5MWUzMDhmMWU5MjNlNGIzNjMxZGE5MDIxOWQ=
   data.tar.gz: !binary |-
-    NWM2OWNhNDVkMDdmNDgxNTRmNzEzMTU1NzNjYTI3M2Y2ZjA3ZWYzYWViYjll
-    NjdmOGE2MjI2NTE3MjE3ZWZmZWZjYTI0ZDk5YTg2N2FlMmQzNDM4YWE0ZmU2
-    NGNlMGM1YTFlNzZjMDEyNjY2OWU1ZjNiY2I5ZTk4Y2NlM2YwNTM=
+    YTYzOTRlODQ1ZjgwYWFlNTIzYmRmNDRmNTVjMDJhMTViNzVmNTc3ZmNlYThl
+    NWE0Yjc3NDA4OTgyZWUxN2M3ZTJlZDQ1MTYwMmFjZDY2MzM5ZDllMjM3ZTNk
+    YzI1NWNmZTI4ZjI1NmNiMDMzOWU0Y2U1MjRjZWVlY2Q1MDMyYTA=

data/README.md

@@ -1,6 +1,6 @@
 # foreign_key_validation
 
-Protect your models by specifying a collection of foreign keys that should be tested for consistency with the `belongs_to` relations. For example, when the `user_id` is used in all models we can check if the `user_id` of `model a` matches `user_id` of `model b` before saving the records.
+Protect your models by specifying a collection of relations that should be tested for consistency with the `user_id` column. For example, when the `user_id` is used in all models we can check if the `user_id` of `model a` matches `user_id` of `model b` before saving the records - if the IDs are different, an error will be attached to the errors hash of `self`. 
 
 ## Requirements
     ruby >= 1.9
@@ -23,21 +23,18 @@ Or install it yourself as:
 
 ## Usage
 
-Call `validate_foreign_keys` below the association definitions (`belongs_to`, ...) in your model. By default it assumes that it should check all foreign keys against the `user_id` column. So any relation (except `user`) will be checked for a matching `user_id` if the column exists.
+Call `validate_foreign_keys` below the association definitions (`belongs_to`, ...) in your model. By default it assumes that it should check all `belongs_to` relations against the `user_id` column. So any relation will be checked for a matching `user_id`. 
 
 Change behaviour by calling `validate_foreign_keys` with arguments hash.
 
     validate_foreign_keys on: :admin_user, with: [:project]
 
-This would only check `model.project.admin_user_id` to match `model.admin_user_id`.
+This would only check `model.project.admin_user_id` to match `model.admin_user_id` before saving the record.
 
 ## Note
 
 Only tested with ActiveRecord
 
-## TODO
-
-- Tests!
 
 ## Contributing
 

data/lib/foreign_key_validation/model_extension.rb

@@ -4,27 +4,31 @@ module ForeignKeyValidation
 
     included do
       private
-      def validate_foreign_key(validate_against, relation)
-        return if send(relation).try("#{validate_against}_id").nil? or try("#{validate_against}_id").nil?
+      def validate_foreign_key(validate_against_key, reflection_name)
+        return if send(reflection_name).try(validate_against_key).nil? or try(validate_against_key).nil?
 
-        if send(relation).send("#{validate_against}_id") != send("#{validate_against}_id")
-          errors.add(validate_against, "#{validate_against} of #{relation} does not match #{self.class.table_name} #{validate_against}")
+        if send(reflection_name).send(validate_against_key) != send(validate_against_key)
+          errors.add(validate_against_key, "#{validate_against_key} of #{reflection_name} does not match #{self.class.name.tableize} #{validate_against_key}")
         end
       end
     end
 
     module ClassMethods
       def validate_foreign_keys(opt={})
-        validate_against  = (opt[:on] || :user).to_s
-        reflections       = reflect_on_all_associations(:belongs_to).map(&:name).map(&:to_s)
-        validate_with     = ((Array(opt[:with]).map(&:to_s) if opt[:with]) || reflections).reject {|n| n == validate_against}
+        subclasses.map {|klass| klass.send(:validate_foreign_keys, opt) } if subclasses.any?
 
-        raise ArgumentError, "No foreign key #{validate_against} on #{table_name} table!" unless reflections.include?(validate_against)
-        raise ArgumentError, "Unknown relation in #{validate_with}!" unless validate_with.all? {|k| reflections.include?(k) }
+        validate_against      = (opt[:on] || :user).to_s
+        validate_against_key  = "#{validate_against}_id"
+        reflection_names      = reflect_on_all_associations(:belongs_to).map(&:name).map(&:to_s)
+        validate_with         = ((Array(opt[:with]).map(&:to_s) if opt[:with]) || reflection_names).reject {|n| n == validate_against}
+
+        raise ArgumentError, "Can't find any belongs_to relations for #{name} class. Put validation call below association definitions" if reflection_names.empty?
+        raise ArgumentError, "No foreign key #{validate_against_key} on #{table_name} table!" unless reflection_names.include?(validate_against)
+        raise ArgumentError, "Unknown relation in #{validate_with}!" unless validate_with.all? {|k| reflection_names.include?(k) }
 
         define_method "validate_foreign_keys_on_#{validate_against}" do
-          validate_with.each do |relation|
-            validate_foreign_key(validate_against, relation)
+          validate_with.each do |reflection_name|
+            validate_foreign_key(validate_against_key, reflection_name)
           end
         end
         private "validate_foreign_keys_on_#{validate_against}".to_sym

data/lib/foreign_key_validation/version.rb

@@ -1,3 +1,3 @@
 module ForeignKeyValidation
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/models/model_spec.rb

@@ -5,13 +5,16 @@ describe ForeignKeyValidation::ModelExtension do
   # NOTE: it's important to not create the objects through relation (user.projects.create...)
   #       it looks like active_record is caching the classes - but we need to test different class configs
 
-  context "Without calling validation" do
+  context "without calling validation" do
 
     let(:user) { User.create }
     let(:project) { Project.create user: user }
     let(:idea) { Idea.create user: user, project: project }
     let(:issue) { Issue.create user: user, project: project }
     let(:comment) { Comment.create user: user, issue: issue }
+    # sti model
+    let(:manager) { Manager.create user: user }
+    let(:developer) { Developer.create user: user, boss: manager }
 
     it "uses same user ids by default" do
       expect(project.user_id).to eq(user.id)
@@ -46,14 +49,22 @@ describe ForeignKeyValidation::ModelExtension do
       expect(comment.user_id).to eq(42)
     end
 
+    it "allow to rewrite user id of developer" do
+      developer.user_id = 42
+      developer.save
+      developer.reload
+      expect(developer.user_id).to eq(42)
+    end
+
   end
 
-  context "With calling validation" do
+  context "with calling validation" do
     before do
       Idea.send :validate_foreign_keys
       Project.send :validate_foreign_keys
       Issue.send :validate_foreign_keys
       Comment.send :validate_foreign_keys
+      Member.send :validate_foreign_keys # sti model
     end
 
     let(:user) { User.create }
@@ -61,6 +72,9 @@ describe ForeignKeyValidation::ModelExtension do
     let(:idea) { Idea.create user: user, project: project }
     let(:issue) { Issue.create user: user, project: project }
     let(:comment) { Comment.create user: user, issue: issue }
+    # sti model
+    let(:manager) { Manager.create user: user }
+    let(:developer) { Developer.create user: user, boss: manager }
 
     it "uses same user ids by default" do
       expect(project.user_id).to eq(user.id)
@@ -70,21 +84,21 @@ describe ForeignKeyValidation::ModelExtension do
     it "does not allow to rewrite user id of idea" do
       idea.user_id = 42
       idea.save
-      expect(idea.errors.messages.values.flatten).to include("user of project does not match ideas user")
+      expect(idea.errors.messages.values.flatten).to include("user_id of project does not match ideas user_id")
       expect(idea.reload.user_id).to_not eq(42)
     end
 
     it "does not allow to rewrite user id of issue" do
       issue.user_id = 42
       issue.save
-      expect(issue.errors.messages.values.flatten).to include("user of project does not match issues user")
+      expect(issue.errors.messages.values.flatten).to include("user_id of project does not match issues user_id")
       expect(issue.reload.user_id).to_not eq(42)
     end
 
     it "does not allow to rewrite user id of comment" do
       comment.user_id = 42
       comment.save
-      expect(comment.errors.messages.values.flatten).to include("user of issue does not match comments user")
+      expect(comment.errors.messages.values.flatten).to include("user_id of issue does not match comments user_id")
       expect(comment.reload.user_id).to_not eq(42)
     end
 
@@ -95,6 +109,13 @@ describe ForeignKeyValidation::ModelExtension do
       expect(project.reload.user_id).to eq(42)
     end
 
+    it "does not allow to rewrite user id of developer" do
+      developer.user_id = 42
+      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(42)
+    end
+
     it "does not allow to call private validate_foreign_key method" do
       expect{issue.validate_foreign_key("test", "unrat")}.to raise_exception(/private method `validate_foreign_key' called/)
     end
@@ -105,7 +126,7 @@ describe ForeignKeyValidation::ModelExtension do
 
   end
 
-  context "With calling validation with attributes hash" do
+  context "with calling validation with attributes hash" do
     before do
       Idea.class_eval do
         validate_foreign_keys on: :user, with: :project
@@ -126,7 +147,7 @@ describe ForeignKeyValidation::ModelExtension do
     it "does not allow to rewrite user id of idea" do
       idea.user_id = 42
       idea.save
-      expect(idea.errors.messages.values.flatten).to include("user of project does not match ideas user")
+      expect(idea.errors.messages.values.flatten).to include("user_id of project does not match ideas user_id")
       expect(idea.reload.user_id).to_not eq(42)
     end
 
@@ -153,24 +174,28 @@ describe ForeignKeyValidation::ModelExtension do
 
   end
 
-  context "With calling validation with wrong attributes hash" do
-
-    let(:user) { User.create }
-    let(:project) { Project.create user: user }
-    let(:issue) { Issue.create user: user, project: project }
-    let(:comment) { Comment.create user: user, issue: issue }
+  context "with calling validation and wrong attributes hash" do
 
     it "raises error due to wrong :on key" do
-      expect{Idea.class_eval { validate_foreign_keys on: :not_existing_id }}.to raise_error("No foreign key not_existing_id on ideas table!")
+      expect{Idea.class_eval { validate_foreign_keys on: :not_existing }}.to raise_error("No foreign key not_existing_id on ideas table!")
     end
 
     it "raises error due to wrong :with key" do
-      expect{Idea.class_eval { validate_foreign_keys with: :not_existing_id }}.to raise_error('Unknown relation in ["not_existing_id"]!')
+      expect{Idea.class_eval { validate_foreign_keys with: :not_existing }}.to raise_error('Unknown relation in ["not_existing"]!')
+    end
+
+  end
+
+  context "with calling validation and missing relations" do
+
+    it "raises error due to wrong :on key" do
+      expect{Dummy.class_eval { validate_foreign_keys }}.to raise_error("Can't find any belongs_to relations for Dummy class. Put validation call below association definitions")
     end
 
   end
 
-  context "With calling validation and missing foreign key on self" do
+
+  context "with calling validation and missing foreign key on self" do
 
     before do
       Issue.class_eval do
@@ -185,13 +210,13 @@ describe ForeignKeyValidation::ModelExtension do
     it "does not allow to rewrite user id of issue" do
       issue.user_id = 42
       issue.save
-      expect(issue.errors.messages.values.flatten).to include("user of project does not match issues user")
+      expect(issue.errors.messages.values.flatten).to include("user_id of project does not match issues user_id")
       expect(issue.reload.user_id).to_not eq(42)
     end
 
   end
 
-  context "With calling validation and missing foreign key on relation" do
+  context "with calling validation and missing foreign key on relation" do
 
     before do
       Issue.class_eval do

data/spec/support/load_models.rb

@@ -3,10 +3,16 @@ require "active_record"
 class User < ActiveRecord::Base
   has_many :projects
   has_many :ideas
+  has_many :managers
+  has_many :developers
+  has_many :comments
+  has_many :issues
+  has_many :ideas
 end
 
 class Project < ActiveRecord::Base
   belongs_to :user
+  belongs_to :member
   has_many :ideas
   has_many :issues
 end
@@ -26,3 +32,19 @@ class Comment < ActiveRecord::Base
   belongs_to :issue
   belongs_to :user
 end
+
+class Dummy < ActiveRecord::Base
+end
+
+class Member < ActiveRecord::Base
+  belongs_to :user
+  has_many :projects
+end
+
+class Manager < Member
+  has_many :developers
+end
+
+class Developer < Member
+  belongs_to :boss, class_name: "Manager", foreign_key: :boss_id
+end

data/spec/support/reset_models.rb

@@ -1,5 +1,8 @@
-Object.send(:remove_const, :User)     if Object.constants.include?(:User)
-Object.send(:remove_const, :Project)  if Object.constants.include?(:Project)
-Object.send(:remove_const, :Idea)     if Object.constants.include?(:Idea)
-Object.send(:remove_const, :Issue)    if Object.constants.include?(:Issue)
-Object.send(:remove_const, :Comment)  if Object.constants.include?(:Comment)
+Object.send(:remove_const, :User)       if Object.constants.include?(:User)
+Object.send(:remove_const, :Project)    if Object.constants.include?(:Project)
+Object.send(:remove_const, :Idea)       if Object.constants.include?(:Idea)
+Object.send(:remove_const, :Issue)      if Object.constants.include?(:Issue)
+Object.send(:remove_const, :Comment)    if Object.constants.include?(:Comment)
+Object.send(:remove_const, :Member)     if Object.constants.include?(:Member)
+Object.send(:remove_const, :Developer)  if Object.constants.include?(:Developer)
+Object.send(:remove_const, :Manager)    if Object.constants.include?(:Manager)

data/spec/support/schema.rb

@@ -6,6 +6,7 @@ ActiveRecord::Schema.define do
 
   create_table "projects", force: true do |t|
     t.integer   "user_id"
+    t.integer   "member_id"
   end
 
   create_table "ideas", force: true do |t|
@@ -23,4 +24,13 @@ ActiveRecord::Schema.define do
     t.integer   "issue_id"
   end
 
+  create_table "dummies", force: true do |t|
+  end
+
+  create_table "members", force: true do |t|
+    t.integer   "user_id"
+    t.integer   "boss_id"
+    t.string    "type"
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreign_key_validation
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Marcus Geißler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-31 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails