foreign_key_validation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2da928f68d5283f2afdbdf6f91f8a838bea9a56e
+  data.tar.gz: 5f979905a156bc8d56bb2510b25808a9ce5ef968
+SHA512:
+  metadata.gz: e285968bf2b4e9b799679a4f7eecfe7f1d62aaa47b086f738a989acef715e22f55864b958d0ba5779b6cf398762ca455764c58c2de674a0bd3526baf50a6ecef
+  data.tar.gz: 771db50df035df9566356e647e162b2462fecd2c17c152e31cb1f22aed2783b4200719694acba0b2625f0d76a45498cf913d16a03769bfac766e5299ae5927d1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foreign_key_validation.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Marcus Geißler
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+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/README.md

@@ -0,0 +1,44 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'foreign_key_validation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foreign_key_validation
+
+## 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).
+
+Change behaviour by calling `validate_foreign_keys` with arguments hash.
+
+	validate_foreign_keys on: :admin_user_id, with: [:project_id]
+
+This would only check `model.project.admin_user_id` to match `model.admin_user_id`.
+
+## Note
+
+Only testet with ruby 2.x
+
+## TODO
+
+- Tests!
+- Support Ruby 1.9 (remove keyword arguments)
+
+## Contributing
+
+1. Fork it ( https://github.com/marcusg/foreign_key_validation/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/foreign_key_validation.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foreign_key_validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "foreign_key_validation"
+  spec.version       = ForeignKeyValidation::VERSION
+  spec.authors       = ["Marcus Geißler"]
+  spec.email         = ["marcus3006@gmail.com"]
+  spec.summary       = %q{Protect the foreign keys in your Rails models.}
+  spec.description   = %q{Protect the foreign keys in your Rails models. Really.}
+  spec.homepage      = "https://github.com/marcusg/foreign_key_validation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/foreign_key_validation/model_extension.rb

@@ -0,0 +1,50 @@
+module ForeignKeyValidation
+  module ModelExtension
+    extend ActiveSupport::Concern
+
+    included do
+      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}")
+        end
+      end
+    end
+
+    module ClassMethods
+
+      def validate_foreign_keys(on: :user_id, with: nil)
+        key_to_validate_against = on
+
+        # 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)
+
+        # 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 == key_to_validate_against.to_s || 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}"
+
+      end
+
+    end
+
+  end
+
+end
+
+ActiveRecord::Base.send :include, ForeignKeyValidation::ModelExtension

data/lib/foreign_key_validation/version.rb

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

data/lib/foreign_key_validation.rb

@@ -0,0 +1,2 @@
+require "foreign_key_validation/version"
+require "foreign_key_validation/model_extension"

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: foreign_key_validation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcus Geißler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Protect the foreign keys in your Rails models. Really.
+email:
+- marcus3006@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- foreign_key_validation.gemspec
+- lib/foreign_key_validation.rb
+- lib/foreign_key_validation/model_extension.rb
+- lib/foreign_key_validation/version.rb
+homepage: https://github.com/marcusg/foreign_key_validation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Protect the foreign keys in your Rails models.
+test_files: []