activerecord-import-rails4 0.5.0

data/test/jdbcmysql/import_test.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/assertions')
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/import_examples')
+
+should_support_mysql_import_functionality

data/test/models/book.rb

@@ -0,0 +1,3 @@
+class Book < ActiveRecord::Base
+  belongs_to :topic
+end

data/test/models/group.rb

@@ -0,0 +1,3 @@
+class Group < ActiveRecord::Base
+  self.table_name = 'group'
+end

data/test/models/topic.rb

@@ -0,0 +1,7 @@
+class Topic < ActiveRecord::Base
+  validates_presence_of :author_name
+  has_many :books
+  belongs_to :parent, :class_name => "Topic"
+  
+  composed_of :description, :mapping => [ %w(title title), %w(author_name author_name)], :allow_nil => true, :class_name => "TopicDescription"
+end

data/test/models/widget.rb

@@ -0,0 +1,3 @@
+class Widget < ActiveRecord::Base
+  self.primary_key = :w_id
+end

data/test/mysql/import_test.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/assertions')
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/import_examples')
+
+should_support_mysql_import_functionality

data/test/mysql2/import_test.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/assertions')
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/import_examples')
+
+should_support_mysql_import_functionality

data/test/mysqlspatial/import_test.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/assertions')
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/import_examples')
+
+should_support_mysql_import_functionality

data/test/mysqlspatial2/import_test.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/assertions')
+require File.expand_path(File.dirname(__FILE__) + '/../support/mysql/import_examples')
+
+should_support_mysql_import_functionality

data/test/postgis/import_test.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../support/postgresql/import_examples')
+
+should_support_postgresql_import_functionality

data/test/postgresql/import_test.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../support/postgresql/import_examples')
+
+should_support_postgresql_import_functionality

data/test/schema/generic_schema.rb

@@ -0,0 +1,102 @@
+ActiveRecord::Schema.define do
+
+  create_table :schema_info, :force=>true do |t|
+    t.column :version, :integer, :unique=>true
+  end
+  SchemaInfo.create :version=>SchemaInfo::VERSION
+
+  create_table :group, :force => true do |t|
+    t.column :order, :string
+    t.timestamps
+  end
+
+  create_table :topics, :force=>true do |t|
+    t.column :title, :string, :null => false
+    t.column :author_name, :string
+    t.column :author_email_address, :string
+    t.column :written_on, :datetime
+    t.column :bonus_time, :time
+    t.column :last_read, :datetime
+    t.column :content, :text
+    t.column :approved, :boolean, :default=>'1'
+    t.column :replies_count, :integer
+    t.column :parent_id, :integer
+    t.column :type, :string
+    t.column :created_at, :datetime
+    t.column :created_on, :datetime
+    t.column :updated_at, :datetime
+    t.column :updated_on, :datetime
+  end
+
+  create_table :projects, :force=>true do |t|
+    t.column :name, :string
+    t.column :type, :string
+  end
+
+  create_table :developers, :force=>true do |t|
+    t.column :name, :string
+    t.column :salary, :integer, :default=>'70000'
+    t.column :created_at, :datetime
+    t.column :team_id, :integer
+    t.column :updated_at, :datetime
+  end
+
+  create_table :addresses, :force=>true do |t|
+    t.column :address, :string
+    t.column :city, :string
+    t.column :state, :string
+    t.column :zip, :string
+    t.column :developer_id, :integer
+  end
+
+  create_table :teams, :force=>true do |t|
+    t.column :name, :string
+  end
+
+  create_table :books, :force=>true do |t|
+    t.column :title, :string, :null=>false
+    t.column :publisher, :string, :null=>false, :default => 'Default Publisher'
+    t.column :author_name, :string, :null=>false
+    t.column :created_at, :datetime
+    t.column :created_on, :datetime
+    t.column :updated_at, :datetime
+    t.column :updated_on, :datetime
+    t.column :publish_date, :date
+    t.column :topic_id, :integer
+    t.column :for_sale, :boolean, :default => true
+  end
+
+  create_table :languages, :force=>true do |t|
+    t.column :name, :string
+    t.column :developer_id, :integer
+  end
+
+  create_table :shopping_carts, :force=>true do |t|
+    t.column :name, :string, :null => true
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+
+  create_table :cart_items, :force => true do |t|
+    t.column :shopping_cart_id, :string, :null => false
+    t.column :book_id, :string, :null => false
+    t.column :copies, :integer, :default => 1
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+
+  add_index :cart_items, [:shopping_cart_id, :book_id], :unique => true, :name => 'uk_shopping_cart_books'
+
+  create_table :animals, :force => true do |t|
+    t.column :name, :string, :null => false
+    t.column :size, :string, :default => nil
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+
+  add_index :animals, [:name], :unique => true, :name => 'uk_animals'
+
+  create_table :widgets, :id => false, :force => true do |t|
+    t.integer :w_id
+  end
+end

data/test/schema/mysql_schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define do
+
+  create_table :books, :options=>'ENGINE=MyISAM', :force=>true do |t|
+    t.column :title, :string, :null=>false
+    t.column :publisher, :string, :null=>false, :default => 'Default Publisher'
+    t.column :author_name, :string, :null=>false
+    t.column :created_at, :datetime
+    t.column :created_on, :datetime
+    t.column :updated_at, :datetime
+    t.column :updated_on, :datetime
+    t.column :publish_date, :date
+    t.column :topic_id, :integer
+    t.column :for_sale, :boolean, :default => true
+  end
+  execute "ALTER TABLE books ADD FULLTEXT( `title`, `publisher`, `author_name` )"
+
+end

data/test/schema/version.rb

@@ -0,0 +1,10 @@
+class SchemaInfo < ActiveRecord::Base
+  if respond_to?(:table_name=)
+    self.table_name = 'schema_info'
+  else
+    # this is becoming deprecated in ActiveRecord but not all adapters supported it
+    # at this time
+    set_table_name 'schema_info'
+  end
+  VERSION = 12
+end

data/test/support/active_support/test_case_extensions.rb

@@ -0,0 +1,67 @@
+class ActiveSupport::TestCase
+  include ActiveRecord::TestFixtures
+  self.use_transactional_fixtures = true
+  
+  class << self
+    def assertion(name, &block)
+      mc = class << self ; self ; end
+      mc.class_eval do
+        define_method(name) do
+          it(name, &block)
+        end
+      end
+    end
+    
+    def asssertion_group(name, &block)
+      mc = class << self ; self ; end
+      mc.class_eval do
+        define_method(name, &block)
+      end
+    end
+
+    def macro(name, &block)
+      class_eval do
+        define_method(name, &block)
+      end
+    end
+    
+    def describe(description, toplevel=nil, &blk)
+      text = toplevel ? description : "#{name} #{description}"
+      klass = Class.new(self)
+
+      klass.class_eval <<-RUBY_EVAL
+        def self.name
+          "#{text}"
+        end
+      RUBY_EVAL
+
+      # do not inherit test methods from the superclass
+      klass.class_eval do
+        instance_methods.grep(/^test.+/) do |method|
+          undef_method method
+        end
+      end
+
+      klass.instance_eval &blk
+    end
+    alias_method :context, :describe
+    
+    def let(name, &blk)
+      values = {}
+      define_method(name) do
+        return values[name] if values.has_key?(name)
+        values[name] = instance_eval(&blk)
+      end
+    end
+    
+    def it(description, &blk)
+      define_method("test: #{name} #{description}", &blk)
+    end
+  end
+  
+end
+
+def describe(description, &blk)
+  ActiveSupport::TestCase.describe(description, true, &blk)
+end
+

data/test/support/factories.rb

@@ -0,0 +1,19 @@
+FactoryGirl.define do
+  factory :group do
+    sequence(:order) { |n| "Order #{n}" }
+  end
+
+  factory :invalid_topic, :class => "Topic" do
+    sequence(:title){ |n| "Title #{n}"}
+    author_name nil
+  end
+
+  factory :topic do
+    sequence(:title){ |n| "Title #{n}"}
+    sequence(:author_name){ |n| "Author #{n}"}
+  end
+
+  factory :widget do
+    sequence(:w_id){ |n| n}
+  end
+end

data/test/support/generate.rb

@@ -0,0 +1,29 @@
+class ActiveSupport::TestCase
+  def Build(*args)
+    n = args.shift if args.first.is_a?(Numeric)
+    factory = args.shift
+    factory_girl_args = args.shift || {}
+
+    if n
+      Array.new.tap do |collection|
+        n.times.each { collection << FactoryGirl.build(factory.to_s.singularize.to_sym, factory_girl_args) }
+      end
+    else
+      FactoryGirl.build(factory.to_s.singularize.to_sym, factory_girl_args)
+    end
+  end
+
+  def Generate(*args)
+    n = args.shift if args.first.is_a?(Numeric)
+    factory = args.shift
+    factory_girl_args = args.shift || {}
+
+    if n
+      Array.new.tap do |collection|
+        n.times.each { collection << FactoryGirl.create(factory.to_s.singularize.to_sym, factory_girl_args) }
+      end
+    else
+      FactoryGirl.create(factory.to_s.singularize.to_sym, factory_girl_args)
+    end
+  end
+end

data/test/support/mysql/assertions.rb

@@ -0,0 +1,55 @@
+class ActiveSupport::TestCase
+  module MySQLAssertions
+    def self.extended(klass)
+      klass.instance_eval do
+        assertion(:should_not_update_created_at_on_timestamp_columns) do
+          Delorean.time_travel_to("5 minutes from now") do
+            perform_import
+            assert_equal @topic.created_at.to_i, updated_topic.created_at.to_i
+            assert_equal @topic.created_on.to_i, updated_topic.created_on.to_i
+          end
+        end
+
+        assertion(:should_update_updated_at_on_timestamp_columns) do
+          time = Chronic.parse("5 minutes from now")
+          Delorean.time_travel_to(time) do
+            perform_import
+            assert_equal time.to_i, updated_topic.updated_at.to_i
+            assert_equal time.to_i, updated_topic.updated_on.to_i
+          end
+        end
+
+        assertion(:should_not_update_timestamps) do
+          Delorean.time_travel_to("5 minutes from now") do
+            perform_import :timestamps => false
+            assert_equal @topic.created_at.to_i, updated_topic.created_at.to_i
+            assert_equal @topic.created_on.to_i, updated_topic.created_on.to_i
+            assert_equal @topic.updated_at.to_i, updated_topic.updated_at.to_i
+            assert_equal @topic.updated_on.to_i, updated_topic.updated_on.to_i
+          end
+        end
+
+        assertion(:should_not_update_fields_not_mentioned) do
+          assert_equal "John Doe", updated_topic.author_name
+        end
+
+        assertion(:should_update_fields_mentioned) do
+          perform_import
+          assert_equal "Book - 2nd Edition", updated_topic.title
+          assert_equal "johndoe@example.com", updated_topic.author_email_address
+        end
+
+        assertion(:should_update_fields_mentioned_with_hash_mappings) do
+          perform_import
+          assert_equal "johndoe@example.com", updated_topic.title
+          assert_equal "Book - 2nd Edition", updated_topic.author_email_address
+        end
+
+        assertion(:should_update_foreign_keys) do
+          perform_import
+          assert_equal 57, updated_topic.parent_id
+        end
+      end
+    end
+  end
+end

data/test/support/mysql/import_examples.rb

@@ -0,0 +1,190 @@
+# encoding: UTF-8
+def should_support_mysql_import_functionality
+
+  describe "building insert value sets" do
+    it "should properly build insert value set based on max packet allowed" do
+      values = [
+        "('1','2','3')",
+        "('4','5','6')",
+        "('7','8','9')" ]
+
+      adapter = ActiveRecord::Base.connection.class
+      values_size_in_bytes = values.sum {|value| value.bytesize }
+      base_sql_size_in_bytes = 15
+      max_bytes = 30
+
+      value_sets = adapter.get_insert_value_sets( values, base_sql_size_in_bytes, max_bytes )
+      assert_equal 3, value_sets.size, 'Three value sets were expected!'
+
+      # Each element in the value_sets array must be an array
+      value_sets.each_with_index { |e,i| 
+        assert_kind_of Array, e, "Element #{i} was expected to be an Array!" }
+
+      # Each element in the values array should have a 1:1 correlation to the elements
+      # in the returned value_sets arrays
+      assert_equal values[0], value_sets[0].first
+      assert_equal values[1], value_sets[1].first
+      assert_equal values[2], value_sets[2].first
+    end
+
+    context "data contains multi-byte chars" do
+      it "should properly build insert value set based on max packet allowed" do
+        # each accented e should be 2 bytes, so each entry is 6 bytes instead of 5
+        values = [
+          "('é')",
+          "('é')" ]
+
+        adapter = ActiveRecord::Base.connection.class
+        base_sql_size_in_bytes = 15
+        max_bytes = 26
+
+        values_size_in_bytes = values.sum {|value| value.bytesize }
+        value_sets = adapter.get_insert_value_sets( values, base_sql_size_in_bytes, max_bytes )
+
+        assert_equal 2, value_sets.size, 'Two value sets were expected!'
+      end
+    end
+  end
+
+  describe "#import with :on_duplicate_key_update option (mysql specific functionality)" do
+    extend ActiveSupport::TestCase::MySQLAssertions
+
+    asssertion_group(:should_support_on_duplicate_key_update) do
+      should_not_update_fields_not_mentioned
+      should_update_foreign_keys
+      should_not_update_created_at_on_timestamp_columns
+      should_update_updated_at_on_timestamp_columns
+    end
+
+    macro(:perform_import){ raise "supply your own #perform_import in a context below" }
+    macro(:updated_topic){ Topic.find(@topic) }
+
+    context "given columns and values with :validation checks turned off" do
+      let(:columns){  %w( id title author_name author_email_address parent_id ) }
+      let(:values){ [ [ 99, "Book", "John Doe", "john@doe.com", 17 ] ] }
+      let(:updated_values){ [ [ 99, "Book - 2nd Edition", "Author Should Not Change", "johndoe@example.com", 57 ] ] }
+
+      macro(:perform_import) do |*opts|
+        Topic.import columns, updated_values, opts.extract_options!.merge(:on_duplicate_key_update => update_columns, :validate => false)
+      end
+
+      setup do
+        Topic.import columns, values, :validate => false
+        @topic = Topic.find 99
+      end
+
+      context "using string column names" do
+        let(:update_columns){ [ "title", "author_email_address", "parent_id" ] }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned
+      end
+
+      context "using symbol column names" do
+        let(:update_columns){ [ :title, :author_email_address, :parent_id ] }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned
+      end
+
+      context "using string hash map" do
+        let(:update_columns){ { "title" => "title", "author_email_address" => "author_email_address", "parent_id" => "parent_id" } }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned
+      end
+
+      context "using string hash map, but specifying column mismatches" do
+        let(:update_columns){ { "title" => "author_email_address", "author_email_address" => "title", "parent_id" => "parent_id" } }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned_with_hash_mappings
+      end
+
+      context "using symbol hash map" do
+        let(:update_columns){ { :title => :title, :author_email_address => :author_email_address, :parent_id => :parent_id } }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned
+      end
+
+      context "using symbol hash map, but specifying column mismatches" do
+        let(:update_columns){ { :title => :author_email_address, :author_email_address => :title, :parent_id => :parent_id } }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned_with_hash_mappings
+      end
+    end
+
+    context "given array of model instances with :validation checks turned off" do
+      macro(:perform_import) do |*opts|
+        @topic.title = "Book - 2nd Edition"
+        @topic.author_name = "Author Should Not Change"
+        @topic.author_email_address = "johndoe@example.com"
+        @topic.parent_id = 57
+        Topic.import [@topic], opts.extract_options!.merge(:on_duplicate_key_update => update_columns, :validate => false)
+      end
+
+      setup do
+        @topic = Generate(:topic, :id => 99, :author_name => "John Doe", :parent_id => 17)
+      end
+
+      context "using string column names" do
+        let(:update_columns){ [ "title", "author_email_address", "parent_id" ] }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned
+      end
+
+      context "using symbol column names" do
+        let(:update_columns){ [ :title, :author_email_address, :parent_id ] }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned
+      end
+
+      context "using string hash map" do
+        let(:update_columns){ { "title" => "title", "author_email_address" => "author_email_address", "parent_id" => "parent_id" } }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned
+      end
+
+      context "using string hash map, but specifying column mismatches" do
+        let(:update_columns){ { "title" => "author_email_address", "author_email_address" => "title", "parent_id" => "parent_id" } }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned_with_hash_mappings
+      end
+
+      context "using symbol hash map" do
+        let(:update_columns){ { :title => :title, :author_email_address => :author_email_address, :parent_id => :parent_id } }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned
+      end
+
+      context "using symbol hash map, but specifying column mismatches" do
+        let(:update_columns){ { :title => :author_email_address, :author_email_address => :title, :parent_id => :parent_id } }
+        should_support_on_duplicate_key_update
+        should_update_fields_mentioned_with_hash_mappings
+      end
+    end
+
+  end
+
+  describe "#import with :synchronization option" do
+    let(:topics){ Array.new }
+    let(:values){ [ [topics.first.id, "Jerry Carter"], [topics.last.id, "Chad Fowler"] ]}
+    let(:columns){ %W(id author_name) }
+
+    setup do
+      topics << Topic.create!(:title=>"LDAP", :author_name=>"Big Bird")
+      topics << Topic.create!(:title=>"Rails Recipes", :author_name=>"Elmo")
+    end
+
+    it "synchronizes passed in ActiveRecord model instances with the data just imported" do
+      columns2update = [ 'author_name' ]
+
+      expected_count = Topic.count
+      Topic.import( columns, values,
+        :validate=>false,
+        :on_duplicate_key_update=>columns2update,
+        :synchronize=>topics )
+
+      assert_equal expected_count, Topic.count, "no new records should have been created!"
+      assert_equal "Jerry Carter",  topics.first.author_name, "wrong author!"
+      assert_equal "Chad Fowler", topics.last.author_name, "wrong author!"
+    end
+  end
+
+end