thread_safe_uniqueness_record 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b85529102224768963da56f2ea724300bbc8147f02a49416ce2bb5aa1c45712
+  data.tar.gz: c78dc2a0c96b48ddc2afb9b2be7d425a3cfc66b947d6e0884b9a89c8919597ae
+SHA512:
+  metadata.gz: 3a55e10f508fc10ecc21a4408f5255e8544dd82f1c1898afd37f38536f78f1f26671d653ee734014ab051c0d065e02e3e9581001a798c5d986c11ce490e501a4
+  data.tar.gz: 73ca619fad954a77fd2872deb3f6901407e7696345def0e49550bc32f84e73bc8df4c335aa469c4407642c30a4cb7c108b20550e4de5ba507607cee55a6e25da

data/.circleci/config.yml

@@ -0,0 +1,23 @@
+version: 2.1
+
+# Define the jobs we want to run for this project
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.5
+    steps:
+      - checkout
+  test:
+    docker:
+      - image: circleci/ruby:2.6.5
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec
+
+# Orchestrate our job run sequence
+workflows:
+  build_and_test:
+    jobs:
+      - build
+      - test

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+Gemfile.*
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Documentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  Max: 120
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alexei.mifrill.strizhak@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aleksey Strizhak
+
+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,61 @@
+[![CircleCI](https://circleci.com/gh/Mifrill/thread_safe_uniqueness_record.svg?style=svg)](https://app.circleci.com/pipelines/github/Mifrill/thread_safe_uniqueness_record)
+
+# ThreadSafeUniquenessRecord
+
+Usage is raised by thread race when the first thread tries to create
+the record at the same time the second thread is trying to create exactly
+the same record because both threads are seen no such record in DB
+on find_by action by the passed attributes.
+
+[Rails implementation of `create_or_find_by`](https://github.com/rails/rails/blob/24c1429a9e553196eb72312ec831afb6268222b1/activerecord/lib/active_record/relation.rb#L179-L222)
+
+In thread race when both of threads proceed after the passed
+uniqueness validation in model without raise of RecordInvalid error
+and one of the thread has committed the change in DB then the second thread
+fires the RecordNotUnique error with retry on the rescue.
+
+The attempts limiter is required to prevent the infinite loop when tries
+to create the record which can't be found by the passed attributes but
+becomes a duplicate by any other attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thread_safe_uniqueness_record'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install thread_safe_uniqueness_record
+
+## Usage
+
+    model_klass: ActiveRecordModel
+    attributes: Hash of model instance attributes
+
+    ThreadSafeUniquenessRecord::FindOrCreateBy.call(model_klass: model_klass, attributes: attributes)
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Mifrill/thread_safe_uniqueness_record. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Mifrill/thread_safe_uniqueness_record/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ThreadSafeUniquenessRecord project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Mifrill/thread_safe_uniqueness_record/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'thread_safe_uniqueness_record'
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/thread_safe_uniqueness_record

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'thread_safe_uniqueness_record'

data/lib/thread_safe_uniqueness_record.rb

@@ -0,0 +1,31 @@
+require 'thread_safe_uniqueness_record/version'
+require 'thread_safe_uniqueness_record/find_or_create_by'
+require 'active_record'
+require 'concurrent'
+
+module ThreadSafeUniquenessRecord
+  class Error < StandardError; end
+
+  class UniquenessValidationError
+    def self.===(exception)
+      exception.is_a?(ActiveRecord::RecordInvalid) &&
+        /Validation failed:.+\btaken\b/.match?(exception.message)
+    end
+  end
+
+  MAX_TRIES = 3
+  ERRORS = [
+    UniquenessValidationError,
+    ActiveRecord::RecordNotUnique
+  ].freeze
+
+  def self.with_retry
+    attempts ||= Concurrent::ThreadLocalVar.new(0)
+    yield
+  rescue *ERRORS => e
+    attempts.value += 1
+    raise e if attempts.value >= MAX_TRIES
+
+    retry
+  end
+end

data/lib/thread_safe_uniqueness_record/find_or_create_by.rb

@@ -0,0 +1,11 @@
+module ThreadSafeUniquenessRecord
+  class FindOrCreateBy
+    def self.call(model_klass:, attributes:)
+      ThreadSafeUniquenessRecord.with_retry do
+        ActiveRecord::Base.transaction(requires_new: true) do
+          model_klass.find_or_create_by!(attributes)
+        end
+      end
+    end
+  end
+end

data/lib/thread_safe_uniqueness_record/version.rb

@@ -0,0 +1,3 @@
+module ThreadSafeUniquenessRecord
+  VERSION = '0.1.0'
+end

data/thread_safe_uniqueness_record.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/thread_safe_uniqueness_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'thread_safe_uniqueness_record'
+  spec.version       = ThreadSafeUniquenessRecord::VERSION
+  spec.authors       = ['Aleksey Strizhak']
+  spec.email         = ['alexei.mifrill.strizhak@gmail.com']
+
+  spec.summary       = 'Thread safe creation of unique ActiveRecord'
+  spec.description   = 'The preventer of thread race conditions for ActiveRecord unique model creations'
+  spec.homepage      = 'https://github.com/Mifrill/thread_safe_uniqueness_record.git'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/Mifrill/thread_safe_uniqueness_record/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord'
+  spec.add_runtime_dependency 'concurrent-ruby'
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: thread_safe_uniqueness_record
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksey Strizhak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: The preventer of thread race conditions for ActiveRecord unique model
+  creations
+email:
+- alexei.mifrill.strizhak@gmail.com
+executables:
+- thread_safe_uniqueness_record
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/thread_safe_uniqueness_record
+- lib/thread_safe_uniqueness_record.rb
+- lib/thread_safe_uniqueness_record/find_or_create_by.rb
+- lib/thread_safe_uniqueness_record/version.rb
+- thread_safe_uniqueness_record.gemspec
+homepage: https://github.com/Mifrill/thread_safe_uniqueness_record.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Mifrill/thread_safe_uniqueness_record.git
+  changelog_uri: https://github.com/Mifrill/thread_safe_uniqueness_record/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Thread safe creation of unique ActiveRecord
+test_files: []