atomic_first_or_create 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2264c3cddeb6d09f64944764365d93d5e024dbb61feeccdce0a9e39585b9b6d
+  data.tar.gz: 1d35576d14960be88b037f292e9fab1f64bdf2f44a0537bd7c08bba3e57c0fac
+SHA512:
+  metadata.gz: 686ee67eb5226075f8fb28d051500d4ae7a99f2dcd85e76cd048eafcc877ec96af9eb31d57b0c21c8d53a9348a24b2d79659fb8d3579b86d89b2832473977293
+  data.tar.gz: dcbbd1f3422fb90baf6c59266231dc2970890172175d64bdd4380d59a492c500f15d723f029999306d5d610da34fa1d8c1bb3ed4051e5a8b9fd184f52579dd1c

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Guilherme Pereira
+
+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,59 @@
+# AtomicFirstOrCreate
+
+ActiveRecord `first_or_create` alternative that retries on RecordNotUnique exception.
+
+`first_or_create` does not guarantee uniqueness by itself, and if there is a
+uniqueness constraint on the database, it may fail with a RecordNotUnique
+exception.  This gem adds `atomic_first_or_create` to ActiveRecord::Relation,
+which, in conjunction with a uniqueness constraint, provides the correct
+behaviour.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'atomic_first_or_create'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install atomic_first_or_create
+
+## Solution
+
+As documented by the rails team, methods like `first_or_create` or
+`find_or_create` are not atomic:
+
+"Please note *this method is not atomic*, it runs first a SELECT, and if there
+are no results an INSERT is attempted. If there are other threads or processes
+there is a race condition between both calls and it could be the case that you
+end up with two similar records."
+
+The documentation suggests using a UNIQUE constraint on the rows which you wish
+to enforce uniqueness, and retrying when the query raises the exception
+`ActiveRecord::RecordNotUnique`. This gem provides a method
+`atomic_first_or_create` which does exactly that.
+
+## Usage
+
+Finds the first record with the given attributes, or creates a record with the attributes if one is not found:
+
+```ruby
+# Find the first user with uid "abc123" or create a new one.
+User.where(uid: 'abc123').atomic_first_or_create(name: 'John', uid: 'abc123')
+# => #<User id: 1, uid: "abc123", name: 'John'>
+```
+```ruby
+# Find the first user with uid "abc123" or create a new one.
+# We already have one so the existing record will be returned.
+User.where(uid: 'abc123').atomic_first_or_create(name: 'John', uid: 'abc123')
+# => #<User id: 1, uid: "abc123", name: 'John'>
+```
+```ruby
+# Find the first user with uid "abc1234" or create a new one
+User.where(uid: 'abc123').atomic_first_or_create(name: 'Johansson', uid: 'abc1234')
+# => #<User id: 2, uid: "abc1234", name: 'Johansson'>
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
+end

data/atomic_first_or_create.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'atomic_first_or_create/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "atomic_first_or_create"
+  spec.version       = AtomicFirstOrCreate::VERSION
+  spec.authors       = ["EdgePetrol"]
+  spec.email         = ["devops@edgepetrol.com"]
+  spec.summary       = %q{ActiveRecord first_or_create that retries on RecordNotUnique exception}
+  spec.description   = %q{first_or_create does not guarantee uniqueness by itself, and if there is a uniqueness constraint on the database, it may fail with a RecordNotUnique exception. This gem adds atomic_first_or_create, which, in conjunction with a uniqueness constraint, provides the correct behaviour.}
+  spec.homepage      = "https://edgepetrol.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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'
+
+  spec.add_development_dependency "rake", '~> 13'
+  spec.add_development_dependency "minitest", '~> 5'
+  spec.add_development_dependency "sqlite3", '~> 1'
+end

data/lib/atomic_first_or_create.rb

@@ -0,0 +1,21 @@
+require "atomic_first_or_create/version"
+
+module ActiveRecord
+  class Relation
+    def atomic_first_or_create(**opts)
+      # We do not want to retry forever to avoid getting stuck
+
+      tries = 2
+      begin
+        first_or_create **opts
+      rescue ActiveRecord::RecordNotUnique
+        tries -= 1
+        if tries.zero?
+          raise
+        end
+
+        retry
+      end
+    end
+  end
+end

data/lib/atomic_first_or_create/version.rb

@@ -0,0 +1,3 @@
+module AtomicFirstOrCreate
+  VERSION = "1.0"
+end

data/test/test_atomic.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'atomic_first_or_create'
+
+class AtomicTest < MiniTest::Test
+  def teardown
+    Person.delete_all
+  end
+
+  def test_creation
+    p = Person.where(first_name: 'Andy', last_name: 'Matt').atomic_first_or_create
+
+    assert_equal ['Andy', 'Matt'], [p.first_name, p.last_name]
+  end
+
+  def test_return_existing
+    p1 = Person.where(first_name: 'Andy', last_name: 'Matt').atomic_first_or_create
+    p2 = Person.where(first_name: 'Andy', last_name: 'Matt').atomic_first_or_create
+
+    assert_equal p1, p2
+  end
+
+  def test_creation_with_extra_args
+    p = Person.where(first_name: 'Andy', last_name: 'Matt').atomic_first_or_create age: 28
+
+    assert_equal 28, p.age
+  end
+
+  def test_return_with_extra_args
+    Person.where(first_name: 'Andy', last_name: 'Matt').atomic_first_or_create age: 28
+
+    p2 = Person.where(first_name: 'Andy', last_name: 'Matt').atomic_first_or_create age: 52
+
+    assert_equal 28, p2.age
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'minitest/autorun'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :people do |t|
+    t.string :first_name
+    t.string :last_name
+    t.integer :age
+  end
+
+  add_index :people, [:first_name, :last_name], unique: true
+end
+
+class Person < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: atomic_first_or_create
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- EdgePetrol
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: first_or_create does not guarantee uniqueness by itself, and if there
+  is a uniqueness constraint on the database, it may fail with a RecordNotUnique exception.
+  This gem adds atomic_first_or_create, which, in conjunction with a uniqueness constraint,
+  provides the correct behaviour.
+email:
+- devops@edgepetrol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- atomic_first_or_create.gemspec
+- lib/atomic_first_or_create.rb
+- lib/atomic_first_or_create/version.rb
+- test/test_atomic.rb
+- test/test_helper.rb
+homepage: https://edgepetrol.com
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: ActiveRecord first_or_create that retries on RecordNotUnique exception
+test_files:
+- test/test_atomic.rb
+- test/test_helper.rb