has_unique_attribute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20a15d8b6e775b27196202f55a3620d7657649d95d3b4e82f817fc6ca56724a1
+  data.tar.gz: 19a566b7c92567464f326e9495b981f95bc04b99978b9913412ddf4997770545
+SHA512:
+  metadata.gz: 48fc6ccdfd69432ecb1b7f4bd09071a697d21f5f07833e9e458f5da4b143e65ca79743b102f7c1af7127dcc9d4ede19c911aa7d2046817ce9022bf1c6d36b0f7
+  data.tar.gz: 17f07885a4303072c3e5517dded25e601d0ca6b9602339d99e56c5e68e87be6c5fb2cfb32acdcb221d549274434da1d4c1b55370e84acb93f968d1d39a3d2d89

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,152 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  DefaultFormatter: progress
+  DisplayCopNames: true
+  ExtraDetails: true
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'bin/*'
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
+
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+RSpec/ExpectChange:
+  EnforcedStyle: block
+
+RSpec/HookArgument:
+  EnforcedStyle: each
+
+RSpec/NestedGroups:
+  Max: 5
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  SafeAutoCorrect: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Safe: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+  Safe: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_unique_attribute.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    has_unique_attribute (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.0)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  has_unique_attribute!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,99 @@
+# Has Unique Attribute
+
+Applies validation errors to ActiveRecord model attributes when database uniqueness constraints fail.
+
+**NOTE:** At the moment, only PostgreSQL is supported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_unique_attribute'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_unique_attribute
+
+Then, make it available to your models:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  extend HasUniqueAttribute
+
+  # ...
+end
+```
+
+## Usage
+
+Use the `has_unique_attribute` helper to add a handler to your model:
+
+```ruby
+class User < ApplicationRecord
+  has_unique_attribute :email
+end
+```
+
+This will match errors on an index name `index_users_on_email` and add validation errors to the `email` attribute.
+
+### Specifying an Index Name
+
+To customize the name of the index matched, use the `index` option:
+
+```ruby
+class User < ApplicationRecord
+  has_unique_attribute :email, index: 'custom_index_name'
+end
+```
+
+### Customizing the Error Message
+
+To customize the error message applied, use the `message` option:
+
+```ruby
+class Project < ApplicationRecord
+  has_unique_attribute :name, message: 'already exists'
+end
+```
+
+It's also possible to specify an I18n key for a translation:
+
+```ruby
+class Project < ApplicationRecord
+  has_unique_attribute :name, message: :duplicate
+end
+```
+
+By default, the `:taken` error translation is applied to attributes.
+This mimics the behaviour of the `uniqueness` validator.
+
+### Handling Composite Indexes
+
+Composite (multi-column) indexes will need the index name to be specified explicitly:
+
+```ruby
+class Membership < Application
+  belongs_to :user
+  belongs_to :club
+
+  has_unique_index :user, index: 'index_memberships_on_club_id_and_user_id', message: 'is already a member'
+end
+```
+
+The error is only applied to the specified attribute.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` 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/Mihail-K/has_unique_attribute.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "has_unique_attribute"
+
+# 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/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

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/has_unique_attribute.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'has_unique_attribute/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'has_unique_attribute'
+  spec.version = HasUniqueAttribute::VERSION
+  spec.authors = ['Mihail-K']
+  spec.email   = []
+
+  spec.summary     = 'Handle unique attributes safely using the database.'
+  spec.description = 'Adds custom handling for database uniqueness constraints to ActiveRecord.'
+  spec.homepage    = 'https://github.com/Mihail-K/has_unique_attribute'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Mihail-K/has_unique_attribute'
+
+  # 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_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+end

data/lib/has_unique_attribute.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module HasUniqueAttribute
+  # @param attribute_name [String]
+  # @param index [String]
+  # @param message [Symbol, String]
+  # @return [void]
+  def has_unique_attribute(attribute_name, # rubocop:disable Naming/PredicateName
+                           index:   default_index_name_for_attribute(attribute_name),
+                           message: :taken)
+    assert_unique_index_defined!(index)
+
+    handle_unique_attribute_on_save(attribute_name, index, message)
+    handle_unique_attribute_on_save!(attribute_name, index, message)
+  end
+
+private
+
+  # @param index_name [String]
+  # @return [void]
+  def assert_unique_index_defined!(index_name)
+    index = connection.indexes(table_name).find { |index_definition| index_definition.name == index_name }
+
+    raise ArgumentError, "#{name} does not have index: `#{index_name}`" if index.nil?
+    raise ArgumentError, "#{name} defines an index `#{index_name}`, but it is not unique" unless index.unique
+  end
+
+  # @param attribute_name [String]
+  # @return [String]
+  def default_index_name_for_attribute(attribute_name)
+    "index_#{table_name}_on_#{attribute_name}"
+  end
+
+  # @param attribute_name [String]
+  # @param index_name [String]
+  # @param message [Symbol, String]
+  # @return [void]
+  def handle_unique_attribute_on_save(attribute_name, index_name, message)
+    existing_method = instance_method(:save)
+
+    define_method(:save) do |*args|
+      existing_method.bind(self).call(*args)
+    rescue ActiveRecord::RecordNotUnique => error
+      if error.message.include?(index_name)
+        errors.add(attribute_name, message)
+
+        return false
+      end
+
+      raise error
+    end
+  end
+
+  # @param attribute_name [String]
+  # @param index_name [String]
+  # @param message [Symbol, String]
+  # @return [void]
+  def handle_unique_attribute_on_save!(attribute_name, index_name, message)
+    existing_method = instance_method(:save!)
+
+    define_method(:save!) do |*args|
+      existing_method.bind(self).call(*args)
+    rescue ActiveRecord::RecordNotUnique => error
+      if error.message.include?(index_name)
+        errors.add(attribute_name, message)
+
+        raise ActiveRecord::RecordInvalid, self
+      end
+
+      raise error
+    end
+  end
+end

data/lib/has_unique_attribute/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HasUniqueAttribute
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: has_unique_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mihail-K
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !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: rubocop
+  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: rubocop-performance
+  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: rubocop-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: Adds custom handling for database uniqueness constraints to ActiveRecord.
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- has_unique_attribute.gemspec
+- lib/has_unique_attribute.rb
+- lib/has_unique_attribute/version.rb
+homepage: https://github.com/Mihail-K/has_unique_attribute
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Mihail-K/has_unique_attribute
+  source_code_uri: https://github.com/Mihail-K/has_unique_attribute
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Handle unique attributes safely using the database.
+test_files: []