ruby-oci8 2.2.6.1-x86-mingw32 → 2.2.7-x86-mingw32

data/ChangeLog

@@ -1,11 +1,60 @@
-2018-09-16  Kubo Takehiro <kubo@jiubao.org>
-	* NEWS: Add changes between 2.2.6 and 2.2.6.1
-	* lib/oci8/version.rb: Update to 2.2.6.1
+2019-01-06  Kubo Takehiro <kubo@jiubao.org>
+	* NEWS: Add changes between 2.2.6.1 and 2.2.7.
+	* lib/oci8/version.rb: Update to 2.2.7
+
+2019-01-06  Kubo Takehiro <kubo@jiubao.org>
+	* mkpkg-win32.rb, ruby-oci8.gemspec: Build binary gems for ruby 2.6
+	    on Windows.
+
+2019-01-06  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/oci8.c: Updata doc comments for OCI8#long_read_len
+	    and OCI8#long_read_len=. These are deprecated.
+
+2019-01-03  Kubo Takehiro <kubo@jiubao.org>
+	* lib/oci8/check_load_error.rb: Use fiddle instead of Win32API
+	    to call WIN32 functions.
+
+2019-01-03  Kubo Takehiro <kubo@jiubao.org>
+	* lib/oci8/check_load_error.rb: Add more error diagnostics
+	    when 'require "oci8"' fails with "OCI.DLL: 126(The specified
+	    module could not be found.)".
+
+2019-01-03  Kubo Takehiro <kubo@jiubao.org>
+	* lib/oci8.rb, lib/oci8/check_load_error.rb: Exclude empty
+	    parts of PATH on Windows.
+
+2018-12-23  Kubo Takehiro <kubo@jiubao.org>
+	* lib/oci8/check_load_error.rb: Check OCI.DLL archtecture
+	  when load error. It worked for ruby installer but not
+	  for ruby installer2.
+
+2018-12-23  Kubo Takehiro <kubo@jiubao.org>
+	* docs/install-instant-client.md: Add information about
+	  the MSVC redistributable package required by Oracle 18.3 client.
 
 2018-09-16  Kubo Takehiro <kubo@jiubao.org>
 	* ext/oci8/hook_funcs.c: Fix "No shared library is found to hook." on macOS.
 	    (oracle-enhanced issue #1768)
 
+2018-09-11  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/object.c, lib/oci8/cursor.rb: Change the internal structure
+	    about object type binding to use array fetching for object types.
+
+2018-09-09  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/lob.c: Read lob data without checking readable size to
+	    reduce number of network round trips from two to one.
+
+2018-09-05  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/bind.c, ext/oci8/stmt.c, lib/oci8/cursor.rb,
+	  lib/oci8/oci8.rb, test/test_oci8.rb: Use array fetching when
+	    LOB colums are in a query and no object types are in the query.
+
+2018-09-02  Kubo Takehiro <kubo@jiubao.org>
+	* ext/oci8/apiwrap.yml, ext/oci8/bind.c, ext/oci8/stmt.c,
+	  lib/oci8/bindtype.rb, test/test_oci8.rb: Rewrite OCI8::BindType::Long
+	    and OCI8::BindType::LongRaw to handle up to 2 gigabyte data using
+	    dynamically allocated buffers.
+
 2018-08-22  Kubo Takehiro <kubo@jiubao.org>
 	* NEWS: Add changes between 2.2.5.1 and 2.2.6
 	* lib/oci8/version.rb: Update to 2.2.6

data/NEWS

@@ -1,15 +1,67 @@
 # @markup markdown
 
-2.2.6.1
-=======
+2.2.7 (2019-01-06)
+==================
+
+Incompatible Changes
+--------------------
+
+### `OCI8#long_read_len` and `OCI8#long_read_len=` do nothing.
+
+When `LONG`, `LONG RAW` or `XMLTYPE` data were fetched, the data were
+truncated at `OCI8#long_read_len`. The maximum size of data had
+been 4 gigabytes since this release.
+
+`OCI8#long_read_len` and `OCI8#long_read_len=` remain for code-compatibility
+but do nothing.
+
+Improvement
+-----------
+
+### The number of network round trips was reduced when LOB data are read.
+
+When LOB data are read, ruby-oci8 before 2.2.7 does the followings:
+
+1. Gets the size of the LOB.
+2. Allocate buffer to hold the data.
+3. Read the LOB contents.
+
+This requires two round trips.
+
+It now does the followings:
+
+1. Request the server to get LOB contents up to 4 gigabytes.
+2. Read the LOB contents and allocate buffer when the size is insufficient.
+3. If the total length of received data is less than 4 gigabytes, all data
+   are read. If not, go to the first step to read next 4 gigabytes.
+
+This requires only one round trip if the size is less than 4 gigabytes.
+
+### Use array fetching instead of prefetching when LOB columns are in queries 
+
+When LOB columns are in queries, prefetching doesn't seem to work. Rows
+are fetched one by one according to data captured by network packet sniffer.
+So array fetching is used instead of prefetching to reduce the number of
+network round trips.
+
+### Add error diagnostics when `'require "oci8"'` fails on Windows.
+
+When `'require "oci8"'` fails with "OCI.DLL: 126(The specified module could not be found.)"
+on Windows, the cause is not always that OCI.DLL is not found. It may
+be incorrect architecture, missing dependent DLLs and so on.
+Ruby-oci8 checks PATH and DLL files when the error is raised and change
+the error message to reasonable one as possible.
+
+2.2.6.1 (2018-09-16)
+====================
 
 Fixed issue
 -----------
 Fix "No shared library is found to hook." on macOS.
 (rsim/oracle-enhanced#1768)
 
-2.2.6
-=====
+2.2.6 (2018-08-22)
+==================
 
 This release fixed issues about Oracle 18c except one.
 
@@ -47,8 +99,8 @@ communication channel."
 
 (github issue #185)
 
-2.2.5.1
-=======
+2.2.5.1 (2017-12-27)
+====================
 
 No updates except tests. The version number was changed just to release
 binary gems for ruby 2.5 on Windows.
@@ -57,8 +109,8 @@ binary gems for ruby 2.5 on Windows.
 
 (github issue #180, #181)
 
-2.2.5
-=====
+2.2.5 (2017-10-21)
+==================
 
 New Features
 ------------
@@ -115,8 +167,8 @@ Other Changes
 See {file:docs/number-type-mapping.md Number Type Mapping between Oracle and Ruby}.
 (github issue #173)
 
-2.2.4.1
-=======
+2.2.4.1 (2017-06-17)
+====================
 
 Fixed issue
 -----------
@@ -130,8 +182,8 @@ differently, it may cause unexpected behavior.
 
 ### Fix compilation errors in 2.2.4 on cygwin
 
-2.2.4
-=====
+2.2.4 (2017-06-11)
+==================
 
 New Features
 ------------
@@ -169,8 +221,8 @@ Use Win32::Registry instead of Win32API to compile ruby-oci8 on the latest cygwi
 
 (contributed by davidbrs. [github issue #156](https://github.com/kubo/ruby-oci8/issues/156))
 
-2.2.3
-=====
+2.2.3 (2016-12-27)
+==================
 
 New Features
 ------------
@@ -183,8 +235,8 @@ New Features
 -   Suppress warnings outputted by Minitest in ruby 2.4.0
 -   Suppress warnings when compiling with ruby 2.4.0
 
-2.2.2
-=====
+2.2.2 (2016-04-24)
+==================
 
 New Features
 ------------
@@ -230,8 +282,8 @@ Other Changes
 -   Check the default value of DYLD_FALLBACK_LIBRARY_PATH after checking OCI_DIR on installation. (OS X only)
 
 
-2.2.1
-=====
+2.2.1 (2015-11-01)
+==================
 
 New Features
 ------------
@@ -259,16 +311,16 @@ Other Changes
 
 -   Delete unused code which was added to support old Oracle and ruby 1.8.
 
-2.2.0.2
-=======
+2.2.0.2 (2015-10-12)
+====================
 
 Nothing was changed except the version.
 
 The forth version was incremented to release binary gems for mingw32.
 The binary gems for 2.2.0.1 didn't work by faultily packaging.
 
-2.2.0.1
-=======
+2.2.0.1 (2015-10-11)
+====================
 
 If ruby-oci8 2.2.0 is installed, you have no need to update it to
 2.2.0.1. Source code itself was not changed between 2.2.0 and 2.2.0.1.
@@ -284,8 +336,8 @@ Ruby-oci8 2.2.0 documents had not been generated in rubydoc.info
 though the URLs are displayed on installation failure. They were
 changed to documents generated by the latest github repository.
 
-2.2.0
-=====
+2.2.0 (2015-10-04)
+==================
 
 ### Drop ruby 1.8 support
 
@@ -326,8 +378,8 @@ Other Changes
 -   Add OCI8.charset_name2id and OCI8.charset_id2name.
     Mark OCI8#charset_name2id and OCI8#charset_id2name as deprecated.
 
-2.1.8
-=====
+2.1.8 (2015-04-04)
+==================
 
 New Features
 ------------
@@ -387,8 +439,8 @@ Fixed Issues
 -   Don't use SYM2ID on ruby 2.2.0 or later not to make symbols unGCable
     by [Symbol GC](http://www.infoq.com/news/2014/12/ruby-2.2.0-released).
 
-2.1.7
-=====
+2.1.7 (2014-02-02)
+==================
 
 New Features
 ------------
@@ -400,8 +452,8 @@ Fixed Issues
 
 -   Fix OCI8#describe_table to follow synonyms in a remote database.
 
-2.1.6
-=====
+2.1.6 (2013-12-29)
+==================
 
 New Features
 ------------
@@ -441,8 +493,8 @@ Fixed Issues
 -   fix SEGV when one connection is used by more than two threads and temporary
     lobs are freed by GC.
 
-2.1.5
-=====
+2.1.5 (2013-03-09)
+==================
 
 New Features
 ------------
@@ -462,8 +514,8 @@ Fixed Issues
     instant client is 11.2.0.3 for Solaris x86 32-bit, the ruby
     version is 1.9.3 or upper and the ruby is compiled by gcc.
 
-2.1.4
-=====
+2.1.4 (2013-01-06)
+==================
 
 New Features
 ------------
@@ -503,8 +555,8 @@ Fixed Issues
 
     (reported by Brian Henderson)
 
-2.1.3
-=====
+2.1.3 (2012-11-11)
+==================
 
 New Features
 ------------
@@ -561,8 +613,8 @@ Fixed Issues
 -   Fix #<NoMethodError: undefined method `timezone' for Time:Class>
     when ruby is less than 1.9.2 and an object type's time attribute is accessed.
 
-2.1.2
-=====
+2.1.2 (2012-04-28)
+==================
 
 Specification changes
 ---------------------
@@ -583,8 +635,8 @@ Fixed Issues
 
     (reported by Yasuo Honda)
 
-2.1.1
-=====
+2.1.1 (2012-04-22)
+==================
 
 New Features
 ------------
@@ -631,8 +683,8 @@ Fixed Issues
 
     (repored by Leoš Bitto)
 
-2.1.0
-=====
+2.1.0 (2011-12-13)
+==================
 
 New Features
 ------------
@@ -747,8 +799,8 @@ Fixed Issues
 
     (reported by jbirdjavi)
 
-2.0.6
-=====
+2.0.6 (2011-06-14)
+==================
 
 Fixed issues
 ------------
@@ -759,8 +811,8 @@ Fixed issues
     a closed OCI handle's method is called. It was chaned in 2.0.5
     by mistake.
 
-2.0.5
-=====
+2.0.5 (2011-06-12)
+==================
 
 New Features
 ------------
@@ -848,8 +900,8 @@ Fixed issues
 
     (reported by Sebastian YEPES)
 
-2.0.4
-=====
+2.0.4 (2010-02-28)
+==================
 
 New Features
 ------------
@@ -910,8 +962,8 @@ Fixed issues
 
     (reported by Raimonds Simanovskis)
 
-2.0.3
-=====
+2.0.3 (2009-10-21)
+==================
 
 Incompatible Changes
 --------------------
@@ -1051,8 +1103,8 @@ Fixed installation issues
 
     (reported by Kazuya Teramoto)
 
-2.0.2
-=====
+2.0.2 (2009-05-17)
+==================
 
 *   add new methods
     -   {OCI8#select_one}
@@ -1092,8 +1144,8 @@ Fixed installation issues
 *   [ruby 1.9] fix to bind string data by the length got from String#bytesize
     converted to {OCI8.encoding}, not by String#size.
 
-2.0.1
-=====
+2.0.1 (2009-03-17)
+==================
 
 *   release a binary gem for Windows, which contains libraries for both
     ruby 1.8 and ruby 1.9.1.

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

data/docs/install-instant-client.md

@@ -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/lib/oci8.rb

@@ -95,7 +95,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

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/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

data/lib/oci8/version.rb

@@ -1,3 +1,3 @@
 class OCI8
-  VERSION = "2.2.6.1"
+  VERSION = "2.2.7"
 end

data/ruby-oci8.gemspec

@@ -34,7 +34,6 @@ spec = Gem::Specification.new do |s|
   s.description = <<EOS
 ruby-oci8 is a ruby interface for Oracle using OCI8 API. It is available with Oracle 10g or later including Oracle Instant Client.
 EOS
-  s.has_rdoc = 'yard'
   s.authors = ['Kubo Takehiro']
   s.platform = gem_platform
   s.license = 'BSD-2-Clause'
@@ -79,7 +78,7 @@ EOS
     end
     files << 'lib/oci8.rb'
   end
-  s.require_paths = ['lib', 'ext/oci8']
+  s.require_paths = ['lib']
   s.files = files
   s.test_files = 'test/test_all.rb'
   s.extra_rdoc_files = ['README.md']

data/test/README.md

@@ -0,0 +1,40 @@
+Before running unit test:
+
+1. Connect to Oracle as sys
+   ```shell
+   $ sqlplus sys/<password_of_sys> as sysdba
+   SQL>
+   ```
+2. Create user ruby
+   ```sql
+   SQL> CREATE USER ruby IDENTIFIED BY oci8;
+   ```
+   or
+   ```sql
+   SQL> CREATE USER ruby IDENTIFIED BY oci8
+      2 DEFAULT TABLESPACE users TEMPORARY TABLESPACE temp;
+   ```
+3. Grant the privilege to connect and execute.
+   ```sql
+    SQL> GRANT connect, resource, create view, create synonym TO ruby;
+    SQL> GRANT execute ON dbms_lock TO ruby;
+    ```
+4. Connect as ruby user.
+   ```shell
+   $ sqlplus ruby/oci8
+   SQL>
+   ```
+5. Create object types
+   ```sql
+   SQL> @test/setup_test_object.sql
+   ```
+6. change $dbname in test/config.rb.
+
+Then run the following command:
+```shell
+$ make check
+```
+or
+```
+$ nmake check   (If your compiler is MS Visual C++.)
+````

data/test/config.rb

@@ -134,7 +134,7 @@ class Minitest::Test
 
   def get_oci8_connection()
     OCI8.new($dbuser, $dbpass, $dbname)
-      rescue OCIError
+  rescue OCIError
     raise if $!.code != 12516 && $!.code != 12520
     # sleep a few second and try again if
     # the error code is ORA-12516 or ORA-12520.

data/test/test_oci8.rb

@@ -25,53 +25,142 @@ EOS
     drop_table('test_rename_table')
   end
 
-  # USE_DYNAMIC_FETCH doesn't work well...
-  # This test is disabled.
-  def _test_long_type
-    drop_table('test_table')
-    @conn.exec('CREATE TABLE test_table (id number(38), lng long)')
-    test_data1 = 'a' * 70000
-    test_data2 = 'b' * 3000
-    test_data3 = nil
-    test_data4 = 'c' * 70000
-    @conn.exec('insert into test_table values (:1, :2)', 1, test_data1)
-    @conn.exec('insert into test_table values (:1, :2)', 2, [test_data2, :long])
-    @conn.exec('insert into test_table values (:1, :2)', 3, [nil, :long])
-    @conn.exec('insert into test_table values (:1, :2)', 4, [test_data4, :long])
-
-    [8000, 65535, 65536, 80000].each do |read_len|
-      @conn.long_read_len = read_len
-      cursor = @conn.parse('SELECT lng from test_table order by id')
-      cursor.exec
-      assert_equal(test_data1, cursor.fetch[0])
-      assert_equal(test_data2, cursor.fetch[0])
-      assert_equal(test_data3, cursor.fetch[0])
-      assert_equal(test_data4, cursor.fetch[0])
-      cursor.close
+  # Set `OCI8::BindType::Base.initial_chunk_size = 5` to
+  # use the following test data.
+  LONG_TEST_DATA = [
+    # initial chunk size: 5 (total buffer size: 5)
+    'a' * 4, 'b' * 5, 'c' * 6, 'd' * 5, 'e' * 4,
+    # second chunk size: 10 (total buffer size: 15)
+    'f' * 14, 'g' * 15, 'h' * 16, 'i' * 15, 'j' * 14,
+    # third chunk size: 20 (total buffer size: 35)
+    'k' * 34, 'l' * 35, 'm' * 36, 'n' * 35, 'o' * 34,
+    # use data around initial chunk size again
+    'p' * 4, 'q' * 5, 'r' * 6, 's' * 5, 't' * 4,
+    # special data
+    '', nil,
+  ]
+
+  def test_long_type
+    clob_bind_type = OCI8::BindType::Mapping[:clob]
+    blob_bind_type = OCI8::BindType::Mapping[:blob]
+    initial_cunk_size = OCI8::BindType::Base.initial_chunk_size
+    begin
+      OCI8::BindType::Base.initial_chunk_size = 5
+      @conn.prefetch_rows = LONG_TEST_DATA.size / 3
+      drop_table('test_table')
+      ascii_enc = Encoding.find('US-ASCII')
+      0.upto(1) do |i|
+        if i == 0
+          @conn.exec("CREATE TABLE test_table (id number(38), long_column long, clob_column clob)")
+          cursor = @conn.parse('insert into test_table values (:1, :2, :3)')
+          cursor.bind_param(1, nil, Integer)
+          cursor.bind_param(2, nil, :long)
+          cursor.bind_param(3, nil, :clob)
+          lob = OCI8::CLOB.new(@conn, '')
+          enc = Encoding.default_internal || OCI8.encoding
+        else
+          @conn.exec("CREATE TABLE test_table (id number(38), long_raw_column long raw, blob_column blob)")
+          cursor = @conn.parse('insert into test_table values (:1, :2, :3)')
+          cursor.bind_param(1, nil, Integer)
+          cursor.bind_param(2, nil, :long_raw)
+          cursor.bind_param(3, nil, :blob)
+          lob = OCI8::BLOB.new(@conn, '')
+          enc = Encoding.find('ASCII-8BIT')
+        end
+
+        LONG_TEST_DATA.each_with_index do |data, index|
+          cursor[1] = index
+          cursor[2] = data
+          if data.nil?
+            cursor[3] = nil
+          else
+            lob.rewind
+            lob.write(data)
+            lob.size = data.size
+            cursor[3] = lob
+          end
+          cursor.exec
+        end
+        cursor.close
+
+        cursor = @conn.parse('SELECT * from test_table order by id')
+        cursor.exec
+        LONG_TEST_DATA.each_with_index do |data, index|
+          row = cursor.fetch
+          assert_equal(index, row[0])
+          if data.nil?
+            assert_nil(row[1])
+            assert_nil(row[2])
+          elsif data.empty?
+            # '' is inserted to the long or long raw column as null.
+            assert_nil(row[1])
+            # '' is inserted to the clob or blob column as an empty clob.
+            # It is fetched as '' when the data is read using a LOB locator.
+            assert_equal(data, clob_data = row[2].read)
+            assert_equal(ascii_enc, clob_data.encoding)
+          else
+            assert_equal(data, row[1])
+            assert_equal(data, clob_data = row[2].read)
+            assert_equal(enc, row[1].encoding)
+            assert_equal(enc, clob_data.encoding)
+          end
+        end
+        assert_nil(cursor.fetch)
+        cursor.close
+
+        begin
+          OCI8::BindType::Mapping[:clob] = OCI8::BindType::Long
+          OCI8::BindType::Mapping[:blob] = OCI8::BindType::LongRaw
+          cursor = @conn.parse('SELECT * from test_table order by id')
+          cursor.exec
+          LONG_TEST_DATA.each_with_index do |data, index|
+            row = cursor.fetch
+            assert_equal(index, row[0])
+            if data.nil?
+              assert_nil(row[1])
+              assert_nil(row[2])
+            elsif data.empty?
+              # '' is inserted to the long or long raw column as null.
+              assert_nil(row[1])
+              # '' is inserted to the clob or blob column as an empty clob.
+              # However it is fetched as nil.
+              assert_nil(row[2])
+            else
+              assert_equal(data, row[1])
+              assert_equal(data, row[2])
+              assert_equal(enc, row[1].encoding)
+              assert_equal(enc, row[2].encoding)
+            end
+          end
+          assert_nil(cursor.fetch)
+          cursor.close
+        ensure
+          OCI8::BindType::Mapping[:clob] = clob_bind_type
+          OCI8::BindType::Mapping[:blob] = blob_bind_type
+        end
+        drop_table('test_table')
+      end
+    ensure
+      OCI8::BindType::Base.initial_chunk_size = initial_cunk_size
     end
     drop_table('test_table')
   end
 
-  def test_long_type
-    @conn.long_read_len = 80000
-    drop_table('test_table')
-    @conn.exec('CREATE TABLE test_table (id number(38), lng long)')
-    test_data1 = 'a' * 70000
-    test_data2 = 'b' * 3000
-    test_data4 = 'c' * 70000
-    @conn.exec('insert into test_table values (:1, :2)', 1, test_data1)
-    @conn.exec('insert into test_table values (:1, :2)', 2, [test_data2, :long])
-    @conn.exec('insert into test_table values (:1, :2)', 3, [nil, :long])
-    @conn.exec('insert into test_table values (:1, :2)', 4, [test_data4, :long])
-
-    cursor = @conn.parse('SELECT lng from test_table order by id')
-    cursor.exec
-    assert_equal(test_data1, cursor.fetch[0])
-    assert_equal(test_data2, cursor.fetch[0])
-    assert_nil(cursor.fetch[0])
-    assert_equal(test_data4, cursor.fetch[0])
-    cursor.close
-    drop_table('test_table')
+  def test_bind_long_data
+    initial_cunk_size = OCI8::BindType::Base.initial_chunk_size
+    begin
+      OCI8::BindType::Base.initial_chunk_size = 5
+      cursor = @conn.parse("begin :1 := '<' || :2 || '>'; end;")
+      cursor.bind_param(1, nil, :long)
+      cursor.bind_param(2, nil, :long)
+      (LONG_TEST_DATA + ['z' * 4000]).each do |data|
+        cursor[2] = data
+        cursor.exec
+        assert_equal("<#{data}>", cursor[1])
+      end
+    ensure
+      OCI8::BindType::Base.initial_chunk_size = initial_cunk_size
+    end
   end
 
   def test_select
@@ -450,6 +539,7 @@ EOS
     assert_nil(@conn.last_error)
     @conn.last_error = 'dummy'
     cursor = @conn.parse('select col1, max(col2) from (select 1 as col1, null as col2 from dual) group by col1')
+    cursor.prefetch_rows = 1
     assert_nil(@conn.last_error)
 
     # When an OCI function returns OCI_SUCCESS_WITH_INFO, OCI8#last_error is set.
@@ -510,4 +600,25 @@ EOS
           end
     assert_equal(ver, @conn.oracle_server_version.to_s)
   end
+
+  def test_array_fetch
+    drop_table('test_table')
+    @conn.exec("CREATE TABLE test_table (id number, val clob)")
+    cursor = @conn.parse("INSERT INTO test_table VALUES (:1, :2)")
+    1.upto(10) do |i|
+      cursor.exec(i, ('a'.ord + i).chr * i)
+    end
+    cursor.close
+    cursor = @conn.parse("select * from test_table where id <= :1 order by id")
+    cursor.prefetch_rows = 4
+    [1, 6, 2, 7, 3, 8, 4, 9, 5, 10].each do |i|
+      cursor.exec(i)
+      1.upto(i) do |j|
+        row = cursor.fetch
+        assert_equal(j, row[0])
+        assert_equal(('a'.ord + j).chr * j, row[1].read)
+      end
+      assert_nil(cursor.fetch)
+    end
+  end
 end # TestOCI8

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-oci8
 version: !ruby/object:Gem::Version 
-  hash: 101
+  hash: 9
   prerelease: false
   segments: 
   - 2
   - 2
-  - 6
-  - 1
-  version: 2.2.6.1
+  - 7
+  version: 2.2.7
 platform: x86-mingw32
 authors: 
 - Kubo Takehiro
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2018-09-16 00:00:00 +09:00
+date: 2019-01-06 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -76,7 +75,7 @@ files:
 - 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
@@ -114,6 +113,7 @@ files:
 - lib/oci8lib_230.so
 - lib/oci8lib_240.so
 - lib/oci8lib_250.so
+- lib/oci8lib_260.so
 has_rdoc: true
 homepage: http://www.rubydoc.info/github/kubo/ruby-oci8
 licenses: 
@@ -123,7 +123,6 @@ rdoc_options: []
 
 require_paths: 
 - lib
-- ext/oci8
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 

data/test/README

@@ -1,42 +0,0 @@
-Before runing unit test:
-
-1. connect to Oracle as system:
-
-    $ sqlplus system/<password_of_system>
-
-2. create user ruby:
-
-    SQL> CREATE USER ruby IDENTIFIED BY oci8;
-
-   or
-
-    SQL> CREATE USER ruby IDENTIFIED BY oci8
-       2 DEFAULT TABLESPACE users TEMPORARY TABLESPACE temp;
-
-3. grant the privilege to connect and execute.
-
-    SQL> GRANT connect, resource, create view TO ruby;
-
-4. connect to Oracle as sys
-
-    $ sqlplus 'sys/<password_of_sys> as sysdba'
-
-5. grant privileges
-
-    SQL> GRANT EXECUTE ON dbms_lock TO ruby;
-    SQL> GRANT CREATE VIEW TO ruby;
-
-6. connect as ruby user.
-
-    $ sqlplus ruby/oci8
-
-7. Create object types
-
-    SQL> @test/setup_test_object.sql
-
-8. change $dbname if the database 
-
-Then you can run:
-  $ make check
-or
-  $ nmake check   (If your compiler is MS Visual C++.)