doppel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b290250de01378cd85bbfa84e6d88dea131f38e
+  data.tar.gz: 544c2cd1124f92bc52f5bea8bf168faadb57149f
+SHA512:
+  metadata.gz: 4ed29bd8764e81f9b8e264e06712e965143958f104ca24ed7808e4d4e05765643106379661f11e6da638dd126821fcbe68d1fd0716c83aeed9033bbb9390e47e
+  data.tar.gz: a173fcd541e8d22f13d90ec35fad7e0cc2082f2ac294ad8addd0615eb5ebb13d956c76faf693af6df1a492198e9da9184f9fd782ba8adf5b7b3335b1edc784ce

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Dale Stevens
+
+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,78 @@
+# Doppel [![Build Status](https://secure.travis-ci.org/TwilightCoders/doppel.png)](http://travis-ci.org/TwilightCoders/doppel) [![Gem Version](https://badge.fury.io/rb/doppel.png)](http://badge.fury.io/rb/doppel) [![Code Climate](https://codeclimate.com/github/TwilightCoders/doppel.png)](https://codeclimate.com/github/TwilightCoders/doppel) [![Dependency Status](https://gemnasium.com/TwilightCoders/doppel.svg)](https://gemnasium.com/TwilightCoders/doppel)
+
+## Description
+
+This `acts_as` extension provides the ability to find similar records matching a set of specified fuzzy matched fields.
+
+## Requirements
+
+The database engine currently must impliment the [`levenshtein`](http://www.postgresql.org/docs/9.4/static/fuzzystrmatch.html) extension/feature. I believe this is currently limited to PostgreSQL.
+
+## Installation
+
+In your Gemfile:
+
+    gem 'doppel'
+
+Or, from the command line:
+
+    gem install doppel
+
+## Example
+
+To use, call `has_many_doppels` method in the model:
+
+```ruby
+class Company < ActiveRecord::Base
+  has_many_doppels [:name]
+end
+
+[1] pry(main)> duplicates = Company.with_name_doppels
+  Company Load (89586.2ms)  SELECT DISTINCT companies.* FROM companies, companies as doppel_companies WHERE (companies.id != doppel_companies.id) AND (levenshtein(companies.name, doppel_companies.name) < 2) GROUP BY companies.id HAVING COUNT(doppel_companies.id) > 0
+  Company Load (89586.2ms)  SELECT DISTINCT companies.* FROM companies, companies as doppel_companies WHERE (companies.id != doppel_companies.id) AND (levenshtein(companies.name, doppel_companies.name) < 2) GROUP BY companies.id HAVING COUNT(doppel_companies.id) > 0
+=> [#<Company:0x007fe486a84a18 id: 4332, type: "Company", name: "Basically Infinity", created_at: ..., updated_at: ... >,
+ #<Company:0x007fe485e70010 id: 5179, type: "Company", name: "Stucco", created_at: ..., updated_at: ... >,
+ #<Company:0x007fe485e6b5d8 id: 3234, type: "Company", name: "ÜSER", created_at: ..., updated_at: ... >,
+ #<Company:0x007fe485e6aae8 id: 8456, type: "Company", name: "Orange", created_at: ..., updated_at: ... >]
+
+ # From here you'll be able to do the following.
+
+[2] pry(main)> duplicates.first.name_doppels
+Company Load (13.1ms)  SELECT "companies".* FROM "companies" WHERE (levenshtein('Basically Infinity', companies.name) < 2) AND ("companies"."id" != $1)  [["id", 4332]]
+  Company Load (13.1ms)  SELECT "companies".* FROM "companies" WHERE (levenshtein('Basically Infinity', companies.name) < 2) AND ("companies"."id" != $1)  [["id", 4332]]
+=> [#<Company:0x007fe483464a00 id: 4057, type: "Company", name: "Interim Physicians", created_at: ..., updated_at: ... >]
+
+```
+
+## Instance Methods Added To ActiveRecord Models
+
+You'll have a number of methods added to each instance of the ActiveRecord model that to which `doppel` is added.
+
+These depend on how `has_many_doppels` is configured. For each field that is supplied, you'll have
+
+`#{field_name}_doppels`
+
+in addition to
+
+`doppels`
+
+which will return any matching duplicates from all fields supplied.
+
+## The Future
+
+Currently `doppel` only supports `levenshtein` text searching. I have tentative plans to impliment a more modular framework and support other field types such as dates or numerics.
+
+## Contributing to `doppel`
+
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+- Fork the project
+- Start a feature/bugfix branch
+- Commit and push until you are happy with your contribution
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+- I would recommend using Rails 3.1.x and higher for testing the build before a pull request. The current test harness does not quite work with 3.0.x. The plugin itself works, but the issue lies with testing infrastructure.
+
+## Copyright
+
+Copyright (c) 2015 Dale Stevens, released under the MIT license

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Doppel'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/doppel.rb

@@ -0,0 +1,6 @@
+require 'doppel/acts_as_doppel'
+
+module Doppel
+end
+
+ActiveRecord::Base.send :include, Doppel::ActsAsDoppel

data/lib/doppel/acts_as_doppel.rb

@@ -0,0 +1,52 @@
+module Doppel
+  module ActsAsDoppel
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def has_many_doppels(fields = [], options = {})
+        options = Doppel::ActsAsDoppel.merge_default_options(options)
+        other_table_name = "doppel_#{table_name}"
+        table_name_key = "#{table_name}.#{primary_key}"
+        other_table_name_key = "#{other_table_name}.#{primary_key}"
+        fields.each do |field|
+          class_eval <<-END, __FILE__, __LINE__ + 1
+            scope "with_#{field}_doppels", lambda { |count = #{options[:count]}, lev = #{options[:sensitivity]}|
+              select("DISTINCT #{table_name}.*")
+                .where("#{table_name_key} != #{other_table_name_key}")
+                .where("levenshtein(#{table_name}.#{field}, #{other_table_name}.#{field}) < \#\{lev\}")
+                .from("#{table_name}, #{table_name} as #{other_table_name}")
+                .group(table_name_key).having("COUNT(#{other_table_name_key}) > \#\{count\}")
+            }
+
+            def #{field}_doppels
+              @#{field}_doppels ||= self.where("levenshtein(\#\{self.sanitize(#{field})\}, #{table_name}.#{field}) < 2").where.not(#{primary_key}: #{primary_key})
+            end
+          END
+          # scope "with_#{field}_doppels", lambda { |count = options[:count], lev = options[:sensitivity]|
+          #   select("DISTINCT #{table_name}.*")
+          #     .where("#{table_name_key} != #{other_table_name_key}")
+          #     .where("levenshtein(#{table_name}.#{field}, #{other_table_name}.#{field}) < #{lev}")
+          #     .from("#{table_name}, #{table_name} as #{other_table_name}")
+          #     .group(table_name_key).having("COUNT(#{other_table_name_key}) > #{count}")
+          # }
+        end
+
+        # scope 'with_any_doppels', lambda { |count = options[:count], lev = options[:sensitivity]|
+        #   fields.inject(self) { |query, field| query.merge(send("with_#{field}_doppels")) }
+        # }
+
+        # alias_method 'with_dopels', "with_#{fields.first}_doppels" if fields.one?
+      end
+    end
+
+    def self.merge_default_options(options = {})
+      {
+        sensitivity: 2,
+        count: 0
+      }.merge(options)
+    end
+  end
+end

data/lib/doppel/version.rb

@@ -0,0 +1,3 @@
+module Doppel
+  VERSION = '0.0.1'
+end

data/lib/tasks/doppel_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :doppel do
+#   # Task goes here
+# end

data/test/doppel_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class DoppelTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Doppel
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
+require "rails/test_help"
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActiveSupport::TestCase.fixtures :all
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: doppel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dale Stevens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: Provides convenient scopes for finding duplicate records.
+email:
+- dale@twilightcoders.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/doppel.rb
+- lib/doppel/acts_as_doppel.rb
+- lib/doppel/version.rb
+- lib/tasks/doppel_tasks.rake
+- test/doppel_test.rb
+- test/test_helper.rb
+homepage: http://github.com/TwilightCoders/doppel
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Provides convenient scopes for finding duplicate records.
+test_files:
+- test/doppel_test.rb
+- test/test_helper.rb