grosser-ar_merge 0.1.1

data/CHANGELOG

@@ -0,0 +1 @@
+v 0.1.1 -- added activerecord dependency

data/README.markdown

@@ -0,0 +1,52 @@
+PROBLEM
+=======
+ - Merging 2 records is often needed
+ - Merging has many hidden & problematic aspects
+
+
+SOLUTION
+==========
+ActiveRecord extension that introduces a simple merging API.
+
+ - Specify associations/attributes you want to merge
+ - Protects from self-merges
+ - Keeps counters valid
+ - Removes merged record
+
+
+INSTALL
+=======
+
+Rails plugin
+
+    script/plugin install git://github.com/grosser/ar_merge.git
+
+OR Gem
+
+    sudo gem install grosser-ar_merge
+    #require ar_merge after activerecord
+
+
+USAGE
+=====
+Merge from outside the model:
+
+    user.merge!(other,:attributes=>user.attributes.keys,:associations=>%w[movies friends])`
+
+Merge from inside the model
+
+    User < ActiveRecord::Base
+      def merge!(other)
+        super(other,:attributes=>%w[email website])
+      end
+    end
+
+Merge duplicates
+
+    #merge all new users, that have the same email
+    User.merge_duplicates!(User.find_all_by_status('new')) , :compare=>:email)
+
+AUTHOR
+======
+  Michael Grosser  
+  grosser dot michael ät gmail dot com  

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'spec'
+
+desc 'Default: run spec.'
+task :default => :spec
+
+desc "Run all specs in spec directory"
+task :spec do |t|
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('ar_merge', '0.1.1') do |p|
+  p.description    = "Simply and securely merge AciveRecord`s."
+  p.url            = "http://github.com/grosser/ar_merge"
+  p.author         = "Michael Grosser"
+  p.email          = "grosser.michael@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.dependencies   = %w[activerecord]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+task :update_gemspec do
+  puts "updating..."
+  `rake manifest`
+  `rake build_gemspec`
+end

data/ar_merge.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar_merge}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2008-12-23}
+  s.description = %q{Simply and securely merge AciveRecord`s.}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/ar_merge.rb", "README.markdown"]
+  s.files = ["Manifest", "CHANGELOG", "lib/ar_merge.rb", "spec/setup_test_model.rb", "spec/spec_helper.rb", "spec/ar_merge_spec.rb", "init.rb", "Rakefile", "README.markdown", "ar_merge.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/grosser/ar_merge}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ar_merge", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ar_merge}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Simply and securely merge AciveRecord`s.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'ar_merge'

data/lib/ar_merge.rb

@@ -0,0 +1,55 @@
+module AR_Merge
+  def self.included(base) #:nodoc:
+    base.extend ClassMethods
+    base.send(:include,InstanceMethods)
+  end
+
+  module InstanceMethods
+    def merge!(other,options={})
+      raise "cannot merge wit a new record" if other.new_record?
+      raise "cannot merge with myself" if other == self
+
+      #merge associations
+      (options[:associations]||[]).each do |association_name|
+        other.send(association_name).each do |object|
+          send(association_name).concat object
+        end
+        
+        #update counters, this is very basic/hacky/not secure for customized counters...
+        counter = "#{association_name}_count"
+        if other.respond_to?(counter)
+          other.send(counter).times{self.class.increment_counter(counter, id)}
+        end
+      end
+
+      #merge attributes
+      (options[:attributes]||[]).each do |attr|
+        send("#{attr}=",other.send(attr)) if send(attr).blank?
+      end
+
+      #cleanup
+      other.reload.destroy
+      save!
+    end
+  end
+
+  module ClassMethods
+    def merge_duplicates!(records,options)
+      records.each do |record|
+        next if record.nil?
+        records.each do |other|
+          next if other.nil?
+          next if other == record
+          is_comparable = other.send(options[:compare]) == record.send(options[:compare])
+          next unless is_comparable
+
+          #merge and remove the other
+          records[records.index(other)]=nil
+          record.merge!(other)
+        end
+      end.reject(&:nil?)
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include,AR_Merge)

data/spec/ar_merge_spec.rb

@@ -0,0 +1,98 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe "AR_Merge" do
+  describe :merge! do
+    before do
+      @user = User.create!(:name=>'x')
+      @u2 = User.create!(:name=>'y')
+    end
+
+    describe :removal do
+      it "removes the merged user" do
+        @user.merge!(@u2)
+        lambda{@u2.reload}.should raise_error(ActiveRecord::RecordNotFound)
+      end
+
+      it "saves the merging user" do
+        @user.expects(:save!)
+        @user.merge!(@u2)
+      end
+    end
+
+    describe :attributes do
+      it "merges and overtakes attributes" do
+        @user.name = ''
+        @user.merge!(@u2,:attributes=>['name'])
+        @user.name.should == 'y'
+      end
+
+      it "does not overtake attributes when current is not blank" do
+        @user.merge!(@u2,:attributes=>['name'])
+        @user.name.should == 'x'
+      end
+    end
+
+    describe :associations do
+      before do
+        Movie.delete_all
+        @user.movies << Movie.new
+        @user.save!
+        @user.movies.size.should == Movie.count
+      end
+
+      it "overtakes asociated objects" do
+        @u2.merge!(@user,:associations=>[:movies])
+        @u2.reload.should have(Movie.count).movies
+      end
+
+      it "does not create new objects" do
+        lambda{@u2.merge!(@user,:associations=>['movies'])}.should_not change(Movie,:count)
+      end
+
+      it "keeps counters in sync" do
+        user, merged_user = CountingUser.create!, CountingUser.create!
+        user.movies_count.should == 0
+        merged_user.movies << Movie.new
+        merged_user.save!
+        merged_user.reload.movies_count.should == 1
+
+        user.merge!(merged_user,:associations=>[:movies])
+        user.reload.movies_count.should == 1
+      end
+    end
+
+    it "does no merge with new" do
+      lambda{@user.merge!(User.new)}.should raise_error
+    end
+
+    it "does no merge with self" do
+      lambda{@user.merge!(User.find(@user.id))}.should raise_error
+    end
+  end
+
+  describe :merge_duplicates! do
+    before do
+      @u1 = User.create!(:name=>'a')
+      @u2 = User.create!(:name=>'b')
+      @u3 = User.create!(:name=>'a')
+      @u4 = User.create!(:name=>'a')
+      @users=[@u1,@u2,@u3]
+    end
+
+    it "merges all records that have the same attributes" do
+      User.merge_duplicates!(@users,:compare=>:name).should == [@u1,@u2]
+    end
+
+    it "destroys the duplicates" do
+      User.merge_duplicates!(@users,:compare=>:name)
+      lambda{@u3.reload}.should raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    it "merges the first with each of its duplicates" do
+      @users = [@u2,@u3,@u1,@u4]
+      @u3.expects(:merge!).with(@u1)
+      @u3.expects(:merge!).with(@u4)
+      User.merge_duplicates!(@users,:compare=>:name).should == [@u2,@u3]
+    end
+  end
+end

data/spec/setup_test_model.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'active_record'
+require 'active_record/fixtures'
+
+#create model table
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :counting_users do |t|
+    t.integer :movies_count, :default=>0, :null=>false
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :movies do |t|
+    t.integer :user_id
+    t.integer :counting_user_id
+    t.timestamps
+  end
+end
+
+#create model
+class User < ActiveRecord::Base
+  has_many :movies
+end
+
+class CountingUser < ActiveRecord::Base
+  has_many :movies
+end
+
+class Movie < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :counting_user, :counter_cache => true
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+# ---- requirements
+require 'rubygems'
+require 'spec'
+require 'mocha'
+require 'activerecord'
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+
+
+# ---- rspec
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+
+# ---- load database
+RAILS_ENV = "test"
+ActiveRecord::Base.configurations = {"test" => {
+  :adapter => "sqlite3",
+  :database => ":memory:",
+}.with_indifferent_access}
+
+ActiveRecord::Base.logger = Logger.new(File.directory?("log") ? "log/#{RAILS_ENV}.log" : "/dev/null")
+ActiveRecord::Base.establish_connection(:test)
+
+
+# ---- setup environment/plugin
+require 'ar_merge'
+require File.expand_path("../init", File.dirname(__FILE__))
+load File.expand_path("setup_test_model.rb", File.dirname(__FILE__))
+
+
+# ---- fixtures
+Spec::Example::ExampleGroupMethods.module_eval do
+  def fixtures(*tables)
+    dir = File.expand_path("fixtures", File.dirname(__FILE__))
+    tables.each{|table| Fixtures.create_fixtures(dir, table.to_s) }
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: grosser-ar_merge
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-23 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simply and securely merge AciveRecord`s.
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/ar_merge.rb
+- README.markdown
+files: 
+- Manifest
+- CHANGELOG
+- lib/ar_merge.rb
+- spec/setup_test_model.rb
+- spec/spec_helper.rb
+- spec/ar_merge_spec.rb
+- init.rb
+- Rakefile
+- README.markdown
+- ar_merge.gemspec
+has_rdoc: true
+homepage: http://github.com/grosser/ar_merge
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Ar_merge
+- --main
+- README.markdown
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: ar_merge
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simply and securely merge AciveRecord`s.
+test_files: []
+