activerecord-oracle_enhanced-adapter 1.7.3 → 1.8.0

data/lib/active_record/connection_adapters/oracle_enhanced/jdbc_connection.rb

@@ -2,27 +2,26 @@ begin
   require "java"
   require "jruby"
 
-  # ojdbc7.jar, ojdbc6.jar or ojdbc5.jar file should be in application ./lib directory or in load path or in ENV['PATH']
+  # ojdbc7.jar or ojdbc6.jar file should be in application ./lib directory or in load path or in ENV['PATH']
 
   java_version = java.lang.System.getProperty("java.version")
-  ojdbc_jars = if java_version =~ /^1.5/
-    %w(ojdbc5.jar)
-  elsif java_version =~ /^1.6/
-    %w(ojdbc6.jar)
-  elsif java_version >= '1.7'
-    # Oracle 11g client ojdbc6.jar is also compatible with Java 1.7
-    # Oracle 12c client provides new ojdbc7.jar
-    %w(ojdbc7.jar ojdbc6.jar)
-  else
-    nil
+  # Dropping Java SE 6(1.6) or older version without deprecation cycle.
+  # Rails 5.0 already requires CRuby 2.2.2 or higher and JRuby 9.0 supporging CRuby 2.2 requires Java SE 7.
+  if java_version < "1.7"
+    raise "ERROR: Java SE 6 or older version is not supported. Upgrade Java version to Java SE 7 or higher"
   end
 
-  if ojdbc_jars && ENV_JAVA['java.class.path'] !~ Regexp.new(ojdbc_jars.join('|'))
+  # Oracle 11g client ojdbc6.jar is also compatible with Java 1.7
+  # Oracle 12c Release 1 client provides ojdbc7.jar
+  # Oracle 12c Release 2 client provides ojdbc8.jar
+  ojdbc_jars = %w(ojdbc8.jar ojdbc7.jar ojdbc6.jar)
+
+  if ENV_JAVA["java.class.path"] !~ Regexp.new(ojdbc_jars.join("|"))
     # On Unix environment variable should be PATH, on Windows it is sometimes Path
-    env_path = (ENV["PATH"] || ENV["Path"] || '').split(File::PATH_SEPARATOR)
+    env_path = (ENV["PATH"] || ENV["Path"] || "").split(File::PATH_SEPARATOR)
     # Look for JDBC driver at first in lib subdirectory (application specific JDBC file version)
     # then in Ruby load path and finally in environment PATH
-    ['./lib'].concat($LOAD_PATH).concat(env_path).detect do |dir|
+    ["./lib"].concat($LOAD_PATH).concat(env_path).detect do |dir|
       # check any compatible JDBC driver in the priority order
       ojdbc_jars.any? do |ojdbc_jar|
         if File.exists?(file_path = File.join(dir, ojdbc_jar))
@@ -43,16 +42,13 @@ begin
 
 rescue LoadError, NameError
   # JDBC driver is unavailable.
-  raise LoadError, "ERROR: ActiveRecord oracle_enhanced adapter could not load Oracle JDBC driver. Please install #{ojdbc_jars ? ojdbc_jars.join(' or ') : "Oracle JDBC"} library."
+  raise LoadError, "ERROR: ActiveRecord oracle_enhanced adapter could not load Oracle JDBC driver. Please install #{ojdbc_jars.join(' or ') } library."
 end
 
-
 module ActiveRecord
   module ConnectionAdapters
-
     # JDBC database interface for JRuby
     class OracleEnhancedJDBCConnection < OracleEnhancedConnection #:nodoc:
-
       attr_accessor :active
       alias :active? :active
 
@@ -77,7 +73,7 @@ module ActiveRecord
 
           # tomcat needs first lookup method, oc4j (and maybe other application servers) need second method
           begin
-            env = ctx.lookup('java:/comp/env')
+            env = ctx.lookup("java:/comp/env")
             ds = env.lookup(jndi)
           rescue
             ds = ctx.lookup(jndi)
@@ -105,12 +101,13 @@ module ActiveRecord
           # to_s needed if username, password or database is specified as number in database.yml file
           username = config[:username] && config[:username].to_s
           password = config[:password] && config[:password].to_s
-          database = config[:database] && config[:database].to_s || 'XE'
+          database = config[:database] && config[:database].to_s || "XE"
           host, port = config[:host], config[:port]
           privilege = config[:privilege] && config[:privilege].to_s
 
-          # connection using TNS alias
-          if database && !host && !config[:url] && ENV['TNS_ADMIN']
+          # connection using TNS alias, or connection-string from DATABASE_URL
+          using_tns_alias = !host && !config[:url] && ENV["TNS_ADMIN"]
+          if database && (using_tns_alias || host == "connection-string")
             url = "jdbc:oracle:thin:@#{database}"
           else
             unless database.match(/^(\:|\/)/)
@@ -122,7 +119,7 @@ module ActiveRecord
 
           prefetch_rows = config[:prefetch_rows] || 100
           # get session time_zone from configuration or from TZ environment variable
-          time_zone = config[:time_zone] || ENV['TZ'] || java.util.TimeZone.default.getID
+          time_zone = config[:time_zone] || ENV["TZ"] || java.util.TimeZone.default.getID
 
           properties = java.util.Properties.new
           properties.put("user", username)
@@ -140,13 +137,17 @@ module ActiveRecord
           end
 
           # Set session time zone to current time zone
-          @raw_connection.setSessionTimeZone(time_zone)
+          if ActiveRecord::Base.default_timezone == :local
+            @raw_connection.setSessionTimeZone(time_zone)
+          elsif ActiveRecord::Base.default_timezone == :utc
+            @raw_connection.setSessionTimeZone("UTC")
+          end
 
           # Set default number of rows to prefetch
           # @raw_connection.setDefaultRowPrefetch(prefetch_rows) if prefetch_rows
         end
 
-        cursor_sharing = config[:cursor_sharing] || 'force'
+        cursor_sharing = config[:cursor_sharing] || "force"
         exec "alter session set cursor_sharing = #{cursor_sharing}"
 
         # Initialize NLS parameters
@@ -329,7 +330,7 @@ module ActiveRecord
           @raw_statement = raw_statement
         end
 
-        def bind_params( *bind_vars )
+        def bind_params(*bind_vars)
           index = 1
           bind_vars.flatten.each do |var|
             if Hash === var
@@ -341,17 +342,7 @@ module ActiveRecord
           end
         end
 
-        def bind_param(position, value, column = nil)
-          if column
-            ActiveSupport::Deprecation.warn(<<-MSG.squish)
-              *******************************************************
-              Passing a column to `bind_param` will be deprecated.
-              `type_casted_binds` should be already type casted
-              so that `bind_param` should not need to know column.
-              *******************************************************
-            MSG
-          end
-
+        def bind_param(position, value)
           case value
           when Integer
             @raw_statement.setLong(position, value)
@@ -375,17 +366,13 @@ module ActiveRecord
           when Java::JavaSql::Timestamp
             @raw_statement.setTimestamp(position, value)
           when Time
-            # TODO: Really needed or not
-            @raw_statement.setTimestamp(position, value)
+            new_value = Java::java.sql.Timestamp.new(value.year - 1900, value.month - 1, value.day, value.hour, value.min, value.sec, value.usec * 1000)
+            @raw_statement.setTimestamp(position, new_value)
           when NilClass
-            if column && column.object_type?
-              @raw_statement.setNull(position, java.sql.Types::STRUCT, column.sql_type)
-            else
-              # TODO: currently nil is always bound as NULL with VARCHAR type.
-              # When nils will actually be used by ActiveRecord as bound parameters
-              # then need to pass actual column type.
-              @raw_statement.setNull(position, java.sql.Types::VARCHAR)
-            end
+            # TODO: currently nil is always bound as NULL with VARCHAR type.
+            # When nils will actually be used by ActiveRecord as bound parameters
+            # then need to pass actual column type.
+            @raw_statement.setNull(position, java.sql.Types::VARCHAR)
           else
             raise ArgumentError, "Don't know how to bind variable with type #{value.class}"
           end
@@ -413,21 +400,21 @@ module ActiveRecord
         end
 
         def column_types
-          @column_types ||= (1..metadata.getColumnCount).map{|i| metadata.getColumnTypeName(i).to_sym}
+          @column_types ||= (1..metadata.getColumnCount).map { |i| metadata.getColumnTypeName(i).to_sym }
         end
 
         def column_names
-          @column_names ||= (1..metadata.getColumnCount).map{|i| metadata.getColumnName(i)}
+          @column_names ||= (1..metadata.getColumnCount).map { |i| metadata.getColumnName(i) }
         end
         alias :get_col_names :column_names
 
-        def fetch(options={})
+        def fetch(options = {})
           if @raw_result_set.next
             get_lob_value = options[:get_lob_value]
             row_values = []
             column_types.each_with_index do |column_type, i|
               row_values <<
-                @connection.get_ruby_value_from_result_set(@raw_result_set, i+1, column_type, get_lob_value)
+                @connection.get_ruby_value_from_result_set(@raw_result_set, i + 1, column_type, get_lob_value)
             end
             row_values
           else
@@ -451,7 +438,6 @@ module ActiveRecord
         def close
           @raw_statement.close
         end
-
       end
 
       def select(sql, name = nil, return_column_names = false)
@@ -472,14 +458,14 @@ module ActiveRecord
 
         cols_types_index = (1..column_count).map do |i|
           col_name = oracle_downcase(metadata.getColumnName(i))
-          next if col_name == 'raw_rnum_'
+          next if col_name == "raw_rnum_"
           column_hash[col_name] = nil
           [col_name, metadata.getColumnTypeName(i).to_sym, i]
         end
         cols_types_index.delete(nil)
 
         rows = []
-        get_lob_value = !(name == 'Writable Large Object')
+        get_lob_value = !(name == "Writable Large Object")
 
         while rset.next
           hash = column_hash.dup
@@ -499,7 +485,7 @@ module ActiveRecord
         if is_binary
           lob.setBytes(1, value.to_java_bytes)
         else
-          lob.setString(1,value)
+          lob.setString(1, value)
         end
       end
 
@@ -524,17 +510,15 @@ module ActiveRecord
           else
             BigDecimal.new(d.stringValue)
           end
+        when :BINARY_FLOAT
+          rset.getFloat(i)
         when :VARCHAR2, :CHAR, :LONG, :NVARCHAR2, :NCHAR
           rset.getString(i)
         when :DATE
           if dt = rset.getDATE(i)
             d = dt.dateValue
             t = dt.timeValue
-            if OracleEnhancedAdapter.emulate_dates && t.hours == 0 && t.minutes == 0 && t.seconds == 0
-              Date.new(d.year + 1900, d.month + 1, d.date)
-            else
-              Time.send(Base.default_timezone, d.year + 1900, d.month + 1, d.date, t.hours, t.minutes, t.seconds)
-            end
+            Time.send(Base.default_timezone, d.year + 1900, d.month + 1, d.date, t.hours, t.minutes, t.seconds)
           else
             nil
           end
@@ -548,7 +532,7 @@ module ActiveRecord
           get_lob_value ? lob_to_ruby_value(rset.getBlob(i)) : rset.getBlob(i)
         when :RAW
           raw_value = rset.getRAW(i)
-          raw_value && raw_value.getBytes.to_a.pack('C*')
+          raw_value && raw_value.getBytes.to_a.pack("C*")
         else
           nil
         end
@@ -556,24 +540,22 @@ module ActiveRecord
 
       private
 
-      def lob_to_ruby_value(val)
-        case val
-        when ::Java::OracleSql::CLOB
-          if val.isEmptyLob
-            nil
-          else
-            val.getSubString(1, val.length)
-          end
-        when ::Java::OracleSql::BLOB
-          if val.isEmptyLob
-            nil
-          else
-            String.from_java_bytes(val.getBytes(1, val.length))
+        def lob_to_ruby_value(val)
+          case val
+          when ::Java::OracleSql::CLOB
+            if val.isEmptyLob
+              nil
+            else
+              val.getSubString(1, val.length)
+            end
+          when ::Java::OracleSql::BLOB
+            if val.isEmptyLob
+              nil
+            else
+              String.from_java_bytes(val.getBytes(1, val.length))
+            end
           end
         end
-      end
-
     end
-
   end
 end

data/lib/active_record/connection_adapters/oracle_enhanced/jdbc_quoting.rb

@@ -12,10 +12,6 @@ module ActiveRecord
             clob = Java::OracleSql::CLOB.createTemporary(@connection.raw_connection, false, Java::OracleSql::CLOB::DURATION_SESSION)
             clob.setString(1, value.to_s)
             clob
-          when Date, DateTime
-            Java::oracle.sql.DATE.new(value.strftime("%Y-%m-%d %H:%M:%S"))
-          when Time
-            Java::java.sql.Timestamp.new(value.year-1900, value.month-1, value.day, value.hour, value.min, value.sec, value.usec * 1000)
           else
             super
           end

data/lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb

@@ -1,4 +1,4 @@
-require 'delegate'
+require "delegate"
 
 begin
   require "oci8"
@@ -11,17 +11,15 @@ end
 
 # check ruby-oci8 version
 required_oci8_version = [2, 2, 0]
-oci8_version_ints = OCI8::VERSION.scan(/\d+/).map{|s| s.to_i}
+oci8_version_ints = OCI8::VERSION.scan(/\d+/).map { |s| s.to_i }
 if (oci8_version_ints <=> required_oci8_version) < 0
   raise LoadError, "ERROR: ruby-oci8 version #{OCI8::VERSION} is too old. Please install ruby-oci8 version #{required_oci8_version.join('.')} or later."
 end
 
 module ActiveRecord
   module ConnectionAdapters
-
     # OCI database interface for MRI
     class OracleEnhancedOCIConnection < OracleEnhancedConnection #:nodoc:
-
       def initialize(config)
         @raw_connection = OCI8EnhancedAutoRecover.new(config, OracleEnhancedOCIFactory)
         # default schema owner
@@ -100,9 +98,9 @@ module ActiveRecord
       # and return :insert_id value
       def exec_with_returning(sql)
         cursor = @raw_connection.parse(sql)
-        cursor.bind_param(':insert_id', nil, Integer)
+        cursor.bind_param(":insert_id", nil, Integer)
         cursor.exec
-        cursor[':insert_id']
+        cursor[":insert_id"]
       ensure
         cursor.close rescue nil
       end
@@ -117,7 +115,7 @@ module ActiveRecord
           @raw_cursor = raw_cursor
         end
 
-        def bind_params( *bind_vars )
+        def bind_params(*bind_vars)
           index = 1
           bind_vars.flatten.each do |var|
             if Hash === var
@@ -129,30 +127,16 @@ module ActiveRecord
           end
         end
 
-        def bind_param(position, value, column = nil)
-          if column
-            ActiveSupport::Deprecation.warn(<<-MSG.squish)
-              *******************************************************
-              Passing a column to `bind_param` will be deprecated.
-              `type_casted_binds` should be already type casted
-              so that `bind_param` should not need to know column.
-              *******************************************************
-            MSG
-          end
-
-          if column && column.object_type?
-            @raw_cursor.bind_param(position, value, :named_type, column.sql_type)
+        def bind_param(position, value)
+          case value
+          when ActiveRecord::OracleEnhanced::Type::Raw
+            @raw_cursor.bind_param(position, ActiveRecord::ConnectionAdapters::OracleEnhanced::Quoting.encode_raw(value))
+          when ActiveModel::Type::Decimal
+            @raw_cursor.bind_param(position, BigDecimal.new(value.to_s))
+          when NilClass
+            @raw_cursor.bind_param(position, nil, String)
           else
-            case value
-            when ActiveRecord::OracleEnhanced::Type::Raw
-              @raw_cursor.bind_param(position, ActiveRecord::ConnectionAdapters::OracleEnhanced::Quoting.encode_raw(value))
-            when ActiveModel::Type::Decimal
-              @raw_cursor.bind_param(position, BigDecimal.new(value.to_s))
-            when NilClass
-              @raw_cursor.bind_param(position, nil, String)
-            else
-              @raw_cursor.bind_param(position, value)
-            end
+            @raw_cursor.bind_param(position, value)
           end
         end
 
@@ -172,7 +156,7 @@ module ActiveRecord
           @raw_cursor.get_col_names
         end
 
-        def fetch(options={})
+        def fetch(options = {})
           if row = @raw_cursor.fetch
             get_lob_value = options[:get_lob_value]
             row.map do |col|
@@ -188,7 +172,6 @@ module ActiveRecord
         def close
           @raw_cursor.close
         end
-
       end
 
       def select(sql, name = nil, return_column_names = false)
@@ -197,13 +180,13 @@ module ActiveRecord
         # Ignore raw_rnum_ which is used to simulate LIMIT and OFFSET
         cursor.get_col_names.each do |col_name|
           col_name = oracle_downcase(col_name)
-          cols << col_name unless col_name == 'raw_rnum_'
+          cols << col_name unless col_name == "raw_rnum_"
         end
         # Reuse the same hash for all rows
         column_hash = {}
-        cols.each {|c| column_hash[c] = nil}
+        cols.each { |c| column_hash[c] = nil }
         rows = []
-        get_lob_value = !(name == 'Writable Large Object')
+        get_lob_value = !(name == "Writable Large Object")
 
         while row = cursor.fetch
           hash = column_hash.dup
@@ -226,7 +209,7 @@ module ActiveRecord
 
       def describe(name)
         # fall back to SELECT based describe if using database link
-        return super if name.to_s.include?('@')
+        return super if name.to_s.include?("@")
         quoted_name = ActiveRecord::ConnectionAdapters::OracleEnhanced::Quoting.valid_table_name?(name) ? name : "\"#{name}\""
         @raw_connection.describe(quoted_name)
       rescue OCIException => e
@@ -250,12 +233,12 @@ module ActiveRecord
 
       def typecast_result_value(value, get_lob_value)
         case value
-        when Fixnum, Bignum
+        when Integer
           value
         when String
           value
         when Float, BigDecimal
-          # return Fixnum or Bignum if value is integer (to avoid issues with _before_type_cast values for id attributes)
+          # return Integer if value is integer (to avoid issues with _before_type_cast values for id attributes)
           value == (v_to_i = value.to_i) ? v_to_i : value
         when OraNumber
           # change OraNumber value (returned in early versions of ruby-oci8 2.0.x) to BigDecimal
@@ -264,17 +247,13 @@ module ActiveRecord
           if get_lob_value
             data = value.read || ""     # if value.read returns nil, then we have an empty_clob() i.e. an empty string
             # In Ruby 1.9.1 always change encoding to ASCII-8BIT for binaries
-            data.force_encoding('ASCII-8BIT') if data.respond_to?(:force_encoding) && value.is_a?(OCI8::BLOB)
+            data.force_encoding("ASCII-8BIT") if data.respond_to?(:force_encoding) && value.is_a?(OCI8::BLOB)
             data
           else
             value
           end
         when Time, DateTime
-          if OracleEnhancedAdapter.emulate_dates && date_without_time?(value)
-            value.to_date
-          else
-            create_time_with_default_timezone(value)
-          end
+          create_time_with_default_timezone(value)
         else
           value
         end
@@ -286,33 +265,32 @@ module ActiveRecord
 
       private
 
-      def date_without_time?(value)
-        case value
-        when OraDate
-          value.hour == 0 && value.minute == 0 && value.second == 0
-        else
-          value.hour == 0 && value.min == 0 && value.sec == 0
+        def date_without_time?(value)
+          case value
+          when OraDate
+            value.hour == 0 && value.minute == 0 && value.second == 0
+          else
+            value.hour == 0 && value.min == 0 && value.sec == 0
+          end
         end
-      end
 
-      def create_time_with_default_timezone(value)
-        year, month, day, hour, min, sec, usec = case value
-        when Time
-          [value.year, value.month, value.day, value.hour, value.min, value.sec, value.usec]
-        when OraDate
-          [value.year, value.month, value.day, value.hour, value.minute, value.second, 0]
-        else
-          [value.year, value.month, value.day, value.hour, value.min, value.sec, 0]
-        end
-        # code from Time.time_with_datetime_fallback
-        begin
-          Time.send(Base.default_timezone, year, month, day, hour, min, sec, usec)
-        rescue
-          offset = Base.default_timezone.to_sym == :local ? ::DateTime.local_offset : 0
-          ::DateTime.civil(year, month, day, hour, min, sec, offset)
+        def create_time_with_default_timezone(value)
+          year, month, day, hour, min, sec, usec = case value
+                                                   when Time
+                                                     [value.year, value.month, value.day, value.hour, value.min, value.sec, value.usec]
+                                                   when OraDate
+                                                     [value.year, value.month, value.day, value.hour, value.minute, value.second, 0]
+          else
+                                                     [value.year, value.month, value.day, value.hour, value.min, value.sec, 0]
+          end
+          # code from Time.time_with_datetime_fallback
+          begin
+            Time.send(Base.default_timezone, year, month, day, hour, min, sec, usec)
+          rescue
+            offset = Base.default_timezone.to_sym == :local ? ::DateTime.local_offset : 0
+            ::DateTime.civil(year, month, day, hour, min, sec, offset)
+          end
         end
-      end
-
     end
 
     # The OracleEnhancedOCIFactory factors out the code necessary to connect and
@@ -328,13 +306,16 @@ module ActiveRecord
         privilege = config[:privilege] && config[:privilege].to_sym
         async = config[:allow_concurrency]
         prefetch_rows = config[:prefetch_rows] || 100
-        cursor_sharing = config[:cursor_sharing] || 'force'
+        cursor_sharing = config[:cursor_sharing] || "force"
         # get session time_zone from configuration or from TZ environment variable
-        time_zone = config[:time_zone] || ENV['TZ']
+        time_zone = config[:time_zone] || ENV["TZ"]
 
+        # using a connection string via DATABASE_URL
+        connection_string = if host == "connection-string"
+          database
         # connection using host, port and database name
-        connection_string = if host || port
-          host ||= 'localhost'
+        elsif host || port
+          host ||= "localhost"
           host = "[#{host}]" if host =~ /^[^\[].*:/  # IPv6
           port ||= 1521
           database = "/#{database}" unless database.match(/^\//)
@@ -344,7 +325,6 @@ module ActiveRecord
         else
           database
         end
-
         conn = OCI8.new username, password, connection_string, privilege
         conn.autocommit = true
         conn.non_blocking = true if async
@@ -367,20 +347,15 @@ module ActiveRecord
         conn
       end
     end
-
-
   end
 end
 
-
-
 class OCI8 #:nodoc:
-
   def describe(name)
     info = describe_table(name.to_s)
     raise %Q{"DESC #{name}" failed} if info.nil?
-    if info.respond_to? :obj_link and info.obj_link
-      [info.obj_schema, info.obj_name, '@' + info.obj_link]
+    if info.respond_to?(:obj_link) && info.obj_link
+      [info.obj_schema, info.obj_name, "@" + info.obj_link]
     else
       [info.obj_schema, info.obj_name]
     end
@@ -409,7 +384,7 @@ class OCI8EnhancedAutoRecover < DelegateClass(OCI8) #:nodoc:
     @active = true
     @config = config
     @factory = factory
-    @connection  = @factory.new_connection @config
+    @connection = @factory.new_connection @config
     super @connection
   end
 
@@ -461,6 +436,5 @@ class OCI8EnhancedAutoRecover < DelegateClass(OCI8) #:nodoc:
       retry
     end
   end
-
 end
 #:startdoc:

data/lib/active_record/connection_adapters/oracle_enhanced/oci_quoting.rb

@@ -5,16 +5,16 @@ module ActiveRecord
         def _type_cast(value)
           case value
           when ActiveModel::Type::Binary::Data
-            lob_value = value == '' ? ' ' : value
+            lob_value = value == "" ? " " : value
             bind_type = OCI8::BLOB
             ora_value = bind_type.new(@connection.raw_oci_connection, lob_value)
-            ora_value.size = 0 if value == ''
+            ora_value.size = 0 if value == ""
             ora_value
           when ActiveRecord::OracleEnhanced::Type::Text::Data
-            lob_value = value.to_s == '' ? ' ' : value.to_s
+            lob_value = value.to_s == "" ? " " : value.to_s
             bind_type = OCI8::CLOB
             ora_value = bind_type.new(@connection.raw_oci_connection, lob_value)
-            ora_value.size = 0 if value.to_s == ''
+            ora_value.size = 0 if value.to_s == ""
             ora_value
           else
             super