rescue_unique_constraint 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0e3cb076ff7875dceb8444be36ef82080bcd05c
-  data.tar.gz: 353306cab3df3aa689c7c74f4208c30d28c05c91
+  metadata.gz: 27efaf5971c6a6112e6bd8a425dce94b75c460be
+  data.tar.gz: 9ad629f199f45389fcc44e86ba4dd7a563d5393a
 SHA512:
-  metadata.gz: 230a6f59b281782ace42043b97ccee346739b4db72bc42091a24017636491af825bbc1f2cc9aac05a2928193b69ae8dbe674c25598b9a84037ede76e4f1b206d
-  data.tar.gz: e6326eb248afb2684f3a58f9246c56152a58478a497fda051fc491a948afde9fa4b46d38ae149610cd733636b3e0de39c7e59b26403bc5e5f7a6f5ae23c245d0
+  metadata.gz: c3889a2162aa6549ede31230f0d2d6fbda77a81ed59b59fcd1b220c0ecf17b682bdb850ac1a521fde94e17bc8b5e57f4fe0f16b437766983abe0b6497d52959e
+  data.tar.gz: 4bacd362cc9b17643ca4d181753b4cb666759b69e54dc9b82a6bb2110e10efa5bf7a593065071509e8902c2cedd43013f8be49cd9182e500dbcbd88fdc58b1b2

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.tags
 .bundle
 .config
 .yardoc

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.1

data/README.md

@@ -1,13 +1,13 @@
 # RescueUniqueConstraint
 
-Rails doesn't do a great job of rescuing ActiveRecord::RecordNotUnique
-violations resulting from a duplicate entry on a unique constraint.
+ActiveRecord doesn't do a great job of rescuing ActiveRecord::RecordNotUnique
+violations resulting from a duplicate entry on a database level 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
+Note that if you have only a unique constraint in the database and no uniqueness validation in ActiveRecord, it
 is possible for your object to validate but then fail to save.
 
 See Usage for more info.
@@ -55,6 +55,7 @@ enter your database.
 After:
 
     class Thing < ActiveRecord::Base
+      include RescueUniqueConstraint
       rescue_unique_constraint index: "my_unique_index", field: "somefield"
     end
 

data/lib/rescue_unique_constraint/adapter/postgresql_adapter.rb

@@ -0,0 +1,9 @@
+module RescueUniqueConstraint
+  module Adapter
+    class PostgresqlAdapter
+      def index_error?(index, error_message)
+        error_message[/#{index.name}/]
+      end
+    end
+  end
+end

data/lib/rescue_unique_constraint/adapter/sqlite_adapter.rb

@@ -0,0 +1,9 @@
+module RescueUniqueConstraint
+  module Adapter
+    class SqliteAdapter
+      def index_error?(index, error_message)
+        error_message[/UNIQUE.*#{index.field}/]
+      end
+    end
+  end
+end

data/lib/rescue_unique_constraint/index.rb

@@ -0,0 +1,9 @@
+module RescueUniqueConstraint
+  class Index
+    attr_reader :name, :field
+    def initialize(name, field)
+      @name = name
+      @field = field
+    end
+  end
+end

data/lib/rescue_unique_constraint/rescue_handler.rb

@@ -0,0 +1,42 @@
+module RescueUniqueConstraint
+  # Handles storing and matching [index, field] pairs to exceptions
+  class RescueHandler
+    def initialize(model)
+      @model = model
+      @indexes_to_rescue_on = []
+    end
+
+    def add_index(index, field)
+      indexes_to_rescue_on << Index.new(index, field)
+    end
+
+    def matching_indexes(e)
+      indexes = indexes_to_rescue_on.select do |index|
+        database_adapter.index_error?(index, e.message)
+      end
+      raise e unless indexes.any?
+      indexes
+    end
+
+    private
+
+    attr_reader :indexes_to_rescue_on, :model
+
+    def database_adapter
+      @_database_adapter ||= (
+        case database_name
+        when :postgresql
+          Adapter::PostgresqlAdapter.new
+        when :sqlite
+          Adapter::SqliteAdapter.new
+        else
+          raise "Database (#{database_name}) not supported"
+        end
+      )
+    end
+
+    def database_name
+      model.connection.adapter_name.downcase.to_sym
+    end
+  end
+end

data/lib/rescue_unique_constraint/version.rb

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

data/lib/rescue_unique_constraint.rb

@@ -1,34 +1,42 @@
-require "rescue_unique_constraint/version"
+require 'rescue_unique_constraint/version'
+require 'rescue_unique_constraint/index'
+require 'rescue_unique_constraint/rescue_handler'
+require 'rescue_unique_constraint/adapter/postgresql_adapter'
+require 'rescue_unique_constraint/adapter/sqlite_adapter'
 require 'active_record'
 
+# Module which will rescue ActiveRecord::RecordNotUnique exceptions
+# and add errors for indexes that are registered with
+# rescue_unique_constraint(index:, field:)
 module RescueUniqueConstraint
   def self.included(base)
     base.extend(ClassMethods)
   end
 
+  # methods mixed into ActiveRecord class
   module ClassMethods
+    def index_rescue_handler
+      @_index_rescue_handler ||= RescueUniqueConstraint::RescueHandler.new(self)
+    end
+
     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
+      unless method_defined?(:create_or_update_with_rescue)
+        define_method(:create_or_update_with_rescue) do
+          begin
+            create_or_update_without_rescue
+          rescue ActiveRecord::RecordNotUnique => e
+            self.class.index_rescue_handler.matching_indexes(e).each do |matching_index|
+              errors.add(matching_index.field, :taken)
+            end
+            return false
           end
-          false
+          true
         end
-      end
 
-      alias_method :create_or_update_without_rescue, :create_or_update
-      alias_method :create_or_update, :create_or_update_with_rescue
+        alias_method :create_or_update_without_rescue, :create_or_update
+        alias_method :create_or_update, :create_or_update_with_rescue
+      end
+      index_rescue_handler.add_index(index, field)
     end
   end
 end
-
-ActiveRecord::Base.include(RescueUniqueConstraint)

data/rescue_unique_constraint.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.5"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
 end

data/spec/rescue_unique_constraint_spec.rb

@@ -8,20 +8,25 @@ describe RescueUniqueConstraint do
     ActiveRecord::Schema.define(:version => 1) do
       create_table :things do |t|
         t.string :name
+        t.string :test
       end
 
       add_index :things, :name, unique: true, name: "idx_things_on_name_unique"
+      add_index :things, :test, unique: true, name: "idx_things_on_test_unique"
     end
   end
 
   class Thing < ActiveRecord::Base
+    include RescueUniqueConstraint
     rescue_unique_constraint index: "idx_things_on_name_unique", field: "name"
+    rescue_unique_constraint index: "idx_things_on_test_unique", field: "test"
   end
 
   it "rescues unique constraint violations as activerecord errors" do
-    thing = Thing.create(name: "foo")
-    dupe = Thing.new(name: "foo")
+    thing = Thing.create(name: "foo", test: 'bar')
+    dupe = Thing.new(name: "foo", test: 'bar')
     expect(dupe.save).to eql false
     expect(dupe.errors[:name].first).to match /taken/
+    expect(dupe.errors[:test].first).to match /taken/
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rescue_unique_constraint
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tam Dang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,6 +81,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: Rescues unique constraint violations and turns them into ActiveRecord
   errors
 email:
@@ -91,11 +119,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rescue_unique_constraint.rb
+- lib/rescue_unique_constraint/adapter/postgresql_adapter.rb
+- lib/rescue_unique_constraint/adapter/sqlite_adapter.rb
+- lib/rescue_unique_constraint/index.rb
+- lib/rescue_unique_constraint/rescue_handler.rb
 - lib/rescue_unique_constraint/version.rb
 - rescue_unique_constraint.gemspec
 - spec/rescue_unique_constraint_spec.rb
@@ -119,9 +152,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Turns ActiveRecord::RecordNotUnique errors into ActiveRecord errors
 test_files:
 - spec/rescue_unique_constraint_spec.rb
+has_rdoc: