mover 0.2.2 → 0.3.0

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Winton Welsh
+Copyright (c) 2010 Winton Welsh
 
 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 
@@ -15,4 +15,4 @@ 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.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+Mover
+=====
+
+Move ActiveRecord records across tables like it ain't no thang.
+
+Requirements
+------------
+
+<pre>
+sudo gem install mover
+</pre>
+
+Move records
+------------
+
+Move the last article:
+
+<pre>
+Article.last.move_to(ArticleArchive)
+</pre>
+
+Move today's articles:
+
+<pre>
+Article.move_to(
+  ArticleArchive,
+  :conditions => [ "created_at > ?", Date.today ]
+)
+</pre>
+
+The two tables do not have to be identical. Only shared columns transfer.
+
+If a primary key collision occurs, the destination record is updated.
+
+Callbacks
+---------
+
+In this example, we want an "archive" table for articles and comments.
+
+We also want the article's comments to be archived when the article is.
+
+<pre>
+class Article &lt; ActiveRecord::Base
+  has_many :comments
+  before_move :ArticleArchive do
+    comments.each { |c| c.move_to(CommentArchive) }
+  end
+end
+
+class ArticleArchive &lt; ActiveRecord::Base
+  has_many :comments, :class_name => 'CommentArchive', :foreign_key => 'article_id'
+  before_move :Article do
+    comments.each { |c| c.move_to(Comment) }
+  end
+end
+
+class Comment &lt; ActiveRecord::Base
+  belongs_to :article
+end
+
+class CommentArchive &lt; ActiveRecord::Base
+  belongs_to :article, :class_name => 'ArticleArchive', :foreign_key => 'article_id'
+end
+</pre>
+
+The <code>after\_move</code> callback is also available.
+
+Magic column
+------------
+
+If a table contains a <code>moved_at</code> column, it will magically populate with the date and time it was moved.
+
+Options
+-------
+
+There are other options, in addition to <code>conditions</code>:
+
+<pre>
+Article.move_to(
+  ArticleArchive,
+  :copy => true,          # Do not delete Article after move
+  :generic => true,       # UPDATE using a JOIN instead of ON DUPLICATE KEY UPDATE (default on non-MySQL engines)
+  :magic => 'updated_at', # Custom magic column
+  :quick => true          # You are certain only INSERTs are necessary, no primary key collisions possible
+                          # May only be a little faster on MySQL, but dramatically faster on other engines
+)
+</pre>
+
+You can access these options from callbacks using <code>move_options</code>.
+
+Reserve a spot
+--------------
+
+Before you create a record, you can "reserve a spot" on a table that you will move the record to later.
+
+<pre>
+archive = ArticleArchive.new
+archive.id = Article.reserve_id
+archive.save
+</pre>

data/lib/mover/gems.rb

@@ -0,0 +1,43 @@
+unless defined?(Mover::Gems)
+  
+  require 'rubygems'
+  
+  module Mover
+    class Gems
+    
+      VERSIONS = {
+        :active_wrapper => '=0.3.4',
+        :rake => '=0.8.7',
+        :rspec => '=1.3.1'
+      }
+    
+      TYPES = {
+        :gemspec => [],
+        :gemspec_dev => [ :active_wrapper, :rspec ],
+        :lib => [],
+        :rake => [ :rake, :rspec ],
+        :spec => [ :active_wrapper, :rspec ]
+      }
+      
+      class <<self
+        
+        def lockfile
+          file = File.expand_path('../../../gems', __FILE__)
+          unless File.exists?(file)
+            File.open(file, 'w') do |f|
+              Gem.loaded_specs.each do |key, value|
+                f.puts "#{key} #{value.version.version}"
+              end
+            end
+          end
+        end
+        
+        def require(type=nil)
+          (TYPES[type] || TYPES.values.flatten.compact).each do |name|
+            gem name.to_s, VERSIONS[name]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mover/version.rb

@@ -0,0 +1,3 @@
+module Mover
+  VERSION = "0.3.0" unless defined?(::Mover::VERSION)
+end

data/lib/mover.rb

@@ -1,11 +1,18 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../require")
-Require.lib!
+require File.dirname(__FILE__) + '/mover/gems'
+
+Mover::Gems.require(:lib)
+
+$:.unshift File.dirname(__FILE__) + '/mover'
+
+require 'version'
 
 module Mover
+  
   def self.included(base)
     unless base.included_modules.include?(InstanceMethods)
       base.extend ClassMethods
       base.send :include, InstanceMethods
+      base.send :attr_accessor, :move_options
     end
   end
   
@@ -20,117 +27,121 @@ module Mover
       @before_move ||= []
       @before_move << [ to_class, block ]
     end
-    
-    def after_copy(*to_class, &block)
-      @after_copy ||= []
-      @after_copy << [ to_class, block ]
-    end
-
-    def before_copy(*to_class, &block)
-      @before_copy ||= []
-      @before_copy << [ to_class, block ]
-    end
 
-    def move_to(to_class, conditions, instance=nil, copy = false)
+    def move_to(to_class, options={})
       from_class = self
+      
       # Conditions
-      add_conditions! where = '', conditions
+      conditions = options[:conditions] || '1'
+      conditions = self.sanitize_sql(conditions)
+      where = "WHERE #{conditions}"
+      
       # Columns
+      magic = options[:magic] || 'moved_at'
       insert = from_class.column_names & to_class.column_names
-      insert -= [ 'moved_at' ]
+      insert -= [ magic ]
       insert.collect! { |col| connection.quote_column_name(col) }
       select = insert.clone
+      
       # Magic columns
-      if to_class.column_names.include?('moved_at')
-        insert << connection.quote_column_name('moved_at')
+      if to_class.column_names.include?(magic)
+        insert << connection.quote_column_name(magic)
         select << connection.quote(Time.now.utc)
       end
+      
       # Callbacks
       collector = lambda do |(classes, block)|
         classes.collect! { |c| eval(c.to_s) }
         block if classes.include?(to_class) || classes.empty?
       end
-      if copy
-        before = (@before_copy || []).collect(&collector).compact
-        after = (@after_copy || []).collect(&collector).compact
-      else # move
-        before = (@before_move || []).collect(&collector).compact
-        after = (@after_move || []).collect(&collector).compact
-      end
+      before = (@before_move || []).collect(&collector).compact
+      after = (@after_move || []).collect(&collector).compact
+      
       # Instances
       instances =
-        if instance
-          [ instance ]
+        if options[:instance]
+          [ options[:instance] ]
         elsif before.empty? && after.empty?
           []
         else
-          self.find(:all, :conditions => where[5..-1])
+          self.find(:all, :conditions => conditions)
         end
+      options.delete(:instance)
+      
       # Callback executor
       exec_callbacks = lambda do |callbacks|
         callbacks.each do |block|
-          instances.each { |instance| instance.instance_eval(&block) }
+          instances.each do |instance|
+            instance.move_options = options
+            instance.instance_eval(&block)
+            instance.move_options = nil
+          end
         end
       end
+      
       # Execute
       transaction do
         exec_callbacks.call before
-        if copy
-          # for copy existing rows require an UPDATE statment, new rows require an INSERT statement
-          from_ids   = from_class.find(:all, :select => "id", :conditions => where[5..-1]).collect(&:id)
-          to_ids     = to_class.find(:all, :select => "id", :conditions => where[5..-1]).collect(&:id)
-          trash_ids  = to_ids - from_ids
-          # rid of the 'extra' to_ids to ensure to_ids is always be a subset of from_ids
-          insert_ids = from_ids - to_ids - trash_ids
-          update_ids = to_ids - insert_ids - trash_ids
-          
-          unless update_ids.empty?
-            # add table scope to columns for the UPDATE statement
-            update = []
-            insert.each_with_index{|col, i|
-              to   = insert[i].include?('`') ? "#{to_class.table_name}.#{insert[i]}"   : insert[i]
-              from = select[i].include?('`') ? "#{from_class.table_name}.#{select[i]}" : select[i]
-              update << "#{to} = #{from}"
-            }
-            where_ids = update_ids.collect{|x| "#{from_class.table_name}.id = #{x}"}
-            connection.execute(<<-SQL)
-              UPDATE #{to_class.table_name}
-              INNER JOIN #{from_class.table_name}
-              ON #{to_class.table_name}.id = #{from_class.table_name}.id
-              AND (#{where_ids.join(' AND ')})
-              SET #{update.join(', ')}
-            SQL
-          end
-
-          unless insert_ids.empty?
-            # insert ids, same as move except using a different where clause
-            where_ids = insert_ids.collect{|x| "#{from_class.table_name}.id = #{x}"}
-            sql =<<-SQL
-              INSERT INTO #{to_class.table_name} (#{insert.join(', ')})
-              SELECT #{select.join(', ')}
-              FROM #{from_class.table_name}
-              WHERE (#{where_ids.join(' OR ')})
-            SQL
-            connection.execute(sql)
+        
+        if options[:quick]
+          connection.execute(<<-SQL)
+            INSERT INTO #{to_class.table_name} (#{insert.join(', ')})
+            SELECT #{select.join(', ')}
+            FROM #{from_class.table_name}
+            #{where}
+          SQL
+        elsif !options[:generic] && connection.class.to_s.include?('Mysql')
+          update = insert.collect do |i|
+            "#{to_class.table_name}.#{i} = #{from_class.table_name}.#{i}"
           end
-        else
-          # moves
+          
           connection.execute(<<-SQL)
             INSERT INTO #{to_class.table_name} (#{insert.join(', ')})
             SELECT #{select.join(', ')}
             FROM #{from_class.table_name}
             #{where}
+            ON DUPLICATE KEY
+            UPDATE #{update.join(', ')};
+          SQL
+        else
+          conditions.gsub!(to_class.table_name, 't')
+          conditions.gsub!(from_class.table_name, 'f')
+          select.collect! { |s| s.include?('`') ? "f.#{s}" : s }
+          set = insert.collect { |i| "t.#{i} = f.#{i}" }
+          
+          connection.execute(<<-SQL)
+            UPDATE #{to_class.table_name}
+              AS t
+            INNER JOIN #{from_class.table_name}
+              AS f
+            ON f.id = t.id
+              AND #{conditions}
+            SET #{set.join(', ')}
+          SQL
+      
+          connection.execute(<<-SQL)
+            INSERT INTO #{to_class.table_name} (#{insert.join(', ')})
+            SELECT #{select.join(', ')}
+            FROM #{from_class.table_name}
+              AS f
+            LEFT OUTER JOIN #{to_class.table_name}
+              AS t
+            ON f.id = t.id
+            WHERE (
+              t.id IS NULL
+              AND #{conditions}
+            )
           SQL
+        end
+        
+        unless options[:copy]
           connection.execute("DELETE FROM #{from_class.table_name} #{where}")
         end
+        
         exec_callbacks.call after
       end
     end
 
-    def copy_to(to_class, conditions, instance=nil)
-      move_to(to_class, conditions, instance, true)
-    end
-
     def reserve_id
       id = nil
       transaction do
@@ -142,12 +153,11 @@ module Mover
   end
   
   module InstanceMethods
-    def move_to(to_class)
-      self.class.move_to(to_class, "#{self.class.primary_key} = #{id}", self)
-    end
-
-    def copy_to(to_class)
-      self.class.copy_to(to_class, "#{self.class.primary_key} = #{id}", self)
+    
+    def move_to(to_class, options={})
+      options[:conditions] = "#{self.class.table_name}.#{self.class.primary_key} = #{id}"
+      options[:instance] = self
+      self.class.move_to(to_class, options)
     end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Winton Welsh
@@ -14,49 +14,54 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-04 00:00:00 -07:00
+date: 2010-12-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: require
+  name: active_wrapper
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 2
-        - 6
-        version: 0.2.6
-  type: :runtime
+        - 3
+        - 4
+        version: 0.3.4
+  type: :development
   version_requirements: *id001
-description: 
-email: mail@wintoni.us
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id002
+description: Move ActiveRecord records across tables like it ain't no thang
+email: 
+- mail@wintoni.us
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- init.rb
+- lib/mover/gems.rb
+- lib/mover/version.rb
 - lib/mover.rb
-- MIT-LICENSE
-- rails/init.rb
-- Rakefile
-- README.markdown
-- require.rb
-- spec/config/database.yml.example
-- spec/db/migrate/001_create_fixtures.rb
-- spec/fixtures/article.rb
-- spec/fixtures/article_archive.rb
-- spec/fixtures/comment.rb
-- spec/fixtures/comment_archive.rb
-- spec/log/test.log
-- spec/mover_spec.rb
-- spec/Rakefile
-- spec/spec_helper.rb
+- LICENSE
+- README.md
 has_rdoc: true
 homepage: http://github.com/winton/mover
 licenses: []
@@ -67,6 +72,7 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -74,6 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -83,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Move ActiveRecord records across tables like it ain't no thang

data/README.markdown

@@ -1,72 +0,0 @@
-Mover
-=====
-
-Move ActiveRecord records across tables like it ain't no thang.
-
-Requirements
-------------
-
-<pre>
-sudo gem install mover
-</pre>
-
-Move records
-------------
-
-<pre>
-Article.last.move_to(ArticleArchive)
-Article.move_to(ArticleArchive, [ "created_at > ?", Date.today ])
-</pre>
-
-The <code>move_to</code> method is available to all models.
-
-The two tables do not have to be identical. Only shared columns transfer.
-
-Callbacks
----------
-
-In this example, we want an "archive" table for articles and comments.
-
-We also want the article's comments to be archived when the article is.
-
-<pre>
-class Article < ActiveRecord::Base
-  has_many :comments
-  before_move :ArticleArchive do
-    comments.each { |c| c.move_to(CommentArchive) }
-  end
-end
-
-class ArticleArchive < ActiveRecord::Base
-  has_many :comments, :class_name => 'CommentArchive', :foreign_key => 'article_id'
-  before_move :Article do
-    comments.each { |c| c.move_to(Comment) }
-  end
-end
-
-class Comment < ActiveRecord::Base
-  belongs_to :article
-end
-
-class CommentArchive < ActiveRecord::Base
-  belongs_to :article, :class_name => 'ArticleArchive', :foreign_key => 'article_id'
-end
-</pre>
-
-Reserve a spot
---------------
-
-Before you create a record, you can "reserve a spot" on a table that you will move the record to later.
-
-<pre>
-archive = ArticleArchive.new
-archive.id = Article.reserve_id
-archive.save
-</pre>
-
-Magic columns
--------------
-
-### moved_at
-
-If a table contains the column <code>moved_at</code>, it will automatically be populated with the date and time it was moved.

data/Rakefile

@@ -1,2 +0,0 @@
-require "#{File.dirname(__FILE__)}/require"
-Require.rakefile!

data/init.rb

@@ -1 +0,0 @@
-require File.dirname(__FILE__) + "/rails/init"

data/rails/init.rb

@@ -1,2 +0,0 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../require")
-Require.rails_init!

data/require.rb

@@ -1,51 +0,0 @@
-require 'rubygems'
-gem 'require'
-require 'require'
-
-Require do
-  gem(:active_wrapper, '=0.2.3') { require 'active_wrapper' }
-  gem :require, '=0.2.6'
-  gem(:rake, '=0.8.7') { require 'rake' }
-  gem :rspec, '=1.3.0'
-  
-  gemspec do
-    author 'Winton Welsh'
-    dependencies do
-      gem :require
-    end
-    email 'mail@wintoni.us'
-    name 'mover'
-    homepage "http://github.com/winton/#{name}"
-    summary "Move ActiveRecord records across tables like it ain't no thang"
-    version '0.2.2'
-  end
-  
-  bin { require 'lib/mover' }
-  lib {}
-  
-  rakefile do
-    gem(:active_wrapper)
-    gem(:rake) { require 'rake/gempackagetask' }
-    gem(:rspec) { require 'spec/rake/spectask' }
-    require 'require/tasks'
-  end
-  
-  rails_init { require 'lib/mover' }
-  
-  spec_helper do
-    require 'fileutils'
-    gem(:active_wrapper)
-    require 'require/spec_helper'
-    require 'rails/init'
-    require 'pp'
-    require 'spec/fixtures/article'
-    require 'spec/fixtures/article_archive'
-    require 'spec/fixtures/comment'
-    require 'spec/fixtures/comment_archive'
-  end
-  
-  spec_rakefile do
-    gem(:rake)
-    gem(:active_wrapper) { require 'active_wrapper/tasks' }
-  end
-end

data/spec/Rakefile

@@ -1,10 +0,0 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../require")
-Require.spec_rakefile!
-
-begin
-  ActiveWrapper::Tasks.new(
-    :base => File.dirname(__FILE__),
-    :env => ENV['ENV']
-  )
-rescue Exception
-end

data/spec/config/database.yml.example

@@ -1,6 +0,0 @@
-test:
-  adapter: mysql
-  database: mover
-  username: root
-  password: 
-  host: localhost

data/spec/db/migrate/001_create_fixtures.rb

@@ -1,28 +0,0 @@
-class CreateFixtures < ActiveRecord::Migration
-  def self.up
-    [ :articles, :article_archives ].each do |table|
-      create_table table do |t|
-        t.string :title
-        t.string :body
-        t.boolean :read
-        t.datetime :moved_at
-      end
-    end
-    
-    [ :comments, :comment_archives ].each do |table|
-      create_table table do |t|
-        t.string :title
-        t.string :body
-        t.boolean :read
-        t.integer :article_id
-        t.datetime :moved_at
-      end
-    end
-  end
-
-  def self.down
-    [ :articles, :article_archives, :comments, :comment_archives ].each do |table|
-      drop_table table
-    end
-  end
-end