foreign_key_validation 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 7af20d0ad7b99c870491e939cb66a117ef0f4def
-  data.tar.gz: e7c83abbc241fbcfab820e58b46b00fa64632ce8
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjczM2MxZDBjMGMyNzYxZDNiZTM1YTliYTZjOTg2MDk4MjcyY2UyNA==
+  data.tar.gz: !binary |-
+    MTljYzJiY2IwOWM5NzY5OTU0M2FkMzNhODRmNWM3NDYyYTY4MDEzYQ==
 SHA512:
-  metadata.gz: 92ec77233357a8e66e4410364439e5de674ac84d3c6a5d7f43e96193798495287e9f43426a579f56e05560ee01e24a85a7e7f134262f2ac917620743e52f4a8a
-  data.tar.gz: 08191da451eb213cd450d013fac17de97eb433b5a9984c3358e406df51a75bf141da22c400995a689f3c27705dfe65d604a0e74b39f062841ce8febfc4334822
+  metadata.gz: !binary |-
+    Mjc0OTVlOGUyZWFkOTQ3ODE0OGFkNjJjZTMxMDdjYjc5ODhhMDA0NTFkZTE5
+    OGUxODgwNTRlYTAxM2ViNDRkZDMyZmYzNzMzMGVkZWFlMGZmOTY5OGQyM2Ji
+    ZWY4ZDU2NWM2MWNmMDJmY2MzMGQ2OWMzYjE0OGE5NDE0YjU2N2Q=
+  data.tar.gz: !binary |-
+    NmE5NzEyODJlNGMzNmVkYWI2ZDAwMTFiYTRkODMyZWExYzc2YWE0ZDVlYzEw
+    MzRiZGFkMzY3MzQxN2Y3ODg4ZDg5MmM5OWI3OGM0MjAwMDM3ZWEyZGM3N2Qw
+    M2IzM2E0ZDg0NmZhMDQyMGIwZWUxYjdkOTIwYjI0MmQwODVkYzA=

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+1.9.3

data/README.md

@@ -3,7 +3,9 @@
 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.
 
 ## Requirements
-    rails >= 3.2
+    ruby >= 1.9
+    rails
+    active_record
 
 ## Installation
 
@@ -21,22 +23,21 @@ Or install it yourself as:
 
 ## Usage
 
-Call `validate_foreign_keys` in your model. By default it assumes that it should check all foreign keys against the `user_id` column. So any relation accessed by `*_id` columns (except `user_id`) would be checked for a matching `user_id` (if the column exists).
+Call `validate_foreign_keys` 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.
 
 Change behaviour by calling `validate_foreign_keys` with arguments hash.
 
-	validate_foreign_keys on: :admin_user_id, with: [:project_id]
+    validate_foreign_keys on: :admin_user, with: [:project]
 
 This would only check `model.project.admin_user_id` to match `model.admin_user_id`.
 
 ## Note
 
-Only tested with ruby 2.x and ActiveRecord
+Only tested with ActiveRecord
 
 ## TODO
 
 - Tests!
-- Support Ruby 1.9 (remove keyword arguments)
 
 ## Contributing
 

data/lib/foreign_key_validation/model_extension.rb

@@ -4,41 +4,30 @@ module ForeignKeyValidation
 
     included do
       private
-      def validate_foreign_key(key_to_validate_against, validation_key)
-        relation = validation_key.gsub('_id', '')
-
-        # do not try to validate if self does not respond to relation or one of the keys is nil
-        return if !respond_to?(relation) or send(relation).try(key_to_validate_against).nil? or send(key_to_validate_against).nil?
-
-        # add error if keys does not match
-        if send(relation).send(key_to_validate_against) != send(key_to_validate_against)
-          errors.add(key_to_validate_against, "#{key_to_validate_against} of #{relation} does not match #{self.class.name.tableize} #{key_to_validate_against}")
+      def validate_foreign_key(validate_against, relation)
+        if send(relation).send("#{validate_against}_id") != send("#{validate_against}_id")
+          errors.add(validate_against, "#{validate_against} of #{relation} does not match #{self.class.name.tableize} #{validate_against}")
         end
       end
     end
 
     module ClassMethods
-      def validate_foreign_keys(on: :user_id, with: nil)
-        key_to_validate_against = on.to_s
-
-        # check if key_to_validate_against is present as column
-        raise ArgumentError, "No foreign key #{key_to_validate_against} on #{self.table_name} table!" unless self.column_names.include?(key_to_validate_against)
-
-        # use provided 'with' array or column_names from self to get all foreign keys
-        keys_to_validate_with = (Array(with).map(&:to_s) if with) || self.column_names.select {|n| n.match(/\w_id/)}
+      def validate_foreign_keys(opt={})
+        validate_against  = (opt[:on] || :user).to_s
+        reflections       = self.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}
 
-        # reject keys that match either the key_to_validate_against or the current class name key (needed for sti models)
-        keys_to_validate_with.reject! {|n| n == key_to_validate_against || n == "#{self.class.name.underscore}_id"  }
+        raise ArgumentError, "No foreign key #{validate_against} on #{self.table_name} table!" unless reflections.include?(validate_against)
+        raise ArgumentError, "Unknown relation in #{validate_with}!" unless validate_with.all? {|k| reflections.include?(k) }
 
-        define_method "validate_foreign_keys_on_#{key_to_validate_against}" do
-          keys_to_validate_with.each do |validation_key|
-            validate_foreign_key(key_to_validate_against, validation_key)
+        define_method "validate_foreign_keys_on_#{validate_against}" do
+          validate_with.each do |relation|
+            validate_foreign_key(validate_against, relation)
           end
         end
-        private "validate_foreign_keys_on_#{key_to_validate_against}".to_sym
+        private "validate_foreign_keys_on_#{validate_against}".to_sym
 
-        # add before filter to validate key
-        before_validation "validate_foreign_keys_on_#{key_to_validate_against}"
+        before_validation "validate_foreign_keys_on_#{validate_against}"
       end
     end
   end

data/lib/foreign_key_validation/version.rb

@@ -1,3 +1,3 @@
 module ForeignKeyValidation
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/models/model_spec.rb

@@ -71,21 +71,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_id of project does not match ideas user_id")
+      expect(idea.errors.messages.values.flatten).to include("user of project does not match ideas user")
       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_id of project does not match issues user_id")
+      expect(issue.errors.messages.values.flatten).to include("user of project does not match issues user")
       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_id of issue does not match comments user_id")
+      expect(comment.errors.messages.values.flatten).to include("user of issue does not match comments user")
       expect(comment.reload.user_id).to_not eq(42)
     end
 
@@ -101,34 +101,78 @@ describe ForeignKeyValidation::ModelExtension do
     end
 
     it "does not allow to call private validate_foreign_keys_on_* methods" do
-      expect{issue.validate_foreign_keys_on_user_id}.to raise_exception(/private method `validate_foreign_keys_on_user_id' called/)
+      expect{issue.validate_foreign_keys_on_user}.to raise_exception(/private method `validate_foreign_keys_on_user' called/)
     end
 
   end
 
-  context "With calling validation with wrong attributes hash" do
+  context "With calling validation with attributes hash" do
+    before do
+      Idea.class_eval do
+        validate_foreign_keys on: :user, with: :project
+      end
+    end
 
     # NOTE: it's important here to not create the object through relation (user.projects.create...)
     #       it looks like active_record is caching the classes - but we need to test different class configs
     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 }
 
-    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!")
+    it "uses same user ids by default" do
+      expect(project.user_id).to eq(user.id)
+      expect(idea.user_id).to eq(user.id)
     end
 
-    it "does not validate due to wrong :with key" do
-      Issue.class_eval do
-        validate_foreign_keys with: :not_existing_id
-      end
+    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.reload.user_id).to_not eq(42)
+    end
+
+    it "allow to rewrite user id of project" do
+      project.user_id = 42
+      project.save
+      project.reload
+      expect(project.user_id).to eq(42)
+    end
+
+    it "allow to rewrite user id of issue" do
       issue.user_id = 42
       issue.save
       issue.reload
       expect(issue.user_id).to eq(42)
     end
 
+    it "allow to rewrite user id of comment" do
+      comment.user_id = 42
+      comment.save
+      comment.reload
+      expect(comment.user_id).to eq(42)
+    end
+
+  end
+
+  context "With calling validation with wrong attributes hash" do
+
+    # NOTE: it's important here to not create the object through relation (user.projects.create...)
+    #       it looks like active_record is caching the classes - but we need to test different class configs
+    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 }
+
+    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!")
+    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"]!')
+    end
+
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreign_key_validation
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Marcus Geißler
@@ -14,84 +14,84 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
 description: Protect the foreign keys in your Rails models. Really.
@@ -101,10 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - LICENSE
 - README.md
@@ -128,12 +128,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []