ruby-oci8 2.2.5.1-x86-mingw32 → 2.2.9-x86-mingw32

data/README.md

@@ -2,7 +2,7 @@ Ruby-oci8
 =========
 
 [![Gem Version](https://badge.fury.io/rb/ruby-oci8.svg)](http://badge.fury.io/rb/ruby-oci8)
-[![Circle CI](https://circleci.com/gh/kubo/ruby-oci8.png?style=shield)](https://circleci.com/gh/kubo/ruby-oci8)
+[![Build Status](https://travis-ci.com/kubo/ruby-oci8.svg?branch=master)](https://travis-ci.com/kubo/ruby-oci8)
 
 What is ruby-oci8
 -----------------

data/dist-files

@@ -80,7 +80,7 @@ lib/oci8/oracle_version.rb
 lib/oci8/properties.rb
 lib/oci8/version.rb
 lib/ruby-oci8.rb
-test/README
+test/README.md
 test/config.rb
 test/setup_test_object.sql
 test/setup_test_package.sql
@@ -109,4 +109,5 @@ test/test_oracle_version.rb
 test/test_oradate.rb
 test/test_oranumber.rb
 test/test_package_type.rb
+test/test_properties.rb
 test/test_rowid.rb

data/docs/install-instant-client.md

@@ -18,7 +18,7 @@ Look at {file:docs/install-on-osx.md} for OS X.
 Install Oracle Instant Client Packages
 --------------------------------------
 
-### Donwload Instant Client Packages
+### Download Instant Client Packages
 
 Download the following packages from [Oracle Technology Network](http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html).
 
@@ -110,6 +110,7 @@ Package" or copy a runtime library to the directory where `ruby.exe` resides.
 
 | Oracle Version | Package | Runtime Library|
 |---|---|---|
+| 18.3     | [Microsoft Visual C++ 2013 Redistributable Package][2013] | MSVCR120.DLL |
 | 12.2.0.x | [Microsoft Visual C++ 2013 Redistributable Package][2013] | MSVCR120.DLL |
 | 12.1.0.x | [Microsoft Visual C++ 2010 Redistributable Package][2010] | MSVCR100.DLL |
 | 11.2.0.x | Microsoft Visual C++ 2005 SP1 Redistributable Package ([x86][2005SP1_x86], [x64][2005SP1_x64]) | MSVCR80.DLL(The file version must be 8.0.50727.762.) |

data/docs/install-on-osx.md

@@ -39,7 +39,7 @@ Download the following packages from [Oracle Technology Network][]
 
 * Instant Client Package - Basic (`instantclient-basic-macos.x64-12.1.0.2.0.zip`) or Basic Lite (`instantclient-basiclite-macos.x64-12.1.0.2.0.zip`)
 * Instant Client Package - SDK (`instantclient-sdk-macos.x64-12.1.0.2.0.zip`)
-* Instant Client Package - SQL*Plus (`instantclient-sdk-macos.x64-12.1.0.2.0.zip`) (optionally) 
+* Instant Client Package - SQL*Plus (`instantclient-sqlplus-macos.x64-12.1.0.2.0.zip`) (optionally) 
 
 ### Install Oracle Instant Client Packages via Homebrew
 

data/lib/oci8.rb

@@ -11,8 +11,11 @@ if RUBY_PLATFORM =~ /cygwin/
   # Cygwin manages environment variables by itself.
   # They don't synchroize with Win32's ones.
   # This set some Oracle's environment variables to win32's enviroment.
-  require 'Win32API'
-  win32setenv = Win32API.new('Kernel32.dll', 'SetEnvironmentVariableA', 'PP', 'I')
+  require 'fiddle'
+  win32setenv = Fiddle::Function.new( Fiddle.dlopen('Kernel32.dll')['SetEnvironmentVariableA'],
+                                        [Fiddle::TYPE_VOIDP,Fiddle::TYPE_VOIDP],
+                                        Fiddle::TYPE_INT )
+
   ['NLS_LANG', 'TNS_ADMIN', 'LOCAL'].each do |name|
     val = ENV[name]
     win32setenv.call(name, val && val.dup)
@@ -63,6 +66,8 @@ when 'rbx'
   so_basename += 'rbx'
 when 'jruby'
   raise "Ruby-oci8 doesn't support jruby because its C extension support is in development in jruby 1.6 and deprecated in jruby 1.7."
+when 'truffleruby'
+  so_basename += 'truffleruby'
 else
   raise 'unsupported ruby engine: ' + RUBY_ENGINE
 end
@@ -95,7 +100,7 @@ begin
 
   ruby_arch = [nil].pack('P').size == 8 ? :x64 : :x86
   ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-    if dll_arch.call(File.join(path, 'OCI.DLL')) == ruby_arch
+    if !path.empty? && dll_arch.call(File.join(path, 'OCI.DLL')) == ruby_arch
       dll_dir = RubyInstaller::Runtime.add_dll_directory(path)
       break
     end
@@ -140,6 +145,8 @@ class OCI8
   ORAVER_11_1 = OCI8::OracleVersion.new(11, 1)
   # @private
   ORAVER_12_1 = OCI8::OracleVersion.new(12, 1)
+  # @private
+  ORAVER_18 = OCI8::OracleVersion.new(18)
 
   # @private
   @@oracle_client_version = OCI8::OracleVersion.new(self.oracle_client_vernum)

data/lib/oci8/bindtype.rb

@@ -172,20 +172,6 @@ class OCI8
       end
     end
 
-    class Long < OCI8::BindType::String
-      def self.create(con, val, param, max_array_size)
-        param = {:length => con.long_read_len, :char_semantics => true}
-        super(con, val, param, max_array_size)
-      end
-    end
-
-    class LongRaw < OCI8::BindType::RAW
-      def self.create(con, val, param, max_array_size)
-        param = {:length => con.long_read_len, :char_semantics => false}
-        self.new(con, val, param, max_array_size)
-      end
-    end
-
     class CLOB
       def self.create(con, val, param, max_array_size)
         if param.is_a? OCI8::Metadata::Base and param.charset_form == :nchar

data/lib/oci8/check_load_error.rb

@@ -6,14 +6,24 @@ class OCI8
     case RUBY_PLATFORM
     when /mswin32|cygwin|mingw32|bccwin32/
 
-      require 'Win32API'
+      require 'fiddle/import'
+      require 'fiddle/types'
+
+      extend Fiddle::Importer
+      dlload 'kernel32.dll'
+      include Fiddle::BasicTypes
+      include Fiddle::Win32Types
+
+      typealias "HANDLE", "void*"
+      typealias "HMODULE", "void*"
+      extern "DWORD GetModuleFileNameA(HMODULE, LPSTR, DWORD)"
+      extern "UINT GetSystemDirectoryA(LPCSTR, UINT)"
+      extern "UINT GetWindowsDirectoryA(LPCSTR, UINT)"
+      extern "HMODULE LoadLibraryExA(LPCSTR, HANDLE, DWORD)"
+      extern "BOOL FreeLibrary(HMODULE)"
+
       MAX_PATH = 260
-      GetModuleFileNameA = Win32API.new('kernel32.dll', 'GetModuleFileNameA', 'PPL', 'L')
-      GetSystemDirectoryA = Win32API.new('kernel32.dll', 'GetSystemDirectoryA', 'PL', 'L')
-      GetWindowsDirectoryA = Win32API.new('kernel32.dll', 'GetWindowsDirectoryA', 'PL', 'L')
-      LoadLibraryExA = Win32API.new('kernel32.dll', 'LoadLibraryExA', 'PPL', 'P')
-      FreeLibrary = Win32API.new('kernel32.dll', 'FreeLibrary', 'P', 'L')
-      LOAD_LIBRARY_AS_IMAGE_RESOURCE = 0x00000020
+      DONT_RESOLVE_DLL_REFERENCES = 0x00000001
 
       def self.check_os_specific_load_error(exc)
         case exc.message
@@ -23,25 +33,50 @@ class OCI8
             check_win32_pe_arch(File.join(path, '\OCI.DLL'), "Oracle client")
           end
         when /^OCI.DLL: 126\(/, /^126: / # "OCI.DLL: 126(The specified module could not be found.)" in English
-          handle = LoadLibraryExA.call('OCI.DLL', nil, LOAD_LIBRARY_AS_IMAGE_RESOURCE)
-          unless handle.null?
-            FreeLibrary.call(handle)
-            raise LoadError, <<EOS
-OCI.DLL is in the PATH but its dependent modules are not found.
+          oci_dll_files = dll_load_path_list.inject([]) do |files, path|
+            file = File.join(path, '\OCI.DLL')
+            files << file if File.exist?(file)
+            files
+          end
+          if oci_dll_files.empty?
+            raise LoadError, "Cannot find OCI.DLL in PATH."
+          end
+          if oci_dll_files.none? {|file| open(file, 'rb') {true} rescue false}
+            raise LoadError, "OCI.DLL in PATH isn't readable."
+          end
+          first_error = nil
+          oci_dll_files.each do |file|
+            begin
+              check_win32_pe_arch(file, "Oracle client")
+              valid_arch = true
+            rescue LoadError
+              first_error ||= $!
+              valid_arch = false
+            end
+            if valid_arch
+              handle = LoadLibraryExA(file, nil, DONT_RESOLVE_DLL_REFERENCES)
+              unless handle.null?
+                FreeLibrary(handle)
+                raise LoadError, <<EOS
+Cannot find DLLs depended by #{file}.
 See http://www.rubydoc.info/github/kubo/ruby-oci8/file/docs/install-instant-client.md#Windows
 EOS
+              end
+              break
+            end
           end
+          raise first_error if first_error
         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 << buf[0, GetModuleFileNameA(nil, buf, MAX_PATH)].force_encoding("locale").gsub(/\\[^\\]*$/, '')
+        paths << buf[0, GetSystemDirectoryA(buf, MAX_PATH)].force_encoding("locale")
+        paths << buf[0, GetWindowsDirectoryA(buf, MAX_PATH)].force_encoding("locale")
         paths << "."
-        paths + ENV['PATH'].split(';')
+        paths + (ENV['PATH'].split(';').reject {|path| path.empty?})
       end # self.dll_load_path_list
 
       def self.check_win32_pe_arch(filename, package)

data/lib/oci8/cursor.rb

@@ -25,7 +25,11 @@ class OCI8
       @names = nil
       @con = conn
       @max_array_size = nil
+      @fetch_array_size = nil
+      @rowbuf_size = 0
+      @rowbuf_index = 0
       __initialize(conn, sql) # Initialize the internal C structure.
+      self.prefetch_rows = conn.instance_variable_get(:@prefetch_rows)
     end
 
     # explicitly indicate the date type of fetched value. run this
@@ -38,7 +42,7 @@ class OCI8
     #   cursor.define(2, Time)       # fetch the second column as Time.
     #   cursor.exec()
     def define(pos, type, length = nil)
-      bindobj = make_bind_object(:type => type, :length => length)
+      bindobj = make_bind_object({:type => type, :length => length}, @fetch_array_size || 1)
       __define(pos, bindobj)
       if old = @define_handles[pos - 1]
         old.send(:free)
@@ -126,6 +130,8 @@ class OCI8
       when :select_stmt
         __execute(0)
         define_columns() if @column_metadata.size == 0
+        @rowbuf_size = 0
+        @rowbuf_index = 0
         @column_metadata.size
       else
         __execute(1)
@@ -384,6 +390,7 @@ class OCI8
     # @param [Integer] rows The number of rows to be prefetched
     def prefetch_rows=(rows)
       attr_set_ub4(11, rows) # OCI_ATTR_PREFETCH_ROWS(11)
+      @prefetch_rows = rows
     end
 
     if OCI8::oracle_client_version >= ORAVER_12_1
@@ -468,7 +475,7 @@ class OCI8
 
     private
 
-    def make_bind_object(param)
+    def make_bind_object(param, fetch_array_size = nil)
       case param
       when Hash
         key = param[:type]
@@ -510,22 +517,37 @@ class OCI8
         OCI8::BindType::Mapping[key] = bindclass if bindclass
       end
       raise "unsupported datatype: #{key}" if bindclass.nil?
-      bindclass.create(@con, val, param, max_array_size)
+      bindclass.create(@con, val, param, fetch_array_size || max_array_size)
     end
 
+    @@use_array_fetch = false
+
     def define_columns
       # http://docs.oracle.com/cd/E11882_01/appdev.112/e10646/ociaahan.htm#sthref5494
       num_cols = attr_get_ub4(18) # OCI_ATTR_PARAM_COUNT(18)
-      1.upto(num_cols) do |i|
-        parm = __paramGet(i)
-        define_one_column(i, parm) unless @define_handles[i - 1]
-        @column_metadata[i - 1] = parm
+      @column_metadata = 1.upto(num_cols).collect do |i|
+        __paramGet(i)
+      end
+      if @define_handles.size == 0
+        use_array_fetch = @@use_array_fetch
+        @column_metadata.each do |md|
+          case md.data_type
+          when :clob, :blob, :bfile
+            # Rows prefetching doesn't work for CLOB, BLOB and BFILE.
+            # Use array fetching to get more than one row in a network round trip.
+            use_array_fetch = true
+          end
+        end
+        @fetch_array_size = @prefetch_rows if use_array_fetch
+      end
+      @column_metadata.each_with_index do |md, i|
+        define_one_column(i + 1, md) unless @define_handles[i]
       end
       num_cols
     end
 
     def define_one_column(pos, param)
-      bindobj = make_bind_object(param)
+      bindobj = make_bind_object(param, @fetch_array_size || 1)
       __define(pos, bindobj)
       @define_handles[pos - 1] = bindobj
     end
@@ -540,22 +562,33 @@ class OCI8
       end
     end
 
+    def fetch_row_internal
+      if @rowbuf_size && @rowbuf_size == @rowbuf_index
+        @rowbuf_size = __fetch(@con, @fetch_array_size || 1)
+        @rowbuf_index = 0
+      end
+      @rowbuf_size
+    end
+
     def fetch_one_row_as_array
-      if __fetch(@con)
-        @define_handles.collect do |handle|
-          handle.send(:get_data)
+      if fetch_row_internal
+        ret = @define_handles.collect do |handle|
+          handle.send(:get_data, @rowbuf_index)
         end
+        @rowbuf_index += 1
+        ret
       else
         nil
       end
     end
 
     def fetch_one_row_as_hash
-      if __fetch(@con)
+      if fetch_row_internal
         ret = {}
         get_col_names.each_with_index do |name, idx|
-          ret[name] = @define_handles[idx].send(:get_data)
+          ret[name] = @define_handles[idx].send(:get_data, @rowbuf_index)
         end
+        @rowbuf_index += 1
         ret
       else
         nil

data/lib/oci8/metadata.rb

@@ -1503,7 +1503,11 @@ class OCI8
         attr_get_sb1(OCI_ATTR_SCALE)
       end
 
-      # The datatype levels. This attribute always returns zero.
+      # The nest level.
+      #
+      # Oracle manual says that it always returns zero. However it returns
+      # the depth of {OCI8::ArgBase#arguments} calls when #arguments returns
+      # a non-empty array.
       def level
         attr_get_ub2(OCI_ATTR_LEVEL)
       end
@@ -1607,6 +1611,10 @@ class OCI8
 
       # The list of arguments at the next level (when the argument is
       # of a record or table type).
+      #
+      # This method returns an array containing type information when
+      # the type is a user-defined type and the Oracle server version
+      # is 12c or earlier. Otherwise, it returns an empty array.
       def arguments
         @arguments ||= list_arguments.to_a
       end

data/lib/oci8/object.rb

@@ -493,6 +493,16 @@ EOS
          Proc.new do |val| datetime_to_array(val, :date) end, # set_proc
          Proc.new do |val| array_to_time(val, :local) end, # get_proc
         ]
+      when :timestamp
+        [ATTR_TIMESTAMP, con, SIZE_OF_POINTER, 2, ALIGNMENT_OF_POINTER,
+         Proc.new do |val| datetime_to_array(val, :timestamp) end, # set_proc
+         Proc.new do |val| array_to_time(val, :local) end, # get_proc
+        ]
+      when :timestamp_tz
+        [ATTR_TIMESTAMP_TZ, con, SIZE_OF_POINTER, 2, ALIGNMENT_OF_POINTER,
+         Proc.new do |val| datetime_to_array(val, :timestamp_tz) end, # set_proc
+         Proc.new do |val| array_to_time(val, nil) end, # get_proc
+        ]
       when :binary_double
         [ATTR_BINARY_DOUBLE, nil, SIZE_OF_DOUBLE, 2, ALIGNMENT_OF_DOUBLE]
       when :binary_float

data/lib/oci8/oci8.rb

@@ -169,7 +169,6 @@ class OCI8
   # @private
   def parse_internal(sql)
     cursor = OCI8::Cursor.new(self, sql)
-    cursor.prefetch_rows = @prefetch_rows if @prefetch_rows
     cursor
   end
 
@@ -305,6 +304,7 @@ class OCI8
   # @return [Array] an array of first row.
   def select_one(sql, *bindvars)
     cursor = self.parse(sql)
+    cursor.prefetch_rows = 1
     begin
       cursor.exec(*bindvars)
       row = cursor.fetch
@@ -340,6 +340,12 @@ class OCI8
 
   # Returns the Oracle server version.
   #
+  # When the Oracle client version is 12c or earlier and
+  # the Oracle server version is 18c or later, this method
+  # doesn't return *full* version number such as '18.3.0.0.0'.
+  # It returns version number whose number components after
+  # the first dot are zeros such as '18.0.0.0.0'.
+  #
   # @see OCI8.oracle_client_version
   # @return [OCI8::OracleVersion]
   def oracle_server_version

data/lib/oci8/oracle_version.rb

@@ -66,6 +66,12 @@ class OCI8
         major, minor, update, patch, port_update = arg.split('.').collect do |v|
           v.to_i
         end
+      elsif arg >= 0x12000000
+        major  = (arg & 0xFF000000) >> 24
+        minor  = (arg & 0x00FF0000) >> 16
+        update = (arg & 0x0000F000) >> 12
+        patch  = (arg & 0x00000FF0) >>  4
+        port_update = (arg & 0x0000000F)
       elsif arg >= 0x08000000
         major  = (arg & 0xFF000000) >> 24
         minor  = (arg & 0x00F00000) >> 20
@@ -80,7 +86,11 @@ class OCI8
       @update = update || 0
       @patch = patch || 0
       @port_update = port_update || 0
-      @vernum = (@major << 24) | (@minor << 20) | (@update << 12) | (@patch << 8) | @port_update
+      @vernum = if @major >= 18
+                  (@major << 24) | (@minor << 16) | (@update << 12) | (@patch << 4) | @port_update
+                else
+                  (@major << 24) | (@minor << 20) | (@update << 12) | (@patch << 8) | @port_update
+                end
     end
 
     # Compares +self+ and +other+.

data/lib/oci8/version.rb

@@ -1,3 +1,3 @@
 class OCI8
-  VERSION = "2.2.5.1"
+  VERSION = "2.2.9"
 end

data/lib/ruby-oci8.rb

@@ -1,4 +1 @@
-if caller[0] !~ /\/bundler\/runtime\.rb:\d+:in `require'/
-  warn "Don't require 'ruby-oci8'. Use \"require 'oci8'\" instead. 'ruby-oci8.rb' was added only for 'Bundler.require'."
-end
 require 'oci8'