activerecord-find_duplicates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea01f085526639dec081cbac6e4c7ef60bd0d2116a479cd5cd9c338f4c1c6ee1
+  data.tar.gz: af82766b89cc6c5a07b6d48b10b87b49195e4e960521fe85db5d2bebcc2abe44
+SHA512:
+  metadata.gz: b54fb2ace3992cf22892abda4f791a26ad2a3956a16a4f8d918b2ec6e57873fa5c56f0305d642935423c10564fbbc59b61973ab9c0d5313066118dff8eeb53c3
+  data.tar.gz: 7fd2995428e5d6cdd8948788e964b0888bc374a4f06f67e6e75029e70588a989a7958cd20d4167c211a91c56d9f9269a257f39d2b40f01b914b57d2f87e95108

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+spec/database.yml

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/License

@@ -0,0 +1,18 @@
+Copyright (c) 2019 Tyler Rick
+
+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/Rakefile

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

data/Readme.md

@@ -0,0 +1,64 @@
+# Activerecord::FindDuplicates
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'activerecord-find_duplicates'
+```
+
+## Usage
+
+General usage is:
+```ruby
+Model.find_duplicates(on: attr_name)
+```
+
+You can pass a minimum number to be considered a duplicate (default is 2) with `min:`.
+
+Example: To find all user records that have a duplicate email address:
+```ruby
+User.find_duplicates(on: :email)
+# => [#<User:0x000055e7916ff3c8 id: 1, email: "a@a.com">,
+       #<User:0x000055e7916ff1e8 id: 2, email: "a@a.com">]
+
+```
+
+Often it is useful to group by the duplicate value, making the value the key and the set of records sharing that key as the value:
+```ruby
+User.find_duplicates(on: :email).group_by(&:email)
+# => {"a@a.com"=>
+  [#<User:0x000055cc1915f0c8 id: 1, email: "a@a.com">,
+   #<User:0x000055cc1915ef38 id: 2, email: "a@a.com">]}
+```
+
+You can also chain it on other relations. For example, to find all duplicates *except* those with a null value:
+```ruby
+User.where('email is not null').find_duplicates(on: :email)
+```
+
+## Possible uses
+
+You realize that a certain column should be unique but actually contains duplicate values. Even though you had a uniqueness validation on the model:
+```ruby
+validates :email, uniqueness: true
+```
+, this is subject to race conditions. The only sure way to prevent duplicate values on a column is to add a unique index/constraint and let your *database* engine enforce the constraint.
+
+But before you can add a migration that adds that index, you have to remove all duplicates or you will get:
+```
+PG::UniqueViolation: ERROR:  could not create unique index "index_users_on_email"
+DETAIL:  Key (email)=(user@example.com) is duplicated.
+```
+
+
+## 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/TylerRick/activerecord-find_duplicates.

data/activerecord-find_duplicates.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "activerecord/find_duplicates/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-find_duplicates"
+  spec.version       = Activerecord::FindDuplicates.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Easily find all duplicate records)}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/TylerRick/merge_params"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/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('..', __FILE__)) 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.required_ruby_version = ">= 2.0.0"
+  spec.add_dependency "activerecord", [">= 4.2", "< 5.3"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pg"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/find_duplicates"
+
+# 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/lib/activerecord/find_duplicates.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+
+module ActiveRecord::FindDuplicates
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Examples:
+    #   User.find_duplicates(on: :email).group_by(&:email)
+    #   User.where('email is not null').find_duplicates(on: :email)
+    def find_duplicates(on:, min: 2)
+      attr_name = on
+      values = group(attr_name).having(
+        # If I could figure out how to do "count(*)".gteq(min) with Arel, then it would work with sqlite
+        arel_table[Arel.star].count.gteq(min)
+      ).count.keys
+
+      where(attr_name => values)
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include ActiveRecord::FindDuplicates
+end

data/lib/activerecord/find_duplicates/version.rb

@@ -0,0 +1,7 @@
+module Activerecord
+  module FindDuplicates
+    def self.version
+      "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-find_duplicates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !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: '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.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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: Easily find all duplicate records)
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- activerecord-find_duplicates.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/find_duplicates.rb
+- lib/activerecord/find_duplicates/version.rb
+homepage: https://github.com/TylerRick/merge_params
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TylerRick/merge_params
+  source_code_uri: https://github.com/TylerRick/merge_params
+  changelog_uri: https://github.com/TylerRick/merge_params/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.0.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: Easily find all duplicate records)
+test_files: []