activerecord-jdbc-adapter 1.0.3-java → 50.1-java

data/lib/arjdbc/jdbc/adapter_require.rb

@@ -0,0 +1,46 @@
+module ActiveRecord
+
+  if defined? ConnectionAdapters::ConnectionSpecification::Resolver # 4.0
+    ConnectionAdapters::ConnectionSpecification::Resolver
+  elsif defined? Base::ConnectionSpecification::Resolver # 3.2
+    Base::ConnectionSpecification::Resolver
+  else class << Base; self; end # 2.3, 3.0, 3.1 :
+    # def self.establish_connection ... on ActiveRecord::Base
+  end.class_eval do
+
+    # @private
+    def require(path)
+      # NOTE: we're inspecting resolver.spec connection resolution which does :
+      # `require "active_record/connection_adapters/#{spec[:adapter]}_adapter"`
+      # ...
+      # this {#require} method is only re-defined on a Resolver object and thus
+      # will not hurt performance - it will only be called for a few times (most
+      # likely once), this should still be fine for AR < 3.2 where this patch
+      # ends up on `class << ActiveRecord::Base` since models usually rely on
+      # Rails's auto-loading of (missing) constants and rarely use `require`.
+      #
+      # other alternative (to make sure we do not need to eager load AR built-in
+      #  adapters) would be to mingle with the $LOAD_PATH which seems worse ...
+      case path
+      when 'active_record/connection_adapters/mysql_adapter'
+        $LOADED_FEATURES << 'active_record/connection_adapters/mysql_adapter.rb'
+        super('arjdbc/mysql')
+      when 'active_record/connection_adapters/mysql2_adapter'
+        $LOADED_FEATURES << 'active_record/connection_adapters/mysql2_adapter.rb'
+        super('arjdbc/mysql')
+      when 'active_record/connection_adapters/postgresql_adapter'
+        $LOADED_FEATURES << 'active_record/connection_adapters/postgresql_adapter.rb'
+        super('arjdbc/postgresql')
+      when 'active_record/connection_adapters/sqlite_adapter'
+        $LOADED_FEATURES << 'active_record/connection_adapters/sqlite_adapter.rb'
+        super('arjdbc/sqlite3')
+      when 'active_record/connection_adapters/sqlite3_adapter'
+        $LOADED_FEATURES << 'active_record/connection_adapters/sqlite3_adapter.rb'
+        super('arjdbc/sqlite3')
+      else super
+      end
+    end
+
+  end
+
+end

data/lib/arjdbc/jdbc/base_ext.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  class << Base
+    m = Module.new do
+      # Allow adapters to provide their own {#reset_column_information} method.
+      # @note This only affects the current thread's connection.
+      def reset_column_information # :nodoc:
+        # invoke the adapter-specific reset_column_information method
+        connection.reset_column_information if connection.respond_to?(:reset_column_information)
+        super
+      end
+    end
+
+    self.prepend(m)
+  end
+end

data/lib/arjdbc/jdbc/callbacks.rb

@@ -1,20 +1,21 @@
-module ActiveRecord
-  module ConnectionAdapters
-    module JdbcConnectionPoolCallbacks
+module ActiveRecord::ConnectionAdapters
+  module Jdbc
+    # ActiveRecord connection pool callbacks for JDBC.
+    # @see ActiveRecord::ConnectionAdapters::Jdbc::JndiConnectionPoolCallbacks
+    module ConnectionPoolCallbacks
+
       def self.included(base)
-        if base.respond_to?(:set_callback) # Rails 3 callbacks
-          base.set_callback :checkin, :after, :on_checkin
-          base.set_callback :checkout, :before, :on_checkout
-        else
-          base.checkin :on_checkin
-          base.checkout :on_checkout
+        base.set_callback :checkin, :after, :on_checkin
+        base.set_callback :checkout, :before, :on_checkout
+        base.class_eval do
+          def self.new(*args)
+            adapter = super # extend with JndiConnectionPoolCallbacks if a JNDI connection :
+            Jdbc::JndiConnectionPoolCallbacks.prepare(adapter, adapter.instance_variable_get(:@connection))
+            adapter
+          end
         end
       end
 
-      def self.needed?
-        ActiveRecord::Base.respond_to?(:connection_pool)
-      end
-
       def on_checkin
         # default implementation does nothing
       end
@@ -22,13 +23,16 @@ module ActiveRecord
       def on_checkout
         # default implementation does nothing
       end
-    end
 
+    end
+    # JNDI specific connection pool callbacks that make sure the JNDI connection
+    # is disconnected on check-in and looked up (re-connected) on-checkout.
     module JndiConnectionPoolCallbacks
-      def self.prepare(adapter, conn)
-        if ActiveRecord::Base.respond_to?(:connection_pool) && conn.jndi_connection?
-          adapter.extend self
-          conn.disconnect! # disconnect initial connection in JdbcConnection#initialize
+
+      def self.prepare(adapter, connection)
+        if adapter.is_a?(ConnectionPoolCallbacks) && connection.jndi?
+          adapter.extend self # extend JndiConnectionPoolCallbacks
+          connection.disconnect! # if connection.open? - close initial (JNDI) connection
         end
       end
 
@@ -40,5 +44,10 @@ module ActiveRecord
         reconnect!
       end
     end
+
   end
+  # @deprecated use {ActiveRecord::ConnectionAdapters::Jdbc::ConnectionPoolCallbacks}
+  JdbcConnectionPoolCallbacks = Jdbc::ConnectionPoolCallbacks
+  # @deprecated use {ActiveRecord::ConnectionAdapters::Jdbc::JndiConnectionPoolCallbacks}
+  JndiConnectionPoolCallbacks = Jdbc::JndiConnectionPoolCallbacks
 end

data/lib/arjdbc/jdbc/column.rb

@@ -1,38 +1,97 @@
 module ActiveRecord
   module ConnectionAdapters
+    module Jdbc
+      autoload :TypeCast, 'arjdbc/jdbc/type_cast'
+    end
+    # The base class for all of {JdbcAdapter}'s returned columns.
+    # Instances of {JdbcColumn} will get extended with "column-spec" modules
+    # (similar to how {JdbcAdapter} gets spec modules in) if the adapter spec
+    # module provided a `column_selector` (matcher) method for it's database
+    # specific type.
+    # @see JdbcAdapter#jdbc_column_class
     class JdbcColumn < Column
-      attr_writer :limit, :precision
+      # @deprecated attribute writers will be removed in 1.4
+      attr_writer :limit, :precision # unless ArJdbc::AR42
+
+      def initialize(config, name, *args)
+        if self.class == JdbcColumn
+          # NOTE: extending classes do not want this if they do they shall call
+          call_discovered_column_callbacks(config) if config
+          default = args.shift
+        else # for extending classes allow ignoring first argument :
+          if ! config.nil? && ! config.is_a?(Hash)
+            default = name; name = config # initialize(name, default, *args)
+          else
+            default = args.shift
+          end
+        end
 
-      def initialize(config, name, default, *args)
-        call_discovered_column_callbacks(config)
-        super(name,default_value(default),*args)
+        if ArJdbc::AR50
+          default = args[0].cast(default)
+
+          sql_type = args.delete_at(1)
+          type = args.delete_at(0)
+
+          args.unshift(SqlTypeMetadata.new(:sql_type => sql_type, :type => type))
+        elsif ArJdbc::AR42
+          default = args[0].type_cast_from_database(default)
+        else
+          default = default_value(default)
+        end
+
+        # super <= 4.1: (name, default, sql_type = nil, null = true)
+        # super >= 4.2: (name, default, cast_type, sql_type = nil, null = true)
+        # super >= 5.0: (name, default, sql_type_metadata = nil, null = true)
+        
+        super(name, default, *args)
         init_column(name, default, *args)
       end
 
-      def init_column(*args)
-      end
+      # Additional column initialization for sub-classes.
+      def init_column(*args); end
+
+      # Similar to `ActiveRecord`'s `extract_value_from_default(default)`.
+      # @return default value for a column (possibly extracted from driver value)
+      def default_value(value); value; end
 
-      def default_value(val)
-        val
+      protected
+
+      # @private
+      def call_discovered_column_callbacks(config)
+        dialect = (config[:dialect] || config[:driver]).to_s
+        for matcher, block in self.class.column_types
+          block.call(config, self) if matcher === dialect
+        end
       end
 
+      public
+
+      # Returns the available column types
+      # @return [Hash] of (matcher, block) pairs
       def self.column_types
-        @column_types ||= ::ArJdbc.constants.map{|c|
-          ::ArJdbc.const_get c }.select{ |c|
-          c.respond_to? :column_selector }.map{|c|
-          c.column_selector }.inject({}) { |h,val|
-          h[val[0]] = val[1]; h }
+        types = {}
+        for mod in ::ArJdbc.modules
+          if mod.respond_to?(:column_selector)
+            sel = mod.column_selector # [ matcher, block ]
+            types[ sel[0] ] = sel[1]
+          end
+        end
+        types
       end
 
-      protected
-      def call_discovered_column_callbacks(config)
-        dialect = config[:dialect] || config[:driver]
-        for reg, func in JdbcColumn.column_types
-          if reg === dialect.to_s
-            func.call(config,self)
-          end
+      class << self
+
+        include Jdbc::TypeCast if ::ActiveRecord::VERSION::STRING >= '4.2'
+
+        if ActiveRecord::VERSION::MAJOR > 3 && ActiveRecord::VERSION::STRING < '4.2'
+
+          # @private provides compatibility between AR 3.x/4.0 API
+          def string_to_date(value); value_to_date(value) end
+
         end
+
       end
+
     end
   end
 end

data/lib/arjdbc/jdbc/connection.rb

@@ -1,128 +1,14 @@
 module ActiveRecord
   module ConnectionAdapters
+    # JDBC (connection) base class, custom adapters we support likely extend
+    # this class. For maximum performance most of this class and the sub-classes
+    # we ship are implemented in Java, check: *RubyJdbcConnection.java*
     class JdbcConnection
-      module ConfigHelper
-        attr_reader :config
 
-        def config=(config)
-          @config = config.symbolize_keys!
-        end
-
-        def configure_connection
-          config[:retry_count] ||= 5
-          config[:connection_alive_sql] ||= "select 1"
-          @jndi_connection = false
-          @connection = nil
-          if config[:jndi]
-            begin
-              configure_jndi
-            rescue => e
-              warn "JNDI data source unavailable: #{e.message}; trying straight JDBC"
-              configure_jdbc
-            end
-          else
-            configure_jdbc
-          end
-        end
-
-        def configure_jndi
-          jndi = config[:jndi].to_s
-          ctx = javax.naming.InitialContext.new
-          ds = ctx.lookup(jndi)
-          @connection_factory = JdbcConnectionFactory.impl do
-            ds.connection
-          end
-          unless config[:driver]
-            config[:driver] = connection.meta_data.connection.java_class.name
-          end
-          @jndi_connection = true
-        end
-
-        def configure_url
-          url = config[:url].to_s
-          if Hash === config[:options]
-            options = ''
-            config[:options].each do |k,v|
-              options << '&' unless options.empty?
-              options << "#{k}=#{v}"
-            end
-            url = url['?'] ? "#{url}&#{options}" : "#{url}?#{options}" unless options.empty?
-            config[:url] = url
-            config[:options] = nil
-          end
-          url
-        end
-
-        def configure_jdbc
-          unless config[:driver] && config[:url]
-            raise ::ActiveRecord::ConnectionNotEstablished, "jdbc adapter requires driver class and url"
-          end
-
-          driver = config[:driver].to_s
-          user   = config[:username].to_s
-          pass   = config[:password].to_s
-          url    = configure_url
-
-          jdbc_driver = JdbcDriver.new(driver)
-          jdbc_driver.load
-          @connection_factory = JdbcConnectionFactory.impl do
-            jdbc_driver.connection(url, user, pass)
-          end
-        end
-      end
-
-      attr_reader :adapter, :connection_factory
-
-      # @native_database_types - setup properly by adapter= versus set_native_database_types.
-      #   This contains type information for the adapter.  Individual adapters can make tweaks
-      #   by defined modify_types
-      #
-      # @native_types - This is the default type settings sans any modifications by the
-      # individual adapter.  My guess is that if we loaded two adapters of different types
-      # then this is used as a base to be tweaked by each adapter to create @native_database_types
-
-      def initialize(config)
-        self.config = config
-        configure_connection
-        connection # force the connection to load
-        set_native_database_types
-        @stmts = {}
-      rescue ::ActiveRecord::ActiveRecordError
-        raise
-      rescue Exception => e
-        raise "The driver encountered an unknown error: #{e}"
-      end
-
-      def adapter=(adapter)
-        @adapter = adapter
-        @native_database_types = dup_native_types
-        @adapter.modify_types(@native_database_types)
-      end
-
-      # Duplicate all native types into new hash structure so it can be modified
-      # without destroying original structure.
-      def dup_native_types
-        types = {}
-        @native_types.each_pair do |k, v|
-          types[k] = v.inject({}) do |memo, kv|
-            memo[kv.first] = begin kv.last.dup rescue kv.last end
-            memo
-          end
-        end
-        types
-      end
-      private :dup_native_types
-
-      def jndi_connection?
-        @jndi_connection
-      end
-
-      def active?
-        @connection
+      def native_database_types
+        JdbcTypeConverter.new(supported_data_types).choose_best_types
       end
 
-      private
-      include ConfigHelper
     end
   end
 end

data/lib/arjdbc/jdbc/connection_methods.rb

@@ -1,16 +1,44 @@
-class ActiveRecord::Base
-  class << self
+module ArJdbc
+  ConnectionMethods = ::ActiveRecord::ConnectionHandling
+
+  ConnectionMethods.module_eval do
+
     def jdbc_connection(config)
       adapter_class = config[:adapter_class]
       adapter_class ||= ::ActiveRecord::ConnectionAdapters::JdbcAdapter
-      adapter_class.new(nil, logger, config)
+
+      # Once all adapters converted to AR5 then this rescue can be removed
+      begin
+        adapter_class.new(nil, logger, nil, config)
+      rescue ArgumentError
+        adapter_class.new(nil, logger, config)
+      end
     end
-    alias jndi_connection jdbc_connection
+
+    def jndi_connection(config); jdbc_connection(config) end
 
     def embedded_driver(config)
       config[:username] ||= "sa"
       config[:password] ||= ""
       jdbc_connection(config)
     end
+
+    private
+
+    def jndi_config?(config)
+      ::ActiveRecord::ConnectionAdapters::JdbcConnection.jndi_config?(config)
+    end
+
+    # @note keeps the same Hash when possible - helps caching on native side
+    def symbolize_keys_if_necessary(hash)
+      symbolize = false
+      hash.each_key do |key|
+        if ! key.is_a?(Symbol) && key.respond_to?(:to_sym)
+          symbolize = true; break
+        end
+      end
+      symbolize ? hash.symbolize_keys : hash
+    end
+
   end
 end

data/lib/arjdbc/jdbc/error.rb

@@ -0,0 +1,65 @@
+module ActiveRecord
+  # Represents exceptions that have propagated up through the JDBC API.
+  class JDBCError < WrappedDatabaseException
+
+    def initialize(message = nil, cause = $!)
+      super( ( message.nil? && cause ) ? cause.message : message, nil )
+      if cause.is_a? Java::JavaSql::SQLException
+        @jdbc_exception, @cause = cause, nil
+      else
+        @cause, @jdbc_exception = cause, nil
+      end
+    end
+
+    # The DB (or JDBC driver implementation specific) vendor error code.
+    # @see #jdbc_exception
+    # @return [Integer, NilClass]
+    def error_code
+      if ( @error_code ||= nil ).nil?
+        @error_code = jdbc_exception ? jdbc_exception.getErrorCode : nil
+      else
+        @error_code
+      end
+    end
+    # @deprecated
+    # @see #error_code
+    def errno; error_code end
+
+    # SQL code as standardized by ISO/ANSI and Open Group (X/Open), although
+    # some codes have been reserved for DB vendors to define for themselves.
+    # @see #jdbc_exception
+    # @return [String, NilClass]
+    def sql_state; jdbc_exception ? jdbc_exception.getSQLState : nil end
+
+    # The full Java exception (SQLException) object that was raised (if any).
+    # @note Navigate through chained exceptions using `jdbc_exception.next_exception`.
+    def jdbc_exception; @jdbc_exception end
+    alias_method :sql_exception, :jdbc_exception
+
+    # true if the current error might be recovered e.g. by re-trying the transaction
+    def recoverable?; jdbc_exception.is_a?(Java::JavaSql::SQLRecoverableException) end
+    # true when a failed operation might be able to succeed when retried (e.g. timeouts)
+    def transient?; jdbc_exception.is_a?(Java::JavaSql::SQLTransientException) end
+
+    # Likely (but not necessarily) the same as {#jdbc_exception}.
+    def cause; ( @cause ||= nil ) || jdbc_exception end
+    # @override
+    # @private for correct super-class (StatementInvalid) compatibility
+    alias_method :original_exception, :cause
+
+    # @override
+    def set_backtrace(backtrace)
+      @raw_backtrace = backtrace
+      if ( nested = cause ) && ! nested.equal?(self)
+        backtrace = backtrace - ( nested.respond_to?(:raw_backtrace) ? nested.raw_backtrace : nested.backtrace )
+        backtrace << "#{nested.backtrace.first}: #{nested.message} (#{nested.class.name})"
+        backtrace.concat nested.backtrace[1..-1] || []
+      end
+      super(backtrace)
+    end
+
+    # @private
+    def raw_backtrace; @raw_backtrace ||= backtrace end
+
+  end
+end