rescue_unique_constraint 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0e3cb076ff7875dceb8444be36ef82080bcd05c
+  data.tar.gz: 353306cab3df3aa689c7c74f4208c30d28c05c91
+SHA512:
+  metadata.gz: 230a6f59b281782ace42043b97ccee346739b4db72bc42091a24017636491af825bbc1f2cc9aac05a2928193b69ae8dbe674c25598b9a84037ede76e4f1b206d
+  data.tar.gz: e6326eb248afb2684f3a58f9246c56152a58478a497fda051fc491a948afde9fa4b46d38ae149610cd733636b3e0de39c7e59b26403bc5e5f7a6f5ae23c245d0

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 rescue_unique_constraint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2015 Reverb.com, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,78 @@
+# RescueUniqueConstraint
+
+Rails doesn't do a great job of rescuing ActiveRecord::RecordNotUnique
+violations resulting from a duplicate entry on a unique constraint.
+
+This gem automatically rescues the error and instead adds a validation error
+on the field in question, making it behave as if you had a normal uniqueness
+validation.
+
+Note that if you have only a unique constraint and no uniquness validation, it
+is possible for your object to validate but then fail to save.
+
+See Usage for more info.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rescue_unique_constraint'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rescue_unique_constraint
+
+## Usage
+
+Assuming you've added unique index:
+
+    class AddIndexToThing < ActiveRecord::Migration
+      disable_ddl_transaction!
+
+      def change
+        add_index :things, :somefield, unique: true, algorithm: :concurrently, name: "my_unique_index"
+      end
+    end
+
+Before:
+
+    class Thing < ActiveRecord::Base
+    end
+
+    thing = Thing.create(somefield: "foo")
+    dupe = Thing.create(somefield: "foo")
+    => raises ActiveRecord::RecordNotUnique
+
+Note that if you have `validates :uniqueness` in your model, it will prevent
+the RecordNotUnique from being raised in _some_ cases, but not all, as race
+conditions between multiple processes will still cause duplicate entries to
+enter your database.
+
+After:
+
+    class Thing < ActiveRecord::Base
+      rescue_unique_constraint index: "my_unique_index", field: "somefield"
+    end
+
+    thing = Thing.create(somefield: "foo")
+    dupe = Thing.create(somefield: "foo")
+    => false
+    thing.errors[:somefield] == "somefield has already been taken"
+    => true
+
+## Testing
+
+You'll need a database that supports unique constraints.
+This gem has been tested with PostgreSQL and SQLite only.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rescue_unique_constraint/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/lib/rescue_unique_constraint.rb

@@ -0,0 +1,34 @@
+require "rescue_unique_constraint/version"
+require 'active_record'
+
+module RescueUniqueConstraint
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def rescue_unique_constraint(index:, field:)
+      define_method(:create_or_update_with_rescue) do
+        begin
+          create_or_update_without_rescue
+        rescue ActiveRecord::RecordNotUnique => e
+          case e.message
+          when /#{index}/  # Postgres
+            errors.add(field, :taken)
+          when /UNIQUE.*#{field}/ # SQLite
+            errors.add(field, :taken)
+          else
+            # This should not happen; we want to know if we forgot to handle some unique constraint
+            raise e
+          end
+          false
+        end
+      end
+
+      alias_method :create_or_update_without_rescue, :create_or_update
+      alias_method :create_or_update, :create_or_update_with_rescue
+    end
+  end
+end
+
+ActiveRecord::Base.include(RescueUniqueConstraint)

data/lib/rescue_unique_constraint/version.rb

@@ -0,0 +1,3 @@
+module RescueUniqueConstraint
+  VERSION = "1.0.0"
+end

data/rescue_unique_constraint.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rescue_unique_constraint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rescue_unique_constraint"
+  spec.version       = RescueUniqueConstraint::VERSION
+  spec.authors       = ["Tam Dang", "Yan Pritzker"]
+  spec.email         = ["tam.dang@reverb.com","yan@reverb.com"]
+  spec.summary       = %q{Turns ActiveRecord::RecordNotUnique errors into ActiveRecord errors}
+  spec.description   = %q{Rescues unique constraint violations and turns them into ActiveRecord errors}
+  spec.homepage      = "https://github.com/reverbdotcom/rescue_unique_contraint"
+  spec.license       = "Apache 2.0"
+
+  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_dependency "activerecord", "~> 4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+end

data/spec/rescue_unique_constraint_spec.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+require 'rescue_unique_constraint'
+
+describe RescueUniqueConstraint do
+  before do
+    ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+    ActiveRecord::Schema.verbose = false
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :things do |t|
+        t.string :name
+      end
+
+      add_index :things, :name, unique: true, name: "idx_things_on_name_unique"
+    end
+  end
+
+  class Thing < ActiveRecord::Base
+    rescue_unique_constraint index: "idx_things_on_name_unique", field: "name"
+  end
+
+  it "rescues unique constraint violations as activerecord errors" do
+    thing = Thing.create(name: "foo")
+    dupe = Thing.new(name: "foo")
+    expect(dupe.save).to eql false
+    expect(dupe.errors[:name].first).to match /taken/
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rescue_unique_constraint
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tam Dang
+- Yan Pritzker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Rescues unique constraint violations and turns them into ActiveRecord
+  errors
+email:
+- tam.dang@reverb.com
+- yan@reverb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rescue_unique_constraint.rb
+- lib/rescue_unique_constraint/version.rb
+- rescue_unique_constraint.gemspec
+- spec/rescue_unique_constraint_spec.rb
+homepage: https://github.com/reverbdotcom/rescue_unique_contraint
+licenses:
+- Apache 2.0
+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.8
+signing_key: 
+specification_version: 4
+summary: Turns ActiveRecord::RecordNotUnique errors into ActiveRecord errors
+test_files:
+- spec/rescue_unique_constraint_spec.rb