chainlink 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+before_script:
+  - mysql -e 'create database chainlink_test;'
+  - psql -c 'create database chainlink_test;' -U postgres
+env:
+  - ADAPTER=sqlite3
+  - ADAPTER=mysql2
+  - ADAPTER=postgresql

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Norbert Crombach
+
+MIT License
+
+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,3 @@
+# ChainLink
+
+Simple ActiveRecord plugin for handling merges.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/chainlink.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = "chainlink"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Norbert Crombach"]
+  s.email       = ["norbert.crombach@primetheory.org"]
+  s.homepage    = "http://github.com/norbert/chainlink"
+  s.summary     = %q{Simple ActiveRecord plugin for handling merges.}
+
+  s.rubyforge_project = "chainlink"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = s.files.grep(/^test\//)
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activerecord', '~> 3.2.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pg'
+end

data/lib/chainlink.rb

@@ -0,0 +1,118 @@
+require 'active_record'
+
+module ChainLink
+  extend ActiveSupport::Concern
+
+  class DirectionError < StandardError
+  end
+
+  MERGE_TARGET_KEY = :merge_target_id
+  JOIN_TABLE_PREFIX = :merge_target_
+
+  included do
+    has_many :merge_sources, class_name: self.name, foreign_key: MERGE_TARGET_KEY
+
+    scope :merge_targets, lambda {
+      where(MERGE_TARGET_KEY => nil)
+    }
+    scope :merge_sources, lambda {
+      where("#{table_name}.#{MERGE_TARGET_KEY} IS NOT NULL")
+    }
+
+    class_attribute :merge_target_associations
+    self.merge_target_associations = []
+  end
+
+  module ClassMethods
+    def find_merge_target(*args)
+      as_merge_targets.find(*args)
+    end
+
+    def as_merge_targets
+      joins(merge_target_join_clause).select(merge_target_select_clause)
+    end
+
+    def merge!(target, source)
+      target.merge!(source)
+    end
+
+    private
+    def merge_target_join_clause
+      table_name = quoted_table_name
+      join_table_name = connection.quote_table_name(merge_target_join_table_name)
+
+      primary_key = quoted_primary_key
+      foreign_key = connection.quote_column_name(MERGE_TARGET_KEY.to_s)
+
+      equivalence_clause = merge_target_equivalence_clause(
+        "#{table_name}.#{foreign_key}", "#{table_name}.#{primary_key}"
+      )
+
+      "INNER JOIN #{table_name} AS #{join_table_name} ON #{join_table_name}.#{primary_key} = #{equivalence_clause}"
+    end
+
+    def merge_target_select_clause
+      "#{connection.quote_table_name(merge_target_join_table_name)}.*"
+    end
+
+    def merge_target_equivalence_clause(foreign_key, primary_key)
+      "COALESCE(#{foreign_key}, #{primary_key})"
+    end
+
+    def merge_target_join_table_name
+      "#{JOIN_TABLE_PREFIX}#{table_name}"
+    end
+  end
+
+  def merge!(source)
+    raise DirectionError, "source is not mergeable" unless source.mergeable?
+    raise DirectionError, "target is not mergeable" unless mergeable?(:target)
+
+    self.class.transaction do
+      yield if block_given?
+      source[MERGE_TARGET_KEY] ||= id
+      source.save!
+      save!
+    end
+
+    self
+  end
+
+  def merge_associations!(source, *associations)
+    Array(associations).each do |association_name|
+      reflection = self.class.reflect_on_association(association_name)
+      case reflection.macro
+      when :has_many
+        foreign_key = reflection.foreign_key
+        reflection.klass.where(foreign_key => source.id).update_all(foreign_key => id)
+      end
+    end
+  end
+
+  def merge_target
+    if !merged?
+      self
+    elsif target_record = self.class.find_by_id(merge_target_id)
+      target_record.merge_target
+    end
+  end
+
+  def merged?
+    merge_target_id.present?
+  end
+
+  def mergeable?(as = :source)
+    case as
+    when :source
+      !merged? && !merge_sources.exists?
+    when :target
+      !merged?
+    else
+      raise ArgumentError, "unknown merge role"
+    end
+  end
+
+  def merge_target_id
+    read_attribute(MERGE_TARGET_KEY)
+  end
+end

data/test/chainlink_test.rb

@@ -0,0 +1,115 @@
+require 'test_helper'
+
+class ChainLinkTest < ActiveSupport::TestCase
+  include ChainLinkTestHelper
+
+  setup do
+    @target = Artist.create!(name: 'Burial')
+    @source = Artist.create!(name: 'Burial', imported: true)
+  end
+
+  test "should merge record instances" do
+    @source.records.create!(title: 'Distant Lights')
+
+    assert @target.mergeable?
+    assert @target.mergeable?(:target)
+    assert @source.mergeable?
+    assert @source.mergeable?(:target)
+
+    assert_no_difference '@target.records.count' do
+      assert_equal @target, @target.merge!(@source)
+    end
+    assert_equal @target.id, @source.merge_target_id
+
+    assert @source.merged?
+    assert !@target.mergeable?
+    assert @target.mergeable?(:target)
+    assert !@source.mergeable?
+    assert !@source.mergeable?(:target)
+  end
+
+  test "should not merge instances with existing sources or targets" do
+    @target.merge!(@source)
+    @duplicate = Artist.create!(name: 'burial')
+
+    assert_raise ChainLink::DirectionError do
+      @duplicate.merge!(@source)
+    end
+    assert_raise ChainLink::DirectionError do
+      @duplicate.merge!(@target)
+    end
+    assert_raise ChainLink::DirectionError do
+      @source.merge!(@duplicate)
+    end
+
+    assert @target.merge!(@duplicate)
+  end
+
+  test "should find merge targets" do
+    @target.merge!(@source)
+    assert_equal @target, Artist.find_merge_target(@source)
+  end
+
+  test "should list merge sources and targets" do
+    @target.merge!(@source)
+    assert_equal [@target], Artist.merge_targets
+    assert_equal [@source], Artist.merge_sources
+  end
+
+  test "should resolve merge targets" do
+    @duplicate = Artist.create!(name: 'burial')
+    @target.merge!(@source)
+    @target.merge!(@duplicate)
+    assert_equal [@target, @target], Artist.as_merge_targets.where(id: [@source, @duplicate]).all
+    assert_equal @target, @source.merge_target
+  end
+
+  test "should yield during merge" do
+    # useful for temporary scripts and subclassing
+    @target.merge!(@source) do
+      @target.imported = @source.imported
+    end
+
+    assert @target.imported?
+  end
+
+  test "should merge collection associations" do
+    @target.records.create!(title: 'Ghost Hardware')
+    @source.records.create!(title: 'South London Borougs')
+    @source.records.create!(title: 'Distant Lights')
+
+    assert_difference '@target.records.count', 2 do
+      # this should not be a side effect of subclassing either
+      assert_no_difference 'Record.count' do
+        @target.merge_target_associations = [:records]
+        @target.merge_associations!(@source, :records)
+      end
+    end
+
+    assert_blank Artist.merge_target_associations
+
+    assert_equal Record.all, @target.records
+  end
+
+  test "should not merge singular associations" do
+    @associated_target = @target.records.create!(title: 'Ghost Hardware')
+    @associated_source = @source.records.create!(title: 'Kindred')
+
+    # reflects on merge_sources
+    assert @associated_source.mergeable?
+
+    # check fragile state of implementation
+    reflection = mock('reflection', macro: :belongs_to)
+    reflection.expects(:foreign_key).never
+    Record.expects(:reflect_on_association).with(:artist).returns(reflection)
+
+    @associated_target.merge_target_associations = [:artist]
+    @associated_target.merge_associations!(@associated_source, :artist)
+  end
+
+  test "should find merge targets recursively on instances" do
+    @target.merge!(@source)
+    @duplicate = Artist.create!(name: 'Burial', merge_target_id: @source.id)
+    assert_equal @target, @duplicate.merge_target
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,60 @@
+require 'chainlink'
+
+require 'test/unit'
+require 'mocha/setup'
+require 'database_cleaner'
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.logger.level = Logger::UNKNOWN
+
+case ENV['ADAPTER'] || 'sqlite3'
+when 'sqlite3'
+  ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+when 'mysql2'
+  ActiveRecord::Base.establish_connection(adapter: 'mysql2', database: 'chainlink_test')
+when 'postgresql'
+  configuration = { adapter: 'postgresql', database: 'chainlink_test'}
+  configuration[:username] = 'postgres' if ENV['CI'] == 'true'
+  ActiveRecord::Base.establish_connection(configuration)
+end
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :artists, force: true do |t|
+    t.string :name
+    t.boolean :imported
+    t.integer :merge_target_id
+  end
+
+  create_table :records, force: true do |t|
+    t.integer :artist_id
+    t.string :title
+    t.integer :merge_target_id
+  end
+end
+
+module ChainLinkTestHelper
+  extend ActiveSupport::Concern
+
+  DatabaseCleaner[:active_record].strategy = :transaction
+
+  included do
+    setup do
+      DatabaseCleaner.start
+    end
+
+    teardown do
+      DatabaseCleaner.clean
+    end
+  end
+end
+
+class Artist < ActiveRecord::Base
+  include ChainLink
+  has_many :records
+end
+
+class Record < ActiveRecord::Base
+  include ChainLink
+  belongs_to :artist
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: chainlink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Norbert Crombach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- norbert.crombach@primetheory.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- chainlink.gemspec
+- lib/chainlink.rb
+- test/chainlink_test.rb
+- test/test_helper.rb
+homepage: http://github.com/norbert/chainlink
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: chainlink
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple ActiveRecord plugin for handling merges.
+test_files:
+- test/chainlink_test.rb
+- test/test_helper.rb