foreign_key_validation 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6efa881cebd85a67f4706bf7251ee36caa3cc710
-  data.tar.gz: 52bcaf493a5508f7f519e6af787082ad82ead28e
+  metadata.gz: 7af20d0ad7b99c870491e939cb66a117ef0f4def
+  data.tar.gz: e7c83abbc241fbcfab820e58b46b00fa64632ce8
 SHA512:
-  metadata.gz: 353a11c25d79edd2b1148118dc08989f972244f9592f5414a24826418a66789343b32cecf6959fa511237d4131101c761731a1b252fcc62d000aa7a1bb79dad8
-  data.tar.gz: 6a9c0ed52a1e93b28435bc87dcd977304c3f15aee5b2f516c84b1683d7de7c2864514e4c7c0ab1946946efc3b04f91be6f2c29ec3a3f4b2e6bb6595971322fb8
+  metadata.gz: 92ec77233357a8e66e4410364439e5de674ac84d3c6a5d7f43e96193798495287e9f43426a579f56e05560ee01e24a85a7e7f134262f2ac917620743e52f4a8a
+  data.tar.gz: 08191da451eb213cd450d013fac17de97eb433b5a9984c3358e406df51a75bf141da22c400995a689f3c27705dfe65d604a0e74b39f062841ce8febfc4334822

data/README.md

@@ -1,6 +1,9 @@
 # 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 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
 
 ## Installation
 
@@ -28,7 +31,7 @@ This would only check `model.project.admin_user_id` to match `model.admin_user_i
 
 ## Note
 
-Only testet with ruby 2.x
+Only tested with ruby 2.x and ActiveRecord
 
 ## TODO
 

data/foreign_key_validation.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", ">= 3.2"
-
+  spec.add_development_dependency "rails", "~> 4.0.0"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.1"
   spec.add_development_dependency "rspec-rails", "~> 3.0"

data/lib/foreign_key_validation/model_extension.rb

@@ -3,6 +3,7 @@ module ForeignKeyValidation
     extend ActiveSupport::Concern
 
     included do
+      private
       def validate_foreign_key(key_to_validate_against, validation_key)
         relation = validation_key.gsub('_id', '')
 
@@ -17,34 +18,30 @@ module ForeignKeyValidation
     end
 
     module ClassMethods
-
       def validate_foreign_keys(on: :user_id, with: nil)
-        key_to_validate_against = on
+        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.to_s)
+        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/)}
 
         # 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.to_s == key_to_validate_against.to_s || n.to_s == "#{self.class.name.underscore}_id"  }
+        keys_to_validate_with.reject! {|n| n == key_to_validate_against || n == "#{self.class.name.underscore}_id"  }
 
         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)
           end
-
         end
-        before_validation "validate_foreign_keys_on_#{key_to_validate_against}"
+        private "validate_foreign_keys_on_#{key_to_validate_against}".to_sym
 
+        # add before filter to validate key
+        before_validation "validate_foreign_keys_on_#{key_to_validate_against}"
       end
-
     end
-
   end
-
 end
 
-ActiveRecord::Base.send :include, ForeignKeyValidation::ModelExtension
+ActiveRecord::Base.send :include, ForeignKeyValidation::ModelExtension

data/lib/foreign_key_validation/version.rb

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

data/spec/models/model_spec.rb

@@ -1,80 +1,135 @@
 require 'spec_helper'
 
-class User < ActiveRecord::Base
-  has_many :projects
-  has_many :ideas
-end
+describe ForeignKeyValidation::ModelExtension do
 
-class Project < ActiveRecord::Base
-  belongs_to :user
-  has_many :ideas
-  validates_presence_of :user_id, presence: true
-end
+  context "Without calling validation" do
 
-class Idea < ActiveRecord::Base
-  belongs_to :project
-  belongs_to :user
-  validates_presence_of :user_id, :project_id, presence: true
-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 }
 
-describe "Behaviour without validate_foreign_keys" do
+    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
 
-  let!(:user) { User.create }
-  let!(:project) { user.projects.create }
-  let!(:idea) { project.ideas.create user: user }
+    it "allow to rewrite user id of idea" do
+      idea.user_id = 42
+      idea.save
+      idea.reload
+      expect(idea.user_id).to eq(42)
+    end
 
-  it "uses same user ids by default" do
-    expect(project.user_id).to eq(user.id)
-    expect(user.id).to eq(user.id)
-    expect(idea.user_id).to eq(user.id)
-  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 idea" do
-    idea.user_id = 42
-    idea.save
-    idea.reload
-    expect(idea.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
 
-  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
 
-end
+  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
+    end
 
-describe "Behaviour with validate_foreign_keys" 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(:idea) { Idea.create user: user, project: project }
+    let(:issue) { Issue.create user: user, project: project }
+    let(:comment) { Comment.create user: user, issue: issue }
+
+    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
 
-  before do
-    Idea.class_eval do
-      validate_foreign_keys
+    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.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.reload.user_id).to_not eq(42)
     end
-  end
 
-  let!(:user) { User.create }
-  let!(:project) { user.projects.create }
-  let!(:idea) { project.ideas.create user: user }
+    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.reload.user_id).to_not eq(42)
+    end
 
-  it "uses same user ids by default" do
-    expect(project.user_id).to eq(user.id)
-    expect(user.id).to eq(user.id)
-    expect(idea.user_id).to eq(user.id)
-  end
+    it "does allow to rewrite user id of project" do
+      project.user_id = 42
+      project.save
+      expect(project.errors).to be_empty
+      expect(project.reload.user_id).to 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
+
+    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/)
+    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_id of project does not match ideas user_id")
-    expect(idea.reload.user_id).to_not eq(42)
   end
 
-  it "does allow to rewrite user id of project" do
-    project.user_id = 42
-    project.save
-    expect(project.errors).to be_empty
-    expect(project.reload.user_id).to eq(42)
+  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 "does not validate due to wrong :with key" do
+      Issue.class_eval do
+        validate_foreign_keys with: :not_existing_id
+      end
+      issue.user_id = 42
+      issue.save
+      issue.reload
+      expect(issue.user_id).to eq(42)
+    end
+
   end
 
-end
+
+end

data/spec/spec_helper.rb

@@ -8,11 +8,17 @@ RSpec.configure do |config|
   config.filter_run :focus
   config.infer_base_class_for_anonymous_controllers = true
 
-  # config.order = 'random'
+  # reset and reload model classes for each run
+  config.before(:each) do
+    load "support/reset_models.rb"
+    load "support/load_models.rb"
+  end
+
+  config.order = 'random'
 end
 
 setup_sqlite_db = lambda do
   ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-  load "schema.rb"
+  load "support/schema.rb"
 end
-silence_stream(STDOUT, &setup_sqlite_db)
+silence_stream(STDOUT, &setup_sqlite_db)

data/spec/support/load_models.rb

@@ -0,0 +1,28 @@
+require "active_record"
+
+class User < ActiveRecord::Base
+  has_many :projects
+  has_many :ideas
+end
+
+class Project < ActiveRecord::Base
+  belongs_to :user
+  has_many :ideas
+  has_many :issues
+end
+
+class Idea < ActiveRecord::Base
+  belongs_to :project
+  belongs_to :user
+end
+
+class Issue < ActiveRecord::Base
+  belongs_to :project
+  belongs_to :user
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :issue
+  belongs_to :user
+end

data/spec/support/reset_models.rb

@@ -0,0 +1,5 @@
+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)

data/spec/support/schema.rb

@@ -0,0 +1,26 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table "users", force: true do |t|
+  end
+
+  create_table "projects", force: true do |t|
+    t.integer   "user_id"
+  end
+
+  create_table "ideas", force: true do |t|
+    t.integer   "user_id"
+    t.integer   "project_id"
+  end
+
+  create_table "issues", force: true do |t|
+    t.integer   "user_id"
+    t.integer   "project_id"
+  end
+
+  create_table "comments", force: true do |t|
+    t.integer   "user_id"
+    t.integer   "issue_id"
+  end
+
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: foreign_key_validation
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Marcus Geißler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2014-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
+        version: 4.0.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -107,7 +107,6 @@ files:
 - ".ruby-version"
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - foreign_key_validation.gemspec
@@ -115,8 +114,10 @@ files:
 - lib/foreign_key_validation/model_extension.rb
 - lib/foreign_key_validation/version.rb
 - spec/models/model_spec.rb
-- spec/schema.rb
 - spec/spec_helper.rb
+- spec/support/load_models.rb
+- spec/support/reset_models.rb
+- spec/support/schema.rb
 homepage: https://github.com/marcusg/foreign_key_validation
 licenses:
 - MIT
@@ -143,5 +144,7 @@ specification_version: 4
 summary: Protect the foreign keys in your Rails models.
 test_files:
 - spec/models/model_spec.rb
-- spec/schema.rb
 - spec/spec_helper.rb
+- spec/support/load_models.rb
+- spec/support/reset_models.rb
+- spec/support/schema.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Marcus Geißler
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/spec/schema.rb

@@ -1,15 +0,0 @@
-ActiveRecord::Schema.define(:version => 20130730063732) do
-
-  create_table "users", :force => true do |t|
-  end
-
-  create_table "projects", :force => true do |t|
-    t.integer   "user_id"
-  end
-
-  create_table "ideas", :force => true do |t|
-    t.integer   "user_id"
-    t.integer   "project_id"
-  end
-
-end