adapter_extensions 0.9.5 → 1.0.0.rc1

data/test/abstract_adapter_test.rb

@@ -1,18 +1,24 @@
 require File.dirname(__FILE__) + '/test_helper'
 
+require 'adapter_extensions/base'
+require 'adapter_extensions/adapters/abstract_adapter'
+
 class AbstractAdapterTest < Test::Unit::TestCase
   include ActiveRecord::ConnectionAdapters
-  class MyAdapter < AbstractAdapter
+
+  class MyAdapter
+    include AdapterExtensions::AbstractAdapter    
+    
     attr_accessor :query
-    def initialize
-      super(nil)
-    end
+
     def tables
       ['people']
     end
+
     def execute(query)
       @query = query
     end
+
   end
   
   attr_accessor :adapter

data/test/config/database.yml

@@ -0,0 +1,15 @@
+mysql2:
+  adapter: mysql2
+  database: adapter_extensions_test
+  username: root
+  encoding: utf8
+  local_infile: true
+mysql:
+  adapter: mysql
+  database: adapter_extensions_test
+  username: root
+  encoding: utf8
+postgresql:
+  adapter: postgresql
+  database: adapter_extensions_test
+  username: postgres

data/test/config/gemfiles/.gitignore

@@ -0,0 +1 @@
+*.lock

data/test/config/gemfiles/Gemfile.rails-3.0.x

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/common'
+
+declare_gems '3.0.11'

data/test/config/gemfiles/Gemfile.rails-3.1.x

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/common'
+
+declare_gems '3.1.3'

data/test/config/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/common'
+
+declare_gems '3.2.1'

data/test/config/gemfiles/common.rb

@@ -0,0 +1,22 @@
+def declare_gems(activerecord_version)
+  source :rubygems
+
+  gem 'activerecord', activerecord_version
+
+  if activerecord_version < '3.1'
+    gem 'mysql2', '< 0.3'
+  else
+    # use our own fork for bulk load support until issue fixed:
+    # https://github.com/brianmario/mysql2/pull/242
+    gem 'mysql2', :git => 'https://github.com/activewarehouse/mysql2.git'
+  end
+
+  gem 'mysql'
+
+  gem 'pg'
+  gem 'activerecord-sqlserver-adapter'
+
+  gem 'awesome_print'
+  gem 'rake'
+  gem 'flexmock'
+end

data/test/integration/adapter_test.rb

@@ -2,14 +2,27 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 # Integration tests
 class AdapterTest < Test::Unit::TestCase
-  
-  require File.dirname(__FILE__) + "/#{ENV['DB']}_tests"
-  include "#{ENV['DB'].capitalize}Tests".constantize
+
+  # quick hack to load adapter-specific tests - TODO: refactor
+  # this also allows to run the same tests for mysql and mysql2
+  adapter_tests = ENV['DB']
+  raise "Missing DB environment variable" unless adapter_tests
+  adapter_tests = 'mysql' if adapter_tests == 'mysql2'
+  require File.dirname(__FILE__) + "/#{adapter_tests}_tests"
+  include "#{adapter_tests.capitalize}Tests".constantize
+  # end of hack
+
+  def setup
+    raise "Missing required DB environment variable" unless ENV['DB']
+    configs = YAML.load_file(File.dirname(__FILE__)+ '/../config/database.yml')
+    raise "Configuration #{ENV['DB']} not in database.yml!" unless configs[ENV['DB']]
+    ActiveRecord::Base.configurations = configs
+    ActiveRecord::Base.establish_connection(ENV['DB'])
+  end
 
   def select_value(query)
-    value = connection.select_value(query)
-    value = Integer(value) if ENV['DB'] =~ /postgresql/
-    value
+    # mysql and postgresql will return a string, while mysql2 will return an integer here - smooth things out
+    Integer(connection.select_value(query))
   end
   
   def test_add_select_into_table
@@ -74,6 +87,9 @@ class AdapterTest < Test::Unit::TestCase
   end
   
   def test_bulk_load_interprets_empty_strings_as_nulls
+    # known issue with mysql - test only on other dbs
+    return if ENV['DB'] =~ /mysql/
+
     connection.truncate('people')
     options = {:fields => {:delimited_by => ',', :null_string => ''}}
     connection.bulk_load(File.join(File.dirname(__FILE__), 'people_with_empties.csv'), 'people', options)
@@ -96,7 +112,7 @@ class AdapterTest < Test::Unit::TestCase
     when 'sqlserver', 'postgresql'
       assert_equal 'SELECT foo INTO new_table FROM bar',
       connection.add_select_into_table(new_table_name, sql_query)
-    when 'mysql'
+    when /mysql/
       assert_equal 'CREATE TABLE new_table SELECT foo FROM bar',
       connection.add_select_into_table(new_table_name, sql_query)
     else

data/test/test_helper.rb

@@ -1,11 +1,10 @@
 $:.unshift(File.dirname(__FILE__))
 
 require 'test/unit'
-require 'rubygems'
 require 'flexmock/test_unit'
 require 'pp'
+require 'ap'
 
+require 'active_record'
 require File.dirname(__FILE__) + '/../lib/adapter_extensions'
-
-db = ENV['DB'] ||= 'mysql'
-require "connection/#{db}/connection"
+require 'adapter_extensions'

data/test/unit/sqlserver_test_ignored.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class SqlServerTest < Test::Unit::TestCase
+
+  def adapter
+    @adapter ||= begin
+      adapter = Object.new
+      adapter.extend(AdapterExtensions::AbstractAdapter)
+      adapter.extend(AdapterExtensions::SQLServerAdapter)
+      adapter
+    end
+  end
+
+  def prepare_mocks
+    flexmock(File).should_receive(:exist?).with("the_file").and_return(true).once
+    flexmock(adapter).should_receive(:tables).and_return(['the_table']).once
+    flexmock(ActiveRecord::Base).should_receive(:configurations).and_return(
+      'fake_env' => {
+        'database' => 'the_database',
+        'host' => 'the_host',
+        'username' => 'the_username',
+        'password' => 'the_password'
+      }
+    )
+  end
+
+  def bulk_load(options)
+    options = {:env => 'fake_env'}.merge(options)
+    adapter.bulk_load("the_file", "the_table", options)
+  end
+
+  def assert_bulk_command(pattern, options = {})
+    prepare_mocks
+    command_result = options.delete(:command_successful)
+    command_result = true if command_result.nil?
+    flexmock(Kernel).should_receive(:system).with(pattern).and_return(command_result)
+    bulk_load(options)
+  end
+
+  def test_freebcp_by_default
+    assert_bulk_command(/^freebcp/)
+  end
+
+  def test_custom_bin_can_be_specified
+    assert_bulk_command(/^bcp /, :bin => 'bcp')
+  end
+
+  def test_command
+    assert_bulk_command(/ "the_database\.dbo\.the_table" in "the_file" /)
+  end
+
+  def test_host
+    assert_bulk_command(/ \-S "the_host" /)
+  end
+
+  def test_user
+    assert_bulk_command(/ \-U "the_username" /)
+  end
+
+  def test_password
+    assert_bulk_command(/ \-P "the_password" /)
+  end
+
+  def test_character_format
+    assert_bulk_command(/ \-c /)
+  end
+
+  def test_delimited_by
+    assert_bulk_command(/ \-t "," /, :fields => { :delimited_by => ',' })
+  end
+
+  def test_max_errors
+    assert_bulk_command(/ \-m 1/, :max_errors => 1)
+  end
+
+  def test_failed_command_must_raise
+    exception = assert_raise(RuntimeError) do
+      assert_bulk_command(//, :command_successful => false)
+    end
+    assert_equal "bulk load failed!", exception.message
+  end
+
+  def test_unsupported_columns_option
+    assert_raise(NotImplementedError) do
+      assert_bulk_command(//, :columns => %w(id first_name last_name))
+    end
+  end
+
+end

metadata

@@ -1,82 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: adapter_extensions
-version: !ruby/object:Gem::Version 
-  hash: 49
-  prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 5
-  version: 0.9.5
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - Anthony Eden
-- "Thibaut Barr\xC3\xA8re"
+- Thibaut Barrère
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70258975563120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 57
-        segments: 
-        - 0
-        - 8
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.8.3
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70258975563120
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70258975562380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70258975562380
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70258975561480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70258975561480
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: &70258975560780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70258975560780
+- !ruby/object:Gem::Dependency
+  name: cartesian
+  requirement: &70258975559900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70258975559900
 description: Provides various extensions to the Rails ActiveRecord adapters.
-email: 
+email:
 - thibaut.barrere@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - HOW_TO_RELEASE
@@ -85,16 +84,26 @@ files:
 - Rakefile
 - adapter_extensions.gemspec
 - lib/adapter_extensions.rb
-- lib/adapter_extensions/connection_adapters/abstract_adapter.rb
-- lib/adapter_extensions/connection_adapters/mysql_adapter.rb
-- lib/adapter_extensions/connection_adapters/postgresql_adapter.rb
-- lib/adapter_extensions/connection_adapters/sqlserver_adapter.rb
+- lib/adapter_extensions/active_record/adapters/abstract_adapter.rb
+- lib/adapter_extensions/active_record/adapters/mysql2_adapter.rb
+- lib/adapter_extensions/active_record/adapters/mysql_adapter.rb
+- lib/adapter_extensions/active_record/adapters/postgresql_adapter.rb
+- lib/adapter_extensions/active_record/adapters/sqlserver_adapter.rb
+- lib/adapter_extensions/adapters/abstract_adapter.rb
+- lib/adapter_extensions/adapters/mysql_adapter.rb
+- lib/adapter_extensions/adapters/postgresql_adapter.rb
+- lib/adapter_extensions/adapters/sqlserver_adapter.rb
+- lib/adapter_extensions/base.rb
 - lib/adapter_extensions/version.rb
 - test/abstract_adapter_test.rb
-- test/connection/mysql/connection.rb
-- test/connection/mysql/setup.sql
-- test/connection/postgresql/connection.rb
-- test/connection/postgresql/setup.sql
+- test/config/database.yml
+- test/config/databases/mysql_setup.sql
+- test/config/databases/postgresql_setup.sql
+- test/config/gemfiles/.gitignore
+- test/config/gemfiles/Gemfile.rails-3.0.x
+- test/config/gemfiles/Gemfile.rails-3.1.x
+- test/config/gemfiles/Gemfile.rails-3.2.x
+- test/config/gemfiles/common.rb
 - test/integration/adapter_test.rb
 - test/integration/empty.csv
 - test/integration/mysql_tests.rb
@@ -103,40 +112,29 @@ files:
 - test/integration/people_with_empties.csv
 - test/integration/postgresql_tests.rb
 - test/test_helper.rb
+- test/unit/sqlserver_test_ignored.rb
 homepage: https://github.com/activewarehouse/adapter_extensions
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: activewarehouse
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Extensions to Rails ActiveRecord adapters.
 test_files: []
-

data/lib/adapter_extensions/connection_adapters/abstract_adapter.rb

@@ -1,50 +0,0 @@
-# This source file contains extensions to the abstract adapter.
-module ActiveRecord #:nodoc:
-  module ConnectionAdapters #:nodoc:
-    # Extensions to the AbstractAdapter. In some cases a default implementation
-    # is provided, in others it is adapter-dependent and the method will
-    # raise a NotImplementedError if the adapter does not implement that method
-    class AbstractAdapter
-      # Truncate the specified table - allow to pass an optional string
-      # to let the called add extra parameters like RESET IDENTITY for pg
-      def truncate(table_name, options=nil)
-        statement = [
-          'TRUNCATE TABLE',
-          table_name,
-          options
-        ].compact.join(' ')
-        execute(statement)
-      end
-      
-      # Bulk loading interface. Load the data from the specified file into the
-      # given table. Note that options will be adapter-dependent.
-      def bulk_load(file, table_name, options={})
-        raise ArgumentError, "#{file} does not exist" unless File.exist?(file)
-        raise ArgumentError, "#{table_name} does not exist" unless tables.include?(table_name)
-        do_bulk_load(file, table_name, options)
-      end
-      
-      # SQL select into statement constructs a new table from the results
-      # of a select. It is used to select data from a table and create a new
-      # table with its result set at the same time.  Note that this method
-      # name does not necessarily match the implementation.  E.g. MySQL's
-      # version of this is 'CREATE TABLE ... AS SELECT ...'
-      def support_select_into_table?
-        false
-      end
-      
-      # Add a chunk of SQL to the given query that will create a new table and
-      # execute the select into that table.
-      def add_select_into_table(new_table_name, sql_query)
-        raise NotImplementedError, "add_select_into_table is an abstract method"
-      end
-      
-      protected
-      
-      # for subclasses to implement
-      def do_bulk_load(file, table_name, options={})
-        raise NotImplementedError, "do_bulk_load is an abstract method"
-      end
-    end
-  end
-end

data/lib/adapter_extensions/connection_adapters/mysql_adapter.rb

@@ -1,90 +0,0 @@
-# lots of folks doing something like this now - take a look for other good ideas
-# https://github.com/jsuchal/activerecord-fast-import/blob/master/lib/activerecord-fast-import.rb
-# https://github.com/EmmanuelOga/load_data_infile/blob/master/lib/load_data_infile.rb
-
-# Source code for the MysqlAdapter extensions.
-module ActiveRecord #:nodoc:
-  module ConnectionAdapters #:nodoc:
-    # Adds new functionality to ActiveRecord MysqlAdapter.
-    class MysqlAdapter < AbstractAdapter
-    
-      def support_select_into_table?
-        true
-      end
-      
-      # Inserts an INTO table_name clause to the sql_query.
-      def add_select_into_table(new_table_name, sql_query)
-        "CREATE TABLE #{new_table_name} " + sql_query
-      end
-      
-      # Copy the specified table.
-      def copy_table(old_table_name, new_table_name)
-        transaction do
-          execute "CREATE TABLE #{new_table_name} LIKE #{old_table_name}"
-          execute "INSERT INTO #{new_table_name} SELECT * FROM #{old_table_name}"
-        end
-      end
-
-      def disable_keys(table)
-        execute("ALTER TABLE #{table} DISABLE KEYS")
-      end
-
-      def enable_keys(table)
-        execute("ALTER TABLE #{table} ENABLE KEYS")
-      end
-
-      def with_keys_disabled(table)
-        disable_keys(table)
-        yield
-      ensure
-        enable_keys(table)
-      end      
-    
-      protected
-      # Call +bulk_load+, as that method wraps this method.
-      # 
-      # Bulk load the data in the specified file. This implementation always uses the LOCAL keyword
-      # so the file must be found locally, not on the remote server, to be loaded.
-      #
-      # Options:
-      # * <tt>:ignore</tt> -- Ignore the specified number of lines from the source file
-      # * <tt>:columns</tt> -- Array of column names defining the source file column order
-      # * <tt>:fields</tt> -- Hash of options for fields:
-      # * <tt>:delimited_by</tt> -- The field delimiter
-      # * <tt>:enclosed_by</tt> -- The field enclosure
-      # * <tt>:replace</tt> -- Add in REPLACE to LOAD DATA INFILE command
-      # * <tt>:disable_keys</tt> -- if set to true, disable keys, loads, then enables again
-      def do_bulk_load(file, table_name, options={})
-        return if File.size(file) == 0
-
-        # an unfortunate hack - setting the bulk load option after the connection has been 
-        # established does not seem to have any effect, and since the connection is made when 
-        # active-record is loaded, there's no chance for us to sneak it in earlier. So we 
-        # disconnect, set the option, then reconnect - fortunately, this only needs to happen once.
-        unless @bulk_load_enabled
-          disconnect!
-          @connection.options(Mysql::OPT_LOCAL_INFILE, true)
-          connect
-          @bulk_load_enabled = true
-        end
-
-        q = "LOAD DATA LOCAL INFILE '#{file}' #{options[:replace] ? 'REPLACE' : ''} INTO TABLE #{table_name}"
-        if options[:fields]
-          q << " FIELDS"
-          q << " TERMINATED BY '#{options[:fields][:delimited_by]}'" if options[:fields][:delimited_by]
-          q << " ENCLOSED BY '#{options[:fields][:enclosed_by]}'" if options[:fields][:enclosed_by]
-        end
-        q << " IGNORE #{options[:ignore]} LINES" if options[:ignore]
-        q << " (#{options[:columns].map { |c| quote_column_name(c.to_s) }.join(',')})" if options[:columns]
-
-        if options[:disable_keys]
-          with_keys_disabled(table_name) { execute(q) }
-        else
-          execute(q)
-        end
-        
-      end
-      
-    end
-  end
-end

data/lib/adapter_extensions/connection_adapters/postgresql_adapter.rb

@@ -1,52 +0,0 @@
-# Source code for the PostgreSQLAdapter extensions.
-module ActiveRecord #:nodoc:
-  module ConnectionAdapters #:nodoc:
-    # Adds new functionality to ActiveRecord PostgreSQLAdapter.
-    class PostgreSQLAdapter < AbstractAdapter
-      def support_select_into_table?
-        true
-      end
-      
-      # Inserts an INTO table_name clause to the sql_query.
-      def add_select_into_table(new_table_name, sql_query)
-        sql_query.sub(/FROM/i, "INTO #{new_table_name} FROM")
-      end
-      
-      # Copy the specified table.
-      def copy_table(old_table_name, new_table_name)
-        execute add_select_into_table(new_table_name, "SELECT * FROM #{old_table_name}")
-      end
-    
-      protected
-      # Call +bulk_load+, as that method wraps this method.
-      # 
-      # Bulk load the data in the specified file.
-      #
-      # Options:
-      # * <tt>:ignore</tt> -- Ignore the specified number of lines from the source file. In the case of PostgreSQL
-      #   only the first line will be ignored from the source file regardless of the number of lines specified.
-      # * <tt>:columns</tt> -- Array of column names defining the source file column order
-      # * <tt>:fields</tt> -- Hash of options for fields:
-      # * <tt>:delimited_by</tt> -- The field delimiter
-      # * <tt>:null_string</tt> -- The string that should be interpreted as NULL (in addition to \N)
-      # * <tt>:enclosed_by</tt> -- The field enclosure
-      def do_bulk_load(file, table_name, options={})
-        q = "COPY #{table_name} "
-        q << "(#{options[:columns].join(',')}) " if options[:columns]
-        q << "FROM '#{File.expand_path(file)}' "
-        if options[:fields]
-          q << "WITH "
-          q << "DELIMITER '#{options[:fields][:delimited_by]}' " if options[:fields][:delimited_by]
-          q << "NULL '#{options[:fields][:null_string]}'" if options[:fields][:null_string]
-          if options[:fields][:enclosed_by] || options[:ignore] && options[:ignore] > 0
-            q << "CSV "
-            q << "HEADER " if options[:ignore] && options[:ignore] > 0
-            q << "QUOTE '#{options[:fields][:enclosed_by]}' " if options[:fields][:enclosed_by]
-          end
-        end
-        
-        execute(q)
-      end
-    end
-  end
-end