ruby-oci8 2.1.8-x86-mingw32 → 2.2.0-x86-mingw32

data/lib/oci8/check_load_error.rb

@@ -0,0 +1,99 @@
+# This file is loaded only on LoadError.
+
+class OCI8
+  module Util
+
+    case RUBY_PLATFORM
+    when /mswin32|cygwin|mingw32|bccwin32/
+
+      require 'Win32API'
+      MAX_PATH = 260
+      GetModuleFileNameA = Win32API.new('kernel32', 'GetModuleFileNameA', 'PPL', 'L')
+      GetSystemDirectoryA = Win32API.new('kernel32', 'GetSystemDirectoryA', 'PL', 'L')
+      GetWindowsDirectoryA = Win32API.new('kernel32', 'GetWindowsDirectoryA', 'PL', 'L')
+
+      def self.check_os_specific_load_error(exc)
+        case exc.message
+        when /^193: / # "193: %1 is not a valid Win32 application." in English
+          check_win32_pe_arch(exc.message.split(' - ')[1], "ruby-oci8")
+          dll_load_path_list.each do |path|
+            check_win32_pe_arch(File.join(path, '\OCI.DLL'), "Oracle client")
+          end
+        end
+      end # self.check_os_specific_load_error
+
+      def self.dll_load_path_list
+        buf = "\0" * MAX_PATH
+        paths = []
+        paths << buf[0, GetModuleFileNameA.call(nil, buf, MAX_PATH)].force_encoding("locale").gsub(/\\[^\\]*$/, '')
+        paths << buf[0, GetSystemDirectoryA.call(buf, MAX_PATH)].force_encoding("locale")
+        paths << buf[0, GetWindowsDirectoryA.call(buf, MAX_PATH)].force_encoding("locale")
+        paths << "."
+        paths + ENV['PATH'].split(';')
+      end # self.dll_load_path_list
+
+      def self.check_win32_pe_arch(filename, package)
+        open(filename, 'rb') do |f|
+          # DOS header.
+          if f.read(2) == 'MZ'
+            f.seek(60, IO::SEEK_SET)
+            pe_offset = f.read(4).unpack('V')[0]
+            f.seek(pe_offset)
+            # PE header.
+            if f.read(4) == "PE\000\000"
+              case f.read(2).unpack('v')[0]
+              when 0x8664
+                if [nil].pack('P').size == 4
+                  raise LoadError, "\"#{filename}\" is x64 DLL. Use 32-bit #{package} instead."
+                end
+                return true
+              when 0x014c
+                if [nil].pack('P').size == 8
+                  raise LoadError, "\"#{filename}\" is 32-bit DLL. Use x64 #{package} instead."
+                end
+                return true
+              end
+            end
+          end
+          raise LoadError, "\"#{filename}\" is not a valid Win32 application."
+        end
+        nil
+      rescue
+        nil
+      end # self.check_win32_pe_arch
+
+    when /linux/
+
+      def self.check_os_specific_load_error(exc)
+        case exc.message
+        when /^libaio\.so\.1:/ # "libaio.so.1: cannot open shared object file: No such file or directory" in English
+          install_cmd = if File.executable? '/usr/bin/apt-get'
+                          'apt-get install libaio1'
+                        elsif File.executable? '/usr/bin/yum'
+                          'yum install libaio'
+                        end
+          if install_cmd
+            raise LoadError, "You need to install libaio.so.1. Run '#{install_cmd}'."
+          else
+            raise LoadError, "You need to install libaio.so.1."
+          end
+        end
+      end # self.check_os_specific_load_error
+
+    else
+
+      def self.check_os_specific_load_error(exc)
+      end
+
+    end # case RUBY_PLATFORM
+
+    def self.check_load_error(exc)
+      check_os_specific_load_error(exc)
+      case exc.message
+      when /^OCI Library Initialization Error/
+        # TODO
+      end
+    end
+
+  end # module Util
+end

data/lib/oci8/encoding-init.rb

@@ -5,75 +5,41 @@
 #
 class OCI8
 
-  # get the environment variable NLS_LANG.
-  nls_lang = ENV['NLS_LANG']
+  @@client_charset_name = charset_id2name(@@environment_handle.send(:attr_get_ub2, 31))
+  # 31 is OCI_ATTR_ENV_CHARSET_ID.
 
-  if nls_lang.is_a? String and nls_lang.length == 0
-    nls_lang = nil
-  end
-
-  # if NLS_LANG is not set, get it from the Windows registry.
-  if nls_lang.nil? and defined? OCI8::Win32Util
-    dll_path = OCI8::Win32Util.dll_path.upcase
-    if dll_path =~ %r{\\BIN\\OCI.DLL}
-      oracle_home = $`
-      OCI8::Win32Util.enum_homes do |home, lang|
-        if oracle_home == home.upcase
-          nls_lang = lang
-          break
+  if @@client_charset_name == 'US7ASCII'
+    # Check whether US7ASCII is explicitly set by NLS_LANG or not.
+    nls_lang = ENV['NLS_LANG']
+    if nls_lang.nil? and defined? OCI8::Win32Util
+      if OCI8::Util::dll_path =~ /\\BIN\\OCI\.DLL$/i
+        oracle_home = $`
+        OCI8::Win32Util.enum_homes do |home, lang|
+          if oracle_home == home.upcase
+            nls_lang = lang
+            break
+          end
         end
       end
     end
-  end
-
-  # extract the charset name.
-  if nls_lang
-    if nls_lang =~ /\.([[:alnum:]]+)$/
-      @@client_charset_name = $1.upcase
-    else
-      raise "Invalid NLS_LANG format: #{nls_lang}"
+    if nls_lang.nil?
+      warn "Warning: NLS_LANG is not set. fallback to US7ASCII."
     end
-  else
-    warn "Warning: NLS_LANG is not set. fallback to US7ASCII."
-    # @private
-    @@client_charset_name = 'US7ASCII'
   end
 
-  # Ruby encoding name for ruby 1.9.
-  if OCI8.respond_to? :encoding
-    if defined? DEFAULT_OCI8_ENCODING
-      enc = DEFAULT_OCI8_ENCODING
-    else
-      require 'yaml'
-      enc = YAML::load_file(File.dirname(__FILE__) + '/encoding.yml')[@@client_charset_name]
-      if enc.nil?
-        raise "Ruby encoding name is not found in encoding.yml for NLS_LANG #{nls_lang}."
-      end
-      if enc.is_a? Array
-        # Use the first available encoding in the array.
-        enc = enc.find do |e| Encoding.find(e) rescue false; end
-      end
-    end
-    OCI8.encoding = enc
+  if defined? DEFAULT_OCI8_ENCODING
+    enc = DEFAULT_OCI8_ENCODING
   else
-    # NLS ratio, maximum number of bytes per one chracter
-    case @@client_charset_name
-    when 'UTF8'
-      OCI8.nls_ratio = 3
-    when 'AL16UTF16'
-      OCI8.nls_ratio = 4
-    when /^[[:alpha:]]+(\d+)/
-      # convert maximum number of bits per one chracter to NLS ratio.
-      #   charset name  max bits  max bytes
-      #   ------------  --------  ---------
-      #   US7ASCII          7         1
-      #   WE8ISO8859P1      8         1
-      #   JA16SJIS         16         2
-      #   AL32UTF8         32         4
-      #   ...
-      OCI8.nls_ratio = (($1.to_i + 7) >> 3)
-    else
-      raise "Unknown NLS character set name format: #{@@client_charset_name}"
+    require 'yaml'
+    yaml_file = File.dirname(__FILE__) + '/encoding.yml'
+    enc = YAML::load_file(yaml_file)[@@client_charset_name]
+    if enc.nil?
+      raise "Cannot convert Oracle charset name #{@@client_charset_name} to Ruby encoding name in #{yaml_file}."
+    end
+    if enc.is_a? Array
+      # Use the first available encoding in the array.
+      enc = enc.find do |e| Encoding.find(e) rescue false; end
     end
   end
+  OCI8.encoding = enc
 end

data/lib/oci8/metadata.rb

@@ -996,20 +996,14 @@ class OCI8
         __charset_form
       end
 
-      if OCI8.oracle_client_version >= ORAVER_9_0
-        # The fractional seconds precision of a datetime or interval.
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def fsprecision
-          attr_get_ub1(OCI_ATTR_FSPRECISION)
-        end
+      # The fractional seconds precision of a datetime or interval.
+      def fsprecision
+        attr_get_ub1(OCI_ATTR_FSPRECISION)
+      end
 
-        # The leading field precision of an interval
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def lfprecision
-          attr_get_ub1(OCI_ATTR_LFPRECISION)
-        end
+      # The leading field precision of an interval
+      def lfprecision
+        attr_get_ub1(OCI_ATTR_LFPRECISION)
       end
 
       # character set name if the type attribute is of a string/character type.
@@ -1339,30 +1333,18 @@ class OCI8
 
       ## Table 6-13 Attributes Belonging to Columns of Tables or Views
 
-      if OCI8.oracle_client_version >= ORAVER_9_0
-        # returns the type of length semantics of the column.
-        # [<tt>:byte</tt>]  byte-length semantics
-        # [<tt>:char</tt>]  character-length semantics.
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def char_used?
-          attr_get_ub1(OCI_ATTR_CHAR_USED) != 0
-        end
-
-        # returns the column character length which is the number of
-        # characters allowed in the column. It is the counterpart of
-        # OCI8::Metadata::Column#data_size which gets the byte length.
-        def char_size
-          attr_get_ub2(OCI_ATTR_CHAR_SIZE)
-        end
-      else
-        def char_used?
-          false
-        end
+      # returns the type of length semantics of the column.
+      # [<tt>:byte</tt>]  byte-length semantics
+      # [<tt>:char</tt>]  character-length semantics.
+      def char_used?
+        attr_get_ub1(OCI_ATTR_CHAR_USED) != 0
+      end
 
-        def char_size
-          data_size
-        end
+      # returns the column character length which is the number of
+      # characters allowed in the column. It is the counterpart of
+      # OCI8::Metadata::Column#data_size which gets the byte length.
+      def char_size
+        attr_get_ub2(OCI_ATTR_CHAR_SIZE)
       end
 
       # The maximum size of the column. This length is
@@ -1445,20 +1427,14 @@ class OCI8
       ## Table 6-8 Attributes Belonging to Type Attributes
       ## But Column also have these.
 
-      if OCI8.oracle_client_version >= ORAVER_9_0
-        # The fractional seconds precision of a datetime or interval.
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def fsprecision
-          attr_get_ub1(OCI_ATTR_FSPRECISION)
-        end
+      # The fractional seconds precision of a datetime or interval.
+      def fsprecision
+        attr_get_ub1(OCI_ATTR_FSPRECISION)
+      end
 
-        # The leading field precision of an interval
-        #
-        # (unavailable on Oracle 8.1 or lower)
-        def lfprecision
-          attr_get_ub1(OCI_ATTR_LFPRECISION)
-        end
+      # The leading field precision of an interval
+      def lfprecision
+        attr_get_ub1(OCI_ATTR_LFPRECISION)
       end
 
       # The character set name, if the column is of a string/character type
@@ -1677,14 +1653,8 @@ class OCI8
 
       ## Table 6-15 List Attributes
 
-      if OCI8::oracle_client_version < OCI8::ORAVER_8_1
-        def ltype
-          raise "This feature is unavailable on Oracle 8.0"
-        end
-      else
-        def ltype
-          attr_get_ub2(OCI_ATTR_LTYPE)
-        end
+      def ltype
+        attr_get_ub2(OCI_ATTR_LTYPE)
       end
 
       # convert to array

data/lib/oci8/oci8.rb

@@ -1,6 +1,6 @@
 # oci8.rb -- OCI8
 #
-# Copyright (C) 2002-2013 Kubo Takehiro <kubo@jiubao.org>
+# Copyright (C) 2002-2015 Kubo Takehiro <kubo@jiubao.org>
 #
 # Original Copyright is:
 #   Oracle module for Ruby
@@ -140,10 +140,12 @@ class OCI8
       @session_handle.send(:attr_set_string, OCI_ATTR_USERNAME, username) if username
       @session_handle.send(:attr_set_string, OCI_ATTR_PASSWORD, password) if password
       if @@oracle_client_version >= ORAVER_11_1
-        # 'rubyoci8' is displayed in V$SESSION_CONNECT_INFO.CLIENT_DRIVER
+        # Sets the driver name displayed in V$SESSION_CONNECT_INFO.CLIENT_DRIVER
         # if both the client and the server are Oracle 11g or upper.
+        # Only the first 8 chracters "ruby-oci" are displayed when the Oracle
+        # server version is lower than 12.0.1.2.
         # 424: OCI_ATTR_DRIVER_NAME
-        @session_handle.send(:attr_set_string, 424, 'rubyoci8')
+        @session_handle.send(:attr_set_string, 424, "ruby-oci8 : #{OCI8::VERSION}")
       end
       server_attach(dbname, attach_mode)
       session_begin(cred ? cred : OCI_CRED_RDBMS, mode ? mode : OCI_DEFAULT)
@@ -157,7 +159,7 @@ class OCI8
       attr_set_ub4(176, stmt_cache_size) # 176: OCI_ATTR_STMTCACHESIZE
     end
 
-    @prefetch_rows = nil
+    @prefetch_rows = 100
     @username = nil
   end
 
@@ -329,12 +331,12 @@ class OCI8
     end
   end
 
-  # Sets the prefetch rows size. The default value is one.
+  # Sets the prefetch rows size. The default value is 100.
   # When a select statement is executed, the OCI library allocate
   # prefetch buffer to reduce the number of network round trips by
   # retrieving specified number of rows in one round trip.
   #
-  # Note: Active record adaptors set 100 by default.
+  # Note: The default value had been 1 before ruby-oci8 2.2.0.
   def prefetch_rows=(num)
     @prefetch_rows = num
   end
@@ -531,19 +533,16 @@ class OraDate
     Date.new(year, month, day)
   end
 
-  if defined? DateTime # ruby 1.8.0 or upper
-
-    # timezone offset of the time the command started
-    # @private
-    @@tz_offset = Time.now.utc_offset.to_r/86400
+  # timezone offset of the time the command started
+  # @private
+  @@tz_offset = Time.now.utc_offset.to_r/86400
 
-    # Returns a DateTime object which denotes self.
-    #
-    # Note that this is not daylight saving time aware.
-    # The Time zone offset is that of the time the command started.
-    def to_datetime
-      DateTime.new(year, month, day, hour, minute, second, @@tz_offset)
-    end
+  # Returns a DateTime object which denotes self.
+  #
+  # Note that this is not daylight saving time aware.
+  # The Time zone offset is that of the time the command started.
+  def to_datetime
+    DateTime.new(year, month, day, hour, minute, second, @@tz_offset)
   end
 
   # @private

data/lib/oci8/properties.rb

@@ -15,10 +15,6 @@ class OCI8
     :cancel_read_at_exit => false,
   }
 
-  if OCI8.oracle_client_version < OCI8::ORAVER_9_2
-    @@properties[:statement_cache_size] = nil
-  end
-
   # @private
   def @@properties.[](name)
     raise IndexError, "No such property name: #{name}" unless @@properties.has_key?(name)
@@ -45,9 +41,6 @@ class OCI8
         raise ArgumentError, "float_conversion_type's value should be either :ruby or :oracle."
       end
     when :statement_cache_size
-      if OCI8.oracle_client_version < OCI8::ORAVER_9_2
-        raise RuntimeError, ":statement_cache_size is disabled on Oracle 9iR1 client."
-      end
       val = val.to_i
       raise ArgumentError, "The property value for :statement_cache_size must not be negative." if val < 0
     when :events_mode
@@ -101,7 +94,7 @@ class OCI8
   #     From ruby 1.9.2, a float value converted from Oracle number 15.7 by
   #     the Oracle function OCINumberToReal() makes a string representation
   #     15.700000000000001 by Float#to_s.
-  #     See: http://rubyforge.org/forum/forum.php?thread_id=50030&forum_id=1078
+  #     See: https://web.archive.org/web/20140521195004/https://rubyforge.org/forum/forum.php?thread_id=50030&forum_id=1078
   #     
   #     *Since:* 2.1.0
   #
@@ -109,7 +102,6 @@ class OCI8
   #     
   #     The statement cache size per each session. The default size is 0, which
   #     means no statement cache, since 2.1.2. It was 20 in 2.1.1.
-  #     This feature is available on Oracle 9iR2 or later.
   #     See: http://docs.oracle.com/cd/E11882_01/appdev.112/e10646/oci09adv.htm#i471377
   #     
   #     *Since:* 2.1.1

data/lib/oci8/version.rb

@@ -0,0 +1,3 @@
+class OCI8
+  VERSION = "2.2.0"
+end

data/ruby-oci8.gemspec

@@ -14,13 +14,23 @@ else
   gem_platform = Gem::Platform::RUBY
 end
 
+if defined? OCI8
+  oci8_version = OCI8::VERSION
+else
+  # Load oci8/version.rb temporarily and delete OCI8.
+  # Some 'bundler' tasks load this file before 'require "oci8"'
+  # and fail with 'TypeError: superclass mismatch for class OCI8.'
+  Kernel.load File.dirname(__FILE__) + '/lib/oci8/version.rb'
+  oci8_version = OCI8::VERSION
+  Object.send(:remove_const, :OCI8)
+end
+
 spec = Gem::Specification.new do |s|
   s.name = 'ruby-oci8'
-  s.version = File.read('VERSION').strip
+  s.version = oci8_version
   s.summary = 'Ruby interface for Oracle using OCI8 API'
   s.email = 'kubo@jiubao.org'
   s.homepage = 'https://github.com/kubo/ruby-oci8/'
-  s.rubyforge_project = 'ruby-oci8'
   s.description = <<EOS
 ruby-oci8 is a ruby interface for Oracle using OCI8 API. It is available with Oracle8i, Oracle9i, Oracle10g, Oracle11g and Oracle Instant Client.
 EOS