[Rails3] Support all possible ODBC namespaces. Test helpers for specific connection modes. Rakefile updates for rvm tasks that install both odbc and odbc_utf8. Note current rails 3 patches to run tests.

Author: metaskills

RUNNING_UNIT_TESTS

@@ -37,3 +37,11 @@ be able to run "rake test" which will load all the adapter tests followed by the
 core ActiveRecord tests. Lastly, it is typically good practice to do your work 
 on a local branch of our remote tracking branch.
 
+
+= Current Patches
+
+These patches may need to be applied in a local topic branch of whatever stable 
+branch you are testing of rails.
+
+  * 3-0-stable https://rails.lighthouseapp.com/projects/8994/tickets/5333
+

Rakefile

@@ -40,7 +40,7 @@ namespace :rvm do
     'ruby-1.8.6'      => {:alias => 'sqlsvr186', :odbc => '0.99991'},
     'ruby-1.8.7'      => {:alias => 'sqlsvr187', :odbc => '0.99991'},
     'ruby-1.9.1'      => {:alias => 'sqlsvr191', :odbc => '0.99991'},
-    'ruby-1.9.2-rc2'  => {:alias => 'sqlsvr192', :odbc => '0.99992pre3'},
+    'ruby-1.9.2'      => {:alias => 'sqlsvr192', :odbc => '0.99992pre3'},
     'ree-1.8.7'       => {:alias => 'sqlsvrree', :odbc => '0.99991'}
   }
 
@@ -98,11 +98,13 @@ namespace :rvm do
           RVM.run "curl -O http://www.ch-werner.de/rubyodbc/#{odbc}.tar.gz"
           puts "info: RubyODBC extracting clean work directory..."
           RVM.run "tar -xf #{odbc}.tar.gz"
-          RVM.chdir("#{odbc}/ext/utf8") do
-            puts "info: RubyODBC configuring..."
-            RVM.ruby 'extconf.rb', "--with-odbc-dir=#{rvm_odbc_dir}"
-            puts "info: RubyODBC make and installing for #{rvm_current_name}..."
-            RVM.run "make && make install"
+          ['ext','ext/utf8'].each do |extdir|
+            RVM.chdir("#{odbc}/#{extdir}") do
+              puts "info: RubyODBC configuring in #{extdir}..."
+              RVM.ruby 'extconf.rb', "--with-odbc-dir=#{rvm_odbc_dir}"
+              puts "info: RubyODBC make and installing for #{rvm_current_name}..."
+              RVM.run "make && make install"
+            end
           end
         end
       end
@@ -111,7 +113,7 @@ namespace :rvm do
     desc "Install development gems using bundler to each rubie version, installing bundler if not already."
     task :bundle => :setup do
       rvm_each_rubie do
-        rvm_install_gem 'bundler', '1.0.0.rc.3'
+        rvm_install_gem 'bundler', '1.0.0.rc.5'
         RVM.run 'bundle install'
       end
     end

lib/active_record/connection_adapters/sqlserver/core_ext/odbc.rb

@@ -5,28 +5,42 @@ module CoreExt
         module ODBC
 
           module TimeStamp
+            
             def to_sqlserver_string
               date, time, nanoseconds = to_s.split(' ')
               "#{date} #{time}.#{sprintf("%03d",nanoseconds.to_i/1000000)}"
             end
+            
           end
 
           module Statement
+            
             def finished?
               begin
                 connected?
                 false
-              rescue ::ODBC::Error => e
+              rescue *Database.parent_modules_error_exceptions
                 true
               end
             end
+            
           end
 
           module Database
+            
+            def self.parent_modules
+              @parent_module ||= ['ODBC','ODBC_UTF8','ODBC_NONE'].map{ |odbc_ns| odbc_ns.constantize rescue nil }.compact
+            end
+            
+            def self.parent_modules_error_exceptions
+              @parent_modules_error_exceptions ||= parent_modules.map { |odbc_ns| "::#{odbc_ns}::Error".constantize }
+            end
+            
             def run_block(*args)
               yield sth = run(*args)
               sth.drop
             end
+            
           end
 
         end
@@ -35,8 +49,9 @@ def run_block(*args)
   end
 end
 
-
-ODBC::TimeStamp.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::TimeStamp if defined?(ODBC::TimeStamp)
-ODBC::Statement.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::Statement if defined?(ODBC::Statement)
-ODBC::Database.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::Database if defined?(ODBC::Database)
+['ODBC','ODBC_UTF8','ODBC_NONE'].map{ |odbc_ns| odbc_ns.constantize rescue nil }.compact.each do |ns|
+  ns::TimeStamp.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::TimeStamp
+  ns::Statement.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::Statement
+  ns::Database.send :include, ActiveRecord::ConnectionAdapters::Sqlserver::CoreExt::ODBC::Database
+end
 

lib/active_record/connection_adapters/sqlserver/database_statements.rb

@@ -189,8 +189,9 @@ def zip_fields_and_rows(fields, rows)
 
         # === SQLServer Specific (Executing) ============================ #
 
-        def do_execute(sql,name=nil)
-          log(sql, name || 'EXECUTE') do
+        def do_execute(sql, name = nil)
+          name ||= 'EXECUTE'
+          log(sql, name) do
             with_auto_reconnect { raw_connection_do(sql) }
           end
         end
@@ -255,7 +256,7 @@ def handle_to_fields_and_rows_odbc(handle)
           end
           rows = results.inject([]) do |rows,row|
             row.each_with_index do |value, i|
-              if value.is_a? ODBC::TimeStamp
+              if value.is_a? raw_connection.class.parent::TimeStamp
                 row[i] = value.to_sqlserver_string
               end
             end

lib/active_record/connection_adapters/sqlserver/errors.rb

@@ -8,7 +8,7 @@ module Sqlserver
       module Errors
 
         LOST_CONNECTION_EXCEPTIONS  = {
-          :odbc   => ['ODBC::Error'],
+          :odbc   => ['ODBC::Error','ODBC_UTF8::Error','ODBC_NONE::Error'],
           :adonet => ['TypeError','System::Data::SqlClient::SqlException']
         }.freeze
 
@@ -20,7 +20,7 @@ module Errors
 
         def lost_connection_exceptions
           exceptions = LOST_CONNECTION_EXCEPTIONS[connection_mode]
-          @lost_connection_exceptions ||= exceptions ? exceptions.map(&:constantize) : []
+          @lost_connection_exceptions ||= exceptions ? exceptions.map{ |e| e.constantize rescue nil }.compact : []
         end
 
         def lost_connection_messages

lib/active_record/connection_adapters/sqlserver_adapter.rb

@@ -20,9 +20,18 @@ def self.sqlserver_connection(config) #:nodoc:
       mode = config[:mode].to_s.downcase.underscore.to_sym
       case mode
       when :odbc
-        require_library_or_gem 'odbc' unless defined?(ODBC)
-        require 'active_record/connection_adapters/sqlserver/core_ext/odbc'
         raise ArgumentError, 'Missing :dsn configuration.' unless config.has_key?(:dsn)
+        if RUBY_VERSION < '1.9'
+          require_library_or_gem 'odbc'
+        else
+          begin
+            # TODO: [ODBC] Change this to 'odbc_utf8'
+            require_library_or_gem 'odbc'
+          rescue LoadError
+            require_library_or_gem 'odbc'
+          end
+        end unless ['::ODBC','::ODBC_UTF8','::ODBC_NONE'].any? { |odbc_ns| odbc_ns.constantize rescue nil }
+        require 'active_record/connection_adapters/sqlserver/core_ext/odbc'
       when :adonet
         require 'System.Data'
         raise ArgumentError, 'Missing :database configuration.' unless config.has_key?(:database)
@@ -315,7 +324,7 @@ def cs_equality_operator
         @@cs_equality_operator || 'COLLATE Latin1_General_CS_AS_WS ='
       end
 
-            
+      
       protected
 
       # === Abstract Adapter (Misc Support) =========================== #
@@ -339,7 +348,8 @@ def connect
         config = @connection_options
         @connection = case connection_mode
                       when :odbc
-                        ODBC.connect config[:dsn], config[:username], config[:password]
+                        odbc = ['::ODBC','::ODBC_UTF8','::ODBC_NONE'].detect{ |odbc_ns| odbc_ns.constantize rescue nil }.constantize
+                        odbc.connect config[:dsn], config[:username], config[:password]
                       when :adonet
                         System::Data::SqlClient::SqlConnection.new.tap do |connection|
                           connection.connection_string = System::Data::SqlClient::SqlConnectionStringBuilder.new.tap do |cs|

test/cases/connection_test_sqlserver.rb

@@ -12,24 +12,6 @@ def setup
   end
 
 
-  should 'return finished ODBC statment handle from #execute without block' do
-    assert_all_statements_used_are_closed do
-      @connection.execute('SELECT * FROM [topics]')
-    end
-  end
-  
-  should 'finish ODBC statment handle from #execute with block' do
-    assert_all_statements_used_are_closed do
-      @connection.execute('SELECT * FROM [topics]') { }
-    end
-  end
-  
-  should 'finish connection from #raw_select' do
-    assert_all_statements_used_are_closed do
-      @connection.send(:raw_select,'SELECT * FROM [topics]')
-    end
-  end
-  
   should 'affect rows' do
     topic_data = { 1 => { "content" => "1 updated" }, 2 => { "content" => "2 updated" } }
     updated = Topic.update(topic_data.keys, topic_data.values)
@@ -39,38 +21,6 @@ def setup
     assert_equal 2, Topic.delete([1, 2])        
   end
 
-  should 'execute without block closes statement' do
-    assert_all_statements_used_are_closed do
-      @connection.execute("SELECT 1")
-    end
-  end
-  
-  should 'execute with block closes statement' do
-    assert_all_statements_used_are_closed do
-      @connection.execute("SELECT 1") do |sth|
-        assert !sth.finished?, "Statement should still be alive within block"
-      end
-    end
-  end
-  
-  should 'insert with identity closes statement' do
-    assert_all_statements_used_are_closed do
-      @connection.insert("INSERT INTO accounts ([id], [firm_id],[credit_limit]) values (999, 1, 50)")
-    end
-  end
-  
-  should 'insert without identity closes statement' do
-    assert_all_statements_used_are_closed do
-      @connection.insert("INSERT INTO accounts ([firm_id],[credit_limit]) values (1, 50)")
-    end
-  end
-
-  should 'active closes statement' do
-    assert_all_statements_used_are_closed do
-      @connection.active?
-    end
-  end
-  
   should 'allow usage of :database connection option to remove setting from dsn' do
     assert_equal 'activerecord_unittest', @connection.current_database
     begin
@@ -82,6 +32,61 @@ def setup
     end
   end
 
+  context 'ODBC connection management' do
+
+    should 'return finished ODBC statement handle from #execute without block' do
+      assert_all_odbc_statements_used_are_closed do
+        @connection.execute('SELECT * FROM [topics]')
+      end
+    end
+
+    should 'finish ODBC statement handle from #execute with block' do
+      assert_all_odbc_statements_used_are_closed do
+        @connection.execute('SELECT * FROM [topics]') { }
+      end
+    end
+
+    should 'finish connection from #raw_select' do
+      assert_all_odbc_statements_used_are_closed do
+        @connection.send(:raw_select,'SELECT * FROM [topics]')
+      end
+    end
+
+    should 'execute without block closes statement' do
+      assert_all_odbc_statements_used_are_closed do
+        @connection.execute("SELECT 1")
+      end
+    end
+
+    should 'execute with block closes statement' do
+      assert_all_odbc_statements_used_are_closed do
+        @connection.execute("SELECT 1") do |sth|
+          assert !sth.finished?, "Statement should still be alive within block"
+        end
+      end
+    end
+
+    should 'insert with identity closes statement' do
+      assert_all_odbc_statements_used_are_closed do
+        @connection.insert("INSERT INTO accounts ([id], [firm_id],[credit_limit]) values (999, 1, 50)")
+      end
+    end
+
+    should 'insert without identity closes statement' do
+      assert_all_odbc_statements_used_are_closed do
+        @connection.insert("INSERT INTO accounts ([firm_id],[credit_limit]) values (1, 50)")
+      end
+    end
+
+    should 'active closes statement' do
+      assert_all_odbc_statements_used_are_closed do
+        @connection.active?
+      end
+    end
+
+  end if connection_mode_odbc?
+  
+  
   context 'Connection management' do
 
     setup do
@@ -116,21 +121,18 @@ def setup
 
   private
 
-  def assert_all_statements_used_are_closed(&block)
+  def assert_all_odbc_statements_used_are_closed(&block)
+    odbc = @connection.raw_connection.class.parent
     existing_handles = []
-    ObjectSpace.each_object(ODBC::Statement) {|handle| existing_handles << handle}
-    GC.disable
+    ObjectSpace.each_object(odbc::Statement) { |h| existing_handles << h }
+    existing_handle_ids = existing_handles.map(&:object_id)
+    assert existing_handles.all?(&:finished?), "Somewhere before the block some statements were not closed"
+    GC.disable    
     yield
     used_handles = []
-    ObjectSpace.each_object(ODBC::Statement) {|handle| used_handles << handle unless existing_handles.include? handle}
-    assert_block "No statements were used within given block" do
-      used_handles.size > 0
-    end
-    ObjectSpace.each_object(ODBC::Statement) do |handle|
-      assert_block "Statement should have been closed within given block" do
-        handle.finished?
-      end
-    end
+    ObjectSpace.each_object(odbc::Statement) { |h| used_handles << h unless existing_handle_ids.include?(h.object_id) }
+    assert used_handles.size > 0, "No statements were used within given block"
+    assert used_handles.all?(&:finished?), "Statement should have been closed within given block"
   ensure
     GC.enable
   end

test/cases/sqlserver_helper.rb

@@ -91,6 +91,7 @@ def raw_select_with_query_record(sql, name = nil)
 module ActiveRecord 
   class TestCase < ActiveSupport::TestCase
     class << self
+      def connection_mode_odbc? ; ActiveRecord::Base.connection.send(:connection_mode) == :odbc ; end
       def sqlserver_2005? ; ActiveRecord::Base.connection.sqlserver_2005? ; end
       def sqlserver_2008? ; ActiveRecord::Base.connection.sqlserver_2008? ; end
       def ruby_19? ; RUBY_VERSION >= '1.9' ; end
@@ -106,6 +107,7 @@ def assert_sql(*patterns_to_match)
       end
       assert failed_patterns.empty?, "Query pattern(s) #{failed_patterns.map(&:inspect).join(', ')} not found in:\n#{$queries_executed.inspect}"
     end
+    def connection_mode_odbc? ; self.class.connection_mode_odbc? ; end
     def sqlserver_2005? ; self.class.sqlserver_2005? ; end
     def sqlserver_2008? ; self.class.sqlserver_2008? ; end
     def ruby_19? ; self.class.ruby_19? ; end