merger 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+test/debug.log

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brandon Keepers
+
+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

@@ -0,0 +1,9 @@
+Merger
+======
+
+This is a Rails plugin for merging Active Record models together.  It is far from complete, but at the moment will move all the associations from the newer records to the oldest record and delete the newer records.
+
+Example
+=======
+
+  @person.merge!(@dup1, @dup2)

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rake'
+require "load_multi_rails_rake_tasks" 
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "merger"
+    gem.summary = "A Rails plugin for merging Active Record models"
+    gem.email = "brandon@opensoul.org"
+    gem.homepage = "http://github.com/collectiveidea/merger"
+    gem.authors = ["Brandon Keepers"]
+    gem.add_dependency "active_record"
+    gem.add_development_dependency "mocha"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+namespace :test do
+  begin
+    require 'rcov/rcovtask'
+    Rcov::RcovTask.new(:coverage) do |test|
+      test.libs << 'test'
+      test.pattern = 'test/**/test_*.rb'
+      test.verbose = true
+      test.output_dir = 'coverage'
+      test.rcov_opts = %w(--exclude test,/usr/lib/ruby,/Library/Ruby --sort coverage)
+    end
+  rescue LoadError
+    task :coverage do
+      abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+    end
+  end
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "merger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--line-numbers' << '--inline-source'
+end
+
+task :default => :test
+task :test => :check_dependencies

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,3 @@
+require 'merger'
+
+ActiveRecord::Base.send(:include, Merger)

data/lib/merger.rb

@@ -0,0 +1,13 @@
+require 'merger/merge'
+
+module Merger
+  def self.included(base)
+    base.send :include, InstanceMethods
+  end
+  
+  module InstanceMethods
+    def merge!(*others)
+      Merger::Merge.new(others, :keep => self).merge!
+    end
+  end
+end

data/lib/merger/merge.rb

@@ -0,0 +1,48 @@
+module Merger
+  class Merge
+    attr_reader :keep, :duplicates, :options
+  
+    def initialize(*records)
+      @options = records.extract_options!
+      @options[:destroy] = true unless @options.has_key?(:destroy)
+      records = records.flatten.uniq
+      @keep = options[:keep] || records.sort_by(&:id).first
+      @duplicates = records - [@keep]
+    end
+  
+    def ignored_associations
+      return @ignored if @ignored
+      @ignored = Array(options[:skip_association])
+      keep.class.reflect_on_all_associations.each do |association|
+        @ignored << association.through_reflection.name if association.through_reflection
+      end
+      @ignored
+    end
+
+    def associations!
+      keep.class.reflect_on_all_associations.each do |association|
+        duplicates.each do |record|
+          next if ignored_associations.include?(association.name)
+          case association.macro
+          when :has_many, :has_and_belongs_to_many
+            name = "#{association.name.to_s.singularize}_ids"
+            keep.send("#{name}=", keep.send(name) | record.send(name))
+          when :belongs_to, :has_one
+            keep.send("#{association.name}=", record.send(association.name)) if keep.send("#{association.name}").nil?
+          end
+        end
+      end
+    end
+    
+    def merge!
+      keep.class.transaction do
+        duplicates.each {|duplicate| duplicate.send(:before_merge, keep) if duplicate.respond_to?(:before_merge) }
+        associations!
+        duplicates.each {|duplicate| duplicate.send(:after_merge, keep) if duplicate.respond_to?(:after_merge) }
+        
+        duplicates.each(&:destroy) if options[:destroy]
+      end
+    end
+  
+  end
+end

data/test/db/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: acts_as_audited_plugin.sqlite.db
+sqlite3mem:
+  :adapter: sqlite3
+  :dbfile: ":memory:"
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: acts_as_audited_plugin.sqlite3.db
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: acts_as_audited_plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: rails
+  :password:
+  :database: acts_as_audited_plugin_test

data/test/db/schema.rb

@@ -0,0 +1,27 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :people, :force => true do |t|
+    t.string :given_name, :family_name
+    t.timestamps
+  end
+  
+  create_table :phones, :force => true do |t|
+    t.string :number, :type
+    t.belongs_to :person
+  end
+
+  create_table :tags, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :taggings, :force => true do |t|
+    t.belongs_to :person
+    t.belongs_to :tag
+  end
+  
+  create_table :companies, :force => true do |t|
+    t.belongs_to :person
+    t.string :type
+    t.string :name
+  end
+end

data/test/fixtures/companies.yml

@@ -0,0 +1,26 @@
+original_client_1:
+  type: Client
+  name: client 1
+  person_id: 1
+original_client_2:
+  type: Client
+  name: client 2
+  person_id: 1
+original_supplier_1:
+  type: Supplier
+  name: supplier 1
+  person_id: 1
+
+duplicate_client_3:
+  type: Client
+  name: client 3
+  person_id: 2
+
+duplicate_supplier_2:
+  type: Supplier
+  name: supplier 2
+  person_id: 2
+duplicate_supplier_3:
+  type: Supplier
+  name: supplier 3
+  person_id: 2

data/test/fixtures/people.yml

@@ -0,0 +1,10 @@
+original:
+  id: 1
+  given_name: Brandon
+  family_name: Keepers
+  created_at: <%= 1.year.ago.to_s(:db) %>
+duplicate:
+  id: 2
+  given_name: Brandon
+  family_name: Keepers
+  created_at: <%= 1.week.ago.to_s(:db) %>

data/test/fixtures/phones.yml

@@ -0,0 +1,12 @@
+original_home:
+  number: 1
+  type: Home
+  person_id: 1
+original_work:
+  number: 2
+  type: Work
+  person_id: 1
+duplicate_mobile:
+  number: 3
+  type: Mobile
+  person_id: 2

data/test/fixtures/taggings.yml

@@ -0,0 +1,11 @@
+tagging_brandon_as_friend1:
+  person_id: 1
+  tag_id: 2
+tagging_brandon_as_friend2:
+  person_id: 1
+  tag_id: 3
+tagging_brandon_as_developper:
+  person_id: 1
+  tag_id: 4
+
+

data/test/fixtures/tags.yml

@@ -0,0 +1,16 @@
+original_friend:
+  id: 1
+  name: Friend
+dup_friend1:
+  id: 2
+  name: Friends
+dup_friend2:
+  id: 3
+  name: Friends
+developer:
+  id: 4
+  name: Developer
+
+
+
+

data/test/merger/merge_test.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class Merger::MergeTest < Test::Unit::TestCase
+
+  def setup
+    @merge = Merger::Merge.new(people(:original), people(:duplicate))
+  end
+
+  def test_keeps_oldest_record
+    assert_equal people(:original), @merge.keep
+  end
+  
+  def test_explicitly_specify_record_to_keep
+    @merge = Merger::Merge.new(Person.find(:all), :keep => people(:duplicate))
+    assert_equal people(:duplicate), @merge.keep
+  end
+
+  def test_uses_newer_as_duplicates
+    assert @merge.duplicates.include?(people(:duplicate))
+    assert !@merge.duplicates.include?(people(:original))
+  end
+  
+  def test_moves_associations_to_original
+    @merge.associations!
+    assert_equal 3, people(:original).phones.count
+    assert_equal 0, people(:duplicate).phones.count
+  end
+  
+  def test_skip_association
+    Merger::Merge.new(people(:original), people(:duplicate), :skip_association => :phones).merge!
+    assert_equal 2, people(:original).phones.count
+  end
+
+  def test_merge_join_model
+
+    duplicated_tags = [
+      tags(:original_friend),
+      tags(:dup_friend1),
+      tags(:dup_friend2)
+    ]
+
+    Merger::Merge.new(duplicated_tags, :keep => tags(:original_friend)).merge!
+
+    assert_equal 2, people(:original).tags.count
+    assert_equal true, people(:original).tags.include?(tags(:original_friend))
+    assert_equal true, people(:original).tags.include?(tags(:developer))
+  
+  end
+
+  def test_merge_belongs_to
+    Merger::Merge.new( phones(:duplicate_mobile), :keep => phones(:original_work) ).merge!
+    
+    assert people(:original).phones.include?( phones(:original_work) )
+    assert !people(:original).phones.include?( phones(:duplicate_mobile) )
+    
+    assert_equal people(:original), phones(:original_work).person
+    assert_equal 0, people(:duplicate).phones.count, people(:duplicate).phones.inspect
+  end
+  
+  def test_merge_model_with_single_table_inheritance
+    @merge.associations!
+    assert_equal 6, people(:original).companies.count
+    assert_equal 3, people(:original).clients.count
+    assert_equal 3, people(:original).suppliers.count
+    assert_equal 0, people(:duplicate).companies.count
+  end
+  
+  def test_destroy_duplicates
+    @merge.merge!
+    assert_nil Person.find_by_id(people(:duplicate).id)
+  end
+  
+  def test_no_destroy_option
+    Merger::Merge.new(people(:original), people(:duplicate), :destroy => false).merge!
+    assert_not_nil Person.find_by_id(people(:duplicate).id)
+  end
+  
+  def test_callback
+    people(:duplicate).expects(:before_merge).with(people(:original))
+    people(:duplicate).expects(:after_merge).with(people(:original))
+    @merge.merge!
+  end
+end

data/test/merger_test.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class MergerTest < Test::Unit::TestCase
+
+  def test_ar_responds_to_merge!
+    assert Person.new.respond_to?(:merge!)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,55 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'multi_rails_init'
+require 'active_record' 
+require 'active_record/fixtures'
+
+require File.dirname(__FILE__) + '/../init.rb'
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + "/db/database.yml"))
+ActiveRecord::Base.establish_connection(ENV["DB"] || "sqlite3mem")
+ActiveRecord::Migration.verbose = false
+load(File.join(File.dirname(__FILE__), "db", "schema.rb"))
+
+class Person < ActiveRecord::Base
+  has_many :phones
+  has_many :taggings, :dependent => :destroy
+  has_many :tags, :through => :taggings
+  
+  has_many :companies
+  has_many :clients
+  has_many :suppliers
+end
+class Phone < ActiveRecord::Base
+  belongs_to :person
+  set_inheritance_column false
+end
+class Tag < ActiveRecord::Base
+  has_many :taggings, :dependent => :destroy
+  has_many :people, :through => :taggings
+end
+
+class Tagging < ActiveRecord::Base
+  belongs_to :person
+  belongs_to :tag
+end
+
+class Company < ActiveRecord::Base
+  belongs_to :person
+end
+class Client < Company
+end
+class Supplier < Company
+end
+
+class Test::Unit::TestCase #:nodoc:
+  self.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures  = false
+  fixtures :all
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: merger
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brandon Keepers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: brandon@opensoul.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/merger.rb
+- lib/merger/merge.rb
+- test/db/database.yml
+- test/db/schema.rb
+- test/fixtures/companies.yml
+- test/fixtures/people.yml
+- test/fixtures/phones.yml
+- test/fixtures/taggings.yml
+- test/fixtures/tags.yml
+- test/merger/merge_test.rb
+- test/merger_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/collectiveidea/merger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rails plugin for merging Active Record models
+test_files: 
+- test/db/schema.rb
+- test/merger/merge_test.rb
+- test/merger_test.rb
+- test/test_helper.rb