activerecord-database_validations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fe2382415d03dd7e2f8b7006bb505d7da55e42a
+  data.tar.gz: 4e6a436ce619c8ef1c79d3c98f7ac970d6020c9d
+SHA512:
+  metadata.gz: 0e4cdca4c51a1b083e72708fb908bfb01edb31fcb0e70017b511d4f0f5bd63a50d5970be1b075714a4a31a9a497c14c0e37a9d026f5d88d4830dbb310df24a45
+  data.tar.gz: bc7b4ccbe3525ed20a4a4d931d37fcf0a1adb8d045fd47d65166f0674da7e7655a82911d997b226cd1ea7f735e53570c9a19ecda6c1607fd1056ae96ff415d95

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,152 @@
+# ActiveRecord::DatabaseValidations [![Gem Version](https://badge.fury.io/rb/activerecord-database_validations.svg)](http://badge.fury.io/rb/activerecord-database_validations)
+
+An ActiveRecord extension that lets you use your database validations.
+
+* Converts `ActiveRecord::StatementInvalid` related to database validations on
+  `ActiveRecord::Base#save` into a validation error.
+* Quickly add pre-save validations according to your database validations.
+
+Currently supports mysql and postgresql. Feel free to [help support
+more](#extend-database-support).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-database_validations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-database_validations
+
+## Usage
+
+This extension is included into `ActiveRecord::Base` automatically, so all you
+need to do is use it.
+
+
+### Pre-save validation
+
+```ruby
+# == Schema Information
+#
+# Table name: users
+#
+#  id              :integer          not null, primary key
+#  username        :string           not null
+#  group_id        :integer
+#  inviter_id      :integer
+#
+# Indexes
+#
+#  index_boards_on_group_id_and_username (group_id,username) UNIQUE
+#
+# Foreign Keys
+#
+#  add_foreign_key "users", "users", column: "inviter_id"
+#
+
+class User < ActiveRecord::Base
+  validates_database
+  # This is an alias to (which can be used separately):
+  # validates_database_not_null
+  # validates_database_unique
+  # validates_database_foreign_key
+end
+
+# validates_database_not_null
+u = User.new
+u.valid?
+=> false
+u.errors.messages
+=> { :username => ["can't be blank"] }
+
+# validates_database_unique
+u1 = User.new(group_id: 5, username: "somename")
+u1.save
+=> true
+u2 = User.new(group_id: 5, username: "somename")
+u2.save
+=> false
+u2.errors.messages
+=> { :username => ["has already been taken"] }
+
+# validates_database_foreign_key
+u1 = User.new(username: "anothername", inviter_id: -1)
+u1.save
+=> false
+u1.errors.messages
+=> { inviter_id: ["is not included in the list"] }
+```
+
+As mentioned above you can use a specific validation type, and any of these
+`validates_database*` methods can also receive the `:message` option (and
+sometimes other validation options depending on the back-end used to preform
+the actual validation).
+
+### On-save validation
+
+You don't really have to do anything but specify the right validations in your
+schema (or migrations). On knows database validation errors
+`ActiveRecord::Base#save` will return false, `ActiveRecord::Base#save!` will
+raise an `ActiveRecord::RecordInvalid`, and `ActiveRecord::Base#errors` will
+show the error on the specific field.
+
+### On-save vs pre-save validations
+
+* Pre-save does not handle race conditions (`::validates_database_unique` and
+  `::validates_database_foreign_key`). This is the actual reason behind using
+  database validations. So between the time the check was made and the time the
+  record was saved:
+  * There could be an extra record that would make the new record fail the
+    unique validation.
+  * The referenced record could have been deleted that would make the foreign
+    key validation fail.
+* On-save only happens if the application validations succeeded. This means you
+  will not see the error on the failing field (in `ActiveRecord::Base#errors`).
+  That said, it will also only show one error, so if two database validations
+  failed only one field will show an error.
+* Pre-save does an extra query for `::validates_database_unique` and
+  `::validates_database_foreign_key`, so if time is of the essence let the
+  on-save validation catch the error, otherwise it's best to add
+  the full `::validates_database` to your model.
+
+## Notes
+
+* You do not have any control over on-save validations, the logic is applied if
+  you want it or not on every ActiveRecord::Base. If you can think of a reason
+  why it shouldn't, please file an
+  [issue](https://github.com/odedniv/activerecord-database_validations/issues).
+* When the unique index is on multiple columns mysql and postgresql (and maybe
+  others) do not fail if any of the columns is nil. With this in mind, the
+  error is added on the last column of the index.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+1. Fork it (https://github.com/odedniv/activerecord-database_validations/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
+
+### Extend database support
+
+This consists of 3 simple steps:
+
+1. Add an adapter gem as a development dependency in
+   `activerecord-database_validations.gemspec`.
+2. Add adapter configuration to `spec/db/adapters.rb`.
+3. Add new patterns for error matching in
+   `lib/activerecord/database_validations/rescues.rb`.
+
+Of course make sure `rspec` doesn't fail, and create a new Pull Request!

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+namespace :db do
+  desc "Prepare databases for testing"
+  task :prepare do
+    require "active_record"
+    require File.expand_path("../spec/db/adapters.rb", __FILE__)
+    DATABASE_ADAPTERS.each do |database_adapter_config|
+      ActiveRecord::Base.establish_connection(database_adapter_config)
+      load File.expand_path("../spec/db/schema.rb", __FILE__)
+    end
+  end
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/activerecord-database_validations.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/database_validations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-database_validations"
+  spec.version       = ActiveRecord::DatabaseValidations::VERSION
+  spec.authors       = ["Oded Niv"]
+  spec.email         = ["oded.niv@gmail.com"]
+
+  spec.summary       = %q{Handle database validations}
+  spec.description   = %q{Use database validations and convert ActiveRecord::StatementInvalid into ActiveRecord::RecordInvalid}
+  spec.homepage      = "https://github.com/odedniv/activerecord-database_validations"
+  spec.license       = "UNLICENSE"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", "~> 4.2", ">= 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug", "~> 3.5"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "simplecov", "~> 0.9"
+  spec.add_development_dependency "database_cleaner", "~> 1.4"
+
+  spec.add_development_dependency "mysql2", "~> 0.3"
+  spec.add_development_dependency "pg", "~> 0.18"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/database_validations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+rake db:prepare

data/lib/activerecord/database_validations.rb

@@ -0,0 +1,9 @@
+require "active_record"
+require "activerecord/database_validations/version"
+
+module ActiveRecord::DatabaseValidations
+end
+
+require "activerecord/database_validations/memoization"
+require "activerecord/database_validations/rescues"
+require "activerecord/database_validations/validations"

data/lib/activerecord/database_validations/memoization.rb

@@ -0,0 +1,11 @@
+module ActiveRecord::DatabaseValidations::Memoization
+  def indexes
+    @indexes ||= connection.indexes(table_name)
+  end
+
+  def foreign_keys
+    @foreign_keys ||= connection.foreign_keys(table_name)
+  end
+end
+
+ActiveRecord::Base.extend ActiveRecord::DatabaseValidations::Memoization

data/lib/activerecord/database_validations/rescues.rb

@@ -0,0 +1,88 @@
+module ActiveRecord::DatabaseValidations::Rescues
+  def self.included(base)
+    base.around_save :rescue_database_not_null
+    base.around_save :rescue_database_unique
+    base.around_save :rescue_database_foreign_key
+  end
+
+  NOT_NULL_PATTERNS = [
+    /^Mysql2::Error: Column '(.+?)' cannot be null:/,
+    /^Mysql2::Error: Field '(.+?)' doesn't have a default value:/,
+    /^PG::NotNullViolation: ERROR:  null value in column "(.+?)" violates not-null constraint\nDETAIL:/,
+  ]
+  def rescue_database_not_null
+    begin
+      yield
+    rescue ActiveRecord::StatementInvalid => e
+      if NOT_NULL_PATTERNS.any? { |p| e.message =~ p }
+        column_name = $1
+        errors.add(column_name, :blank)
+        raise ActiveRecord::RecordInvalid.new(self)
+      else
+        raise
+      end
+    end
+  end
+
+  UNIQUE_PATTERNS_BY_COLUMN = [
+    /^PG::UniqueViolation: ERROR:  duplicate key value violates unique constraint ".+?"\nDETAIL:  Key \((?:.+?, )*(.+?)\)=\(.+?\) already exists\./,
+  ]
+  UNIQUE_PATTERNS_BY_INDEX = [
+    /^Mysql2::Error: Duplicate entry '.+?' for key '(.+?)':/,
+  ]
+  PRIMARY_INDEXES = [
+    'PRIMARY',
+  ]
+  def rescue_database_unique
+    self.class.indexes if UNIQUE_PATTERNS_BY_INDEX.any? # load the indexes not inside a failed transaction (eg. PG::InFailedSqlTransaction)
+    begin
+      yield
+    rescue ActiveRecord::RecordNotUnique => e
+      column_name = if UNIQUE_PATTERNS_BY_COLUMN.any? { |p| e.message =~ p }
+                      $1
+                    elsif UNIQUE_PATTERNS_BY_INDEX.any? { |p| e.message =~ p }
+                      if PRIMARY_INDEXES.include?($1)
+                        self.class.primary_key
+                      else
+                        index = self.class.indexes.find { |i| i.name == $1 }
+                        raise if index.nil?
+                        index.columns[-1]
+                      end
+                    else
+                      raise
+                    end
+      errors.add(column_name, :taken)
+      raise ActiveRecord::RecordInvalid.new(self)
+    end
+  end
+
+
+  FOREIGN_KEY_PATTERNS_BY_COLUMN = [
+    /^Mysql2::Error: Cannot add or update a child row: a foreign key constraint fails \(`.+?`\.`.+?`, CONSTRAINT `.+?` FOREIGN KEY \(`(.+?)`\) REFERENCES `.+?` \(`.+?`\)\):/,
+    /^PG::ForeignKeyViolation: ERROR:  insert or update on table ".+?" violates foreign key constraint ".+?"\nDETAIL:  Key \((.+?)\)=\(.+?\) is not present in table ".+?"\.\n:/,
+  ]
+  FOREIGN_KEY_PATTERNS_BY_FOREIGN_KEY = [
+  ]
+  def rescue_database_foreign_key
+    self.class.foreign_keys if FOREIGN_KEY_PATTERNS_BY_FOREIGN_KEY.any? # load he foreign keys not inside a failing transaction (eg. PG::InFailedSqlTransaction)
+    begin
+      yield
+    rescue ActiveRecord::InvalidForeignKey => e
+      column_name = if FOREIGN_KEY_PATTERNS_BY_COLUMN.any? { |p| e.message =~ p }
+                      $1
+                    elsif FOREIGN_KEY_PATTERNS_BY_FOREIGN_KEY.any? { |p| e.message =~ p }
+                      foreign_key = self.class.foreign_keys.find { |i| i.name == $1 }
+                      raise if foreign_key.nil?
+                      foreign_key.column
+                    else
+                      raise
+                    end
+      errors.add(column_name, :inclusion)
+      raise ActiveRecord::RecordInvalid.new(self)
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include ActiveRecord::DatabaseValidations::Rescues
+end

data/lib/activerecord/database_validations/validations.rb

@@ -0,0 +1,45 @@
+module ActiveRecord::DatabaseValidations::Validations
+  def validates_database
+    validates_database_not_null
+    validates_database_unique
+    validates_database_foreign_key
+  end
+
+  def validates_database_not_null(options = {})
+    columns.reject(&:null).each do |column|
+      validation = proc do
+        if self[column.name].nil?
+          errors.add(column.name, options[:message] || :blank)
+        end
+      end
+
+      if column.extra == 'auto_increment'
+        validate(on: :update, &validation)
+      else
+        validate(&validation)
+      end
+    end
+  end
+
+  def validates_database_unique(options = {})
+    validates_uniqueness_of(primary_key, **options, allow_nil: true) if primary_key
+    indexes.select(&:unique).each do |index|
+      validates_uniqueness_of(index.columns[-1], **options, scope: index.columns[0...-1], if: -> { index.columns.none? { |c| self[c].nil? } })
+    end
+  end
+
+  def validates_database_foreign_key(options = {})
+    foreign_keys.each do |foreign_key|
+      model = Class.new(ActiveRecord::Base) do
+        self.table_name = foreign_key.to_table
+      end
+      validate do
+        if not self[foreign_key.column].nil? and not model.where(foreign_key.primary_key => self[foreign_key.column]).exists?
+          errors.add(foreign_key.column, options[:message] || :inclusion)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend ActiveRecord::DatabaseValidations::Validations

data/lib/activerecord/database_validations/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module DatabaseValidations
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-database_validations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Oded Niv
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Use database validations and convert ActiveRecord::StatementInvalid into
+  ActiveRecord::RecordInvalid
+email:
+- oded.niv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- activerecord-database_validations.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/database_validations.rb
+- lib/activerecord/database_validations/memoization.rb
+- lib/activerecord/database_validations/rescues.rb
+- lib/activerecord/database_validations/validations.rb
+- lib/activerecord/database_validations/version.rb
+homepage: https://github.com/odedniv/activerecord-database_validations
+licenses:
+- UNLICENSE
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Handle database validations
+test_files: []