active_record_uniqueness_via_db 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9da850897aaec17bdb54551fd48fd915b1377562
+  data.tar.gz: df6e2d237f05b00e0d97071b209221fc85206678
+SHA512:
+  metadata.gz: 4919adcbac7b4c0324a9b8223e3b3d7dd26d745d37915081882c7c3c77b9425c11bcee4c2e335af05459cc80ef176e68aed249da9f5d4b3ff24a70789e71c933
+  data.tar.gz: a50b43336b20b762bcdb2df7b6aede4d2b1b8699f4336e0d100f89b1d359eab6c2d95daaf8037916c536d2976a4a3f1146c55a8fc6a09d597a8367cc5c86ab62

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James Mac William
+
+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,67 @@
+[![Build
+Status](https://travis-ci.org/jamesmacwilliam/active_record_uniqueness_via_db.svg?branch=master)](https://travis-ci.org/jamesmacwilliam/active_record_uniqueness_via_db)
+
+[![Code
+Climate](https://codeclimate.com/github/jamesmacwilliam/active_record_uniqueness_via_db/badges/gpa.svg)](https://codeclimate.com/github/jamesmacwilliam/active_record_uniqueness_via_db)
+
+# ActiveRecordUniquenessViaDb
+
+This simplifies validations by uniqueness using db constraints.  Rails
+uniqueness validations are not safe for concurrent processes, so we need
+to add a db constraint anyway to ensure values are unique in the
+database.  This allows us to just rely on the error that constraint
+raises rather than perform an extra select statement prior to
+insert/updates
+
+```
+validate :some_key, uniqueness: { via: :db }
+```
+
+the rails uniqueness validation already accepts options rather than a
+simple truthy value, this gem adds the `:via` key to those options
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_uniqueness_via_db'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_uniqueness_via_db
+
+run this command to set up the initializer:
+
+```ruby
+  rails generate active_record_uniqueness_via_db:install
+```
+
+## Usage
+
+```
+validate :some_key, uniqueness: { via: :db }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Note: to add databases, add a file under `lib/adapters/db_adapter_name.rb`
+that implements the `error_matches_att` method
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_record_uniqueness_via_db. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_record_uniqueness_via_db.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_uniqueness_via_db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_uniqueness_via_db"
+  spec.version       = ActiveRecordUniquenessViaDb::VERSION
+  spec.authors       = ["James Mac William"]
+  spec.email         = ["jimmy.macwilliam@gmail.com"]
+
+  spec.summary       = %q{Extend ActiveRecord uniqueness validations with via: :db option.}
+  spec.homepage      = "https://github.com/jamesmacwilliam/active_record_uniqueness_via_db"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler",  "~> 1.10"
+  spec.add_development_dependency "rake",     "~> 10.0"
+  spec.add_dependency             "railties", ">= 4.1.0", "< 5.1"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_uniqueness_via_db"
+
+# 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
+
+# Do any other automated setup that you need to do here

data/lib/active_record/validations/uniqueness_validator.rb

@@ -0,0 +1,30 @@
+module ActiveRecord
+  module Validations
+    class UniquenessValidator < ActiveModel::EachValidator
+
+      alias :old_validate_each :validate_each
+      alias :old_initialize    :initialize
+
+      def initialize(options)
+        if options[:via].present? && !(options[:via] == :db)
+          raise ArgumentError, "the :via option only accepts :db"
+        end
+        old_initialize(options)
+      end
+
+      def validate_each(record, attribute, value)
+        error_options =
+          options.
+          merge(:value => value).
+          except(:case_sensitive, :scope, :conditions)
+
+        ActiveRecordUniquenessViaDb::Builder.call(
+          record,
+          attribute,
+          !options[:via],
+          error_options,
+        ) { old_validate_each(record, attribute, value) }
+      end
+    end
+  end
+end

data/lib/active_record_uniqueness_via_db/adapter.rb

@@ -0,0 +1,8 @@
+require 'active_record_uniqueness_via_db/adapters/mysql2'
+require 'active_support/inflector'
+
+class ActiveRecordUniquenessViaDb::Adapter
+  def self.for(ar_adapter)
+    "ActiveRecordUniquenessViaDb::Adapters::#{ar_adapter.classify}".constantize.new
+  end
+end

data/lib/active_record_uniqueness_via_db/adapters/mysql2.rb

@@ -0,0 +1,5 @@
+class ActiveRecordUniquenessViaDb::Adapters::Mysql2
+  def error_matches_attr(attr, err_msg)
+    err_msg =~ /Mysql2[:]*Error.*Duplicate entry.*for key ['][a-z0-9_]*#{attr}[']/
+  end
+end

data/lib/active_record_uniqueness_via_db/adapters.rb

@@ -0,0 +1,3 @@
+module ActiveRecordUniquenessViaDb::Adapters
+
+end

data/lib/active_record_uniqueness_via_db/builder.rb

@@ -0,0 +1,37 @@
+class ActiveRecordUniquenessViaDb::Builder
+  attr_accessor :block, :record, :attr_name, :always_block, :attrs_to_rescue,
+    :error_options
+
+  def initialize(record, attr_name, always_block, error_options, &block)
+    @record          = record
+    @block           = block
+    @attr_name       = attr_name
+    @always_block    = always_block
+    @error_options   = error_options
+    @attrs_to_rescue = record.
+      instance_variable_get("@#{ActiveRecordUniquenessViaDb::ATTRS_IVAR}") || {}
+    @attrs_to_rescue.delete(attr_name)
+  end
+
+  def call
+    via_db? ? @attrs_to_rescue[attr_name] = error_options : block.call
+    specify_attributes_to_rescue_db_error
+  end
+
+  def self.call(record, attr_name, always_block, error_options, &block)
+    new(record, attr_name, always_block, error_options, &block).call
+  end
+
+  private
+
+  def specify_attributes_to_rescue_db_error
+    record.instance_variable_set(
+      "@#{ActiveRecordUniquenessViaDb::ATTRS_IVAR}",
+      attrs_to_rescue
+    )
+  end
+
+  def via_db?
+    record.changed? && !always_block
+  end
+end

data/lib/active_record_uniqueness_via_db/validator.rb

@@ -0,0 +1,31 @@
+class ActiveRecordUniquenessViaDb::Validator
+  attr_accessor :adapter, :record, :exception, :attrs_to_rescue
+
+  def initialize(adapter, record, exception)
+    @adapter         = adapter
+    @record          = record
+    @exception       = exception
+    @attrs_to_rescue = record.
+      instance_variable_get("@#{ActiveRecordUniquenessViaDb::ATTRS_IVAR}") || {}
+  end
+
+  def call
+    if attribute_with_error
+      record.errors.add(attribute_with_error.first, :taken, attribute_with_error.last)
+    else
+      raise exception
+    end
+  end
+
+  def self.validate(adapter, record, exception)
+    new(adapter,record, exception).call
+  end
+
+  private
+
+  def attribute_with_error
+    @attr_with_error ||=
+      attrs_to_rescue.
+      find { |attr, _| adapter.error_matches_attr(attr, exception.message) }
+  end
+end

data/lib/active_record_uniqueness_via_db/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordUniquenessViaDb
+  VERSION = "0.1.0"
+end

data/lib/active_record_uniqueness_via_db.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+require 'active_record_uniqueness_via_db/version'
+require 'active_record_uniqueness_via_db/builder'
+require 'active_record_uniqueness_via_db/validator'
+require 'active_record_uniqueness_via_db/adapters'
+require 'active_record_uniqueness_via_db/adapter'
+require 'active_record/validations/uniqueness_validator'
+
+module ActiveRecordUniquenessViaDb
+  ATTRS_IVAR = :attrs_to_rescue_uniqueness_db
+end

data/lib/generators/active_record_uniqueness_via_db/install_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/base'
+
+module ActiveRecordUniquenessViaDb
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates an ActiveRecordUniqunessViaDb initializer."
+
+      def copy_initializer
+        template "active_record_uniqueness_via_db.rb", "config/initializers/active_record_uniqueness_via_db.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/active_record_uniqueness_via_db.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  module Persistence
+    extend ActiveSupport::Concern
+
+    cattr_accessor ActiveRecordUniquenessViaDb::ATTRS_IVAR
+
+    alias :original_create_or_update :create_or_update
+    alias :original_save!            :save!
+
+    def create_or_update
+      original_create_or_update
+    rescue ActiveRecord::RecordNotUnique => e
+      uniqueness_via_db_validator(e)
+      @original_validation_error =
+        ActiveRecord::RecordNotUnique.new(self.errors.full_messages.first)
+      false
+    end
+
+    def save!(*)
+      original_save!
+    rescue ActiveRecord::RecordNotSaved => e
+      raise(@original_validation_error) if @original_validation_error
+      raise e
+    end
+
+    private
+
+    def uniqueness_via_db_validator(exception)
+      ActiveRecordUniquenessViaDb::Validator.validate(
+        ActiveRecordUniquenessViaDb::Adapter.for(self.class.connection_config[:adapter]),
+        self,
+        exception
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: active_record_uniqueness_via_db
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Mac William
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- jimmy.macwilliam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_uniqueness_via_db.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/validations/uniqueness_validator.rb
+- lib/active_record_uniqueness_via_db.rb
+- lib/active_record_uniqueness_via_db/adapter.rb
+- lib/active_record_uniqueness_via_db/adapters.rb
+- lib/active_record_uniqueness_via_db/adapters/mysql2.rb
+- lib/active_record_uniqueness_via_db/builder.rb
+- lib/active_record_uniqueness_via_db/validator.rb
+- lib/active_record_uniqueness_via_db/version.rb
+- lib/generators/active_record_uniqueness_via_db/install_generator.rb
+- lib/generators/templates/active_record_uniqueness_via_db.rb
+homepage: https://github.com/jamesmacwilliam/active_record_uniqueness_via_db
+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.4.5
+signing_key: 
+specification_version: 4
+summary: 'Extend ActiveRecord uniqueness validations with via: :db option.'
+test_files: []
+has_rdoc: