ruby-oci8 2.2.0.2 → 2.2.12

data/lib/oci8/properties.rb

@@ -13,6 +13,12 @@ class OCI8
     :statement_cache_size => 0,
     :events_mode => ((OCI8.__get_prop(2) & 4) != 0), # 4 <- OCI_EVENTS in oci.h
     :cancel_read_at_exit => false,
+    :tcp_connect_timeout => nil,
+    :connect_timeout => nil,
+    :send_timeout => nil,
+    :recv_timeout => nil,
+    :tcp_keepalive => false,
+    :tcp_keepalive_time => nil,
   }
 
   # @private
@@ -53,6 +59,19 @@ class OCI8
     when :cancel_read_at_exit
       val = val ? true : false
       OCI8.__set_prop(3, val)
+    when :tcp_connect_timeout, :connect_timeout, :send_timeout, :recv_timeout
+      if !val.nil?
+        val = val.to_i
+        raise ArgumentError, "The property value for :#{name} must be nil or a positive integer." if val <= 0
+      end
+    when :tcp_keepalive
+      val = val ? true : false
+    when :tcp_keepalive_time
+      if !val.nil?
+        val = val.to_i
+        raise ArgumentError, "The property value for :#{name} must be nil or a positive integer." if val <= 0
+      end
+      OCI8.__set_prop(4, val)
     end
     super(name, val)
   end
@@ -132,6 +151,42 @@ class OCI8
   #
   #     *Since:* 2.1.8
   #
+  # [:tcp_connect_timeout]
+  #
+  #     See {file:docs/timeout-parameters.md}
+  #
+  #     *Since:* 2.2.2
+  #
+  # [:connect_timeout]
+  #
+  #     See {file:docs/timeout-parameters.md}
+  #
+  #     *Since:* 2.2.2
+  #
+  # [:send_timeout]
+  #
+  #     See {file:docs/timeout-parameters.md}
+  #
+  #     *Since:* 2.2.2
+  #
+  # [:recv_timeout]
+  #
+  #     See {file:docs/timeout-parameters.md}
+  #
+  #     *Since:* 2.2.2
+  #
+  # [:tcp_keepalive]
+  #
+  #     See {file:docs/hanging-after-inactivity.md}
+  #
+  #     *Since:* 2.2.4
+  #
+  # [:tcp_keepalive_time]
+  #
+  #     See {file:docs/hanging-after-inactivity.md}
+  #
+  #     *Since:* 2.2.4
+  #
   # @return [a customized Hash]
   # @since 2.0.5
   #

data/lib/oci8/version.rb

@@ -1,3 +1,3 @@
 class OCI8
-  VERSION = "2.2.0.2"
+  VERSION = "2.2.12"
 end

data/lib/oci8.rb

@@ -1,4 +1,3 @@
-
 #   --*- ruby -*--
 # This is based on yoshidam's oracle.rb.
 #
@@ -12,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)
@@ -64,16 +66,56 @@ 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
 
+dll_dir = nil
+begin
+  require 'ruby_installer/runtime' # RubyInstaller2 for Windows
+
+  dll_arch = proc do |file|
+    begin
+      File.open(file, 'rb') do |f|
+        if f.read(2) == 'MZ' # IMAGE_DOS_HEADER.e_magic
+          f.seek(60, IO::SEEK_SET)
+          pe_offset = f.read(4).unpack('V')[0] # IMAGE_DOS_HEADER.e_lfanew
+          f.seek(pe_offset)
+          if f.read(4) == "PE\000\000" # IMAGE_NT_HEADERS.Signature
+            case f.read(2).unpack('v')[0] # IMAGE_FILE_HEADER.Machine
+            when 0x014c # IMAGE_FILE_MACHINE_I386
+              :x86
+            when 0x8664 # IMAGE_FILE_MACHINE_AMD64
+              :x64
+            end
+          end
+        end
+      end
+    rescue
+      nil
+    end
+  end
+
+  ruby_arch = [nil].pack('P').size == 8 ? :x64 : :x86
+  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+    if !path.empty? && dll_arch.call(File.join(path, 'OCI.DLL')) == ruby_arch
+      dll_dir = RubyInstaller::Runtime.add_dll_directory(path)
+      break
+    end
+  end
+rescue LoadError
+end
+
 begin
   require so_basename
-rescue LoadError, OCIError
+rescue LoadError
   require 'oci8/check_load_error'
   OCI8::Util::check_load_error($!)
   raise
+ensure
+  dll_dir.remove if dll_dir
 end
 
 require 'oci8/version.rb'
@@ -103,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/ruby-oci8.rb

@@ -0,0 +1 @@
+require 'oci8'

data/pre-distclean.rb

@@ -1,6 +1,4 @@
-rm_f "#{curr_objdir}/lib/oci8.rb"
-rm_f "#{curr_objdir}/ext/oci8/oci8lib_18.map"
-rm_f "#{curr_objdir}/ext/oci8/oci8lib_191.map"
+rm_f "#{curr_objdir}/ext/oci8/oci8lib_*.map"
 if RUBY_PLATFORM =~ /cygwin/
   rm_f "#{curr_objdir}/ext/oci8/OCI.def"
   rm_f "#{curr_objdir}/ext/oci8/libOCI.a"

data/ruby-oci8.gemspec

@@ -34,10 +34,9 @@ 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 = '2-clause BSD-style license'
+  s.license = 'BSD-2-Clause'
   files = File.read('dist-files').split("\n")
   if gem_platform == Gem::Platform::RUBY
     s.extensions << 'ext/oci8/extconf.rb'
@@ -51,7 +50,7 @@ EOS
     # add map files to analyze a core (minidump) file.
     so_vers.each do |ver|
       map_file = 'ext/oci8/oci8lib_#{ver}.map'
-      so_files << map_file if File.exists? map_file
+      so_files << map_file if File.exist? map_file
     end
 
     # least version in so_vers
@@ -64,11 +63,7 @@ EOS
       raise "No compiled binary are found. Run make in advance."
     when 1
       puts "Binary gem for ruby #{so_vers.first}"
-      if so_vers[0] < '2.0.0'
-        s.required_ruby_version = "~> #{so_vermin}"
-      else
-        s.required_ruby_version = "~> #{so_vermin}.0"
-      end
+      s.required_ruby_version = "~> #{so_vermin}"
     else
       puts "Binary gem for ruby #{so_vers.join(', ')}"
       s.required_ruby_version = ">= #{so_vermin}"
@@ -83,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/setup.rb

@@ -189,7 +189,16 @@ class ConfigTable
                      'the make program to compile ruby extentions' ] ],
     [ 'without-ext', [ 'no',
                        'yes/no',
-                       'does not compile/install ruby extentions' ] ]
+                       'does not compile/install ruby extentions' ] ],
+    [ 'with-instant-client-dir', ['',
+                                  'path',
+                                  'path to the Oracle instant client directory'] ],
+    [ 'with-instant-client-lib', ['',
+                                  'path',
+                                  'path to the Oracle instant client libraries'] ],
+    [ 'with-instant-client-include', ['',
+                                      'path',
+                                      'path to the Oracle instant client header files'] ]
   ]
   multipackage_descripters = [
     [ 'with',      [ '',
@@ -277,7 +286,7 @@ class ConfigTable
 
   def initialize_from_table
     @table = {}
-    DESCRIPTER.each do |k, (default, vname, desc, default2)|
+    DESCRIPTER.each do |k, (default, *)|
       @table[k] = default
     end
   end

data/test/README.md

@@ -0,0 +1,37 @@
+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 DEFAULT TABLESPACE users TEMPORARY TABLESPACE temp;
+   SQL> alter user ruby quota unlimited on users;
+   ```
+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
+   SQL> @test/setup_test_package.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

@@ -125,9 +125,16 @@ end
 
 class Minitest::Test
 
+  # @!visibility private
+  # dirty hack to suppress "warning: constant ::Fixnum is deprecated"
+  Fixnum = (0.class == ::Integer) ? ::Integer : ::Fixnum
+  # @!visibility private
+  # dirty hack to suppress "warning: constant ::Bignum is deprecated"
+  Bignum = (0.class == ::Integer) ? ::Integer : ::Bignum
+
   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/setup_test_object.sql

@@ -10,6 +10,10 @@ drop type rb_test_obj_elem_array
 /
 drop type rb_test_obj_elem
 /
+drop type rb_test_obj_sub
+/
+drop type rb_test_obj_base
+/
 create type rb_test_obj_elem as object (
   x integer,
   y integer
@@ -57,6 +61,8 @@ create type rb_test_obj as object (
   obj_array_val rb_test_obj_elem_array,
   obj_ary_of_ary_val rb_test_obj_elem_ary_of_ary,
   date_val date,
+  timestamp_val timestamp(9),
+  timestamp_tz_val timestamp(9) with time zone,
 --  date_array_val rb_test_date_array,
 
   constructor function rb_test_obj(n number) return self as result,
@@ -68,19 +74,23 @@ create type rb_test_obj as object (
   member procedure member_proc(n in integer)
 )
 /
-create or replace type body rb_test_obj is
-
+create type body rb_test_obj is
   constructor function rb_test_obj(n number) return self as result is
-    function to_test_date(n number) return date is
-    begin
-      return to_date(to_char(1990 + n, 'FM0000') ||
-                     to_char(mod(round(n) * 5, 12) + 1, 'FM00') ||
-                     to_char(mod(round(n) * 7, 27) + 1, 'FM00') ||
-                     to_char(mod(round(n) * 9, 24), 'FM00') ||
-                     to_char(mod(round(n) * 11, 60), 'FM00') ||
-                     to_char(mod(round(n) * 13, 60), 'FM00'), 'yyyymmddhh24miss');
-    end;
+    str varchar(28);
+    ts timestamp(9);
+    ts_tz timestamp(9) with time zone;
   begin
+    str := to_char(1990 + n, 'FM0000') ||
+                   to_char(mod(round(n) * 5, 12) + 1, 'FM00') ||
+                   to_char(mod(round(n) * 7, 27) + 1, 'FM00') ||
+                   to_char(mod(round(n) * 9, 24), 'FM00') ||
+                   to_char(mod(round(n) * 11, 60), 'FM00') ||
+                   to_char(mod(round(n) * 13, 60), 'FM00') ||
+                   to_char(mod(round(n) * 333333333, 1000000000), 'FM000000000');
+    ts := to_timestamp(str, 'yyyymmddhh24missff9');
+    str := str || to_char(mod(round(n) * 15, 24) - 11, 'FMS00') ||
+                  to_char(mod(round(n) * 17, 60), 'FM00');
+    ts_tz := to_timestamp_tz(str, 'yyyymmddhh24missff9tzhtzm');
     self.int_val := n;
     self.flt_val := n;
     self.num_val := n;
@@ -92,7 +102,9 @@ create or replace type body rb_test_obj is
     self.nclob_val := to_clob(n);
     self.blob_val := to_blob(utl_raw.cast_to_raw(to_char(n)));
     self.obj_val := rb_test_obj_elem(n, n + 1);
-    self.date_val := to_test_date(n);
+    self.date_val := ts;
+    self.timestamp_val := ts;
+    self.timestamp_tz_val := ts_tz;
     if self.int_val != 1 then
       self.int_array_val := rb_test_int_array(n, n + 1, n + 2);
       self.flt_array_val := rb_test_flt_array(n, n + 1, n + 2);
@@ -116,7 +128,7 @@ create or replace type body rb_test_obj is
 
   static function test_object_version return integer is
   begin
-    return 2;
+    return 4;
   end;
 
   static function class_func(n number) return rb_test_obj is
@@ -167,5 +179,21 @@ begin
   end loop;
 end;
 /
-commit
+
+create type rb_test_obj_base as object (
+   id varchar2(30)
+) not final
+/
+create type rb_test_obj_sub under rb_test_obj_base (
+   subid varchar2(30)
+) final
+/
+create or replace function rb_test_obj_get_object(get_base integer) return rb_test_obj_base is
+begin
+  if get_base = 0 then
+    return rb_test_obj_base('base');
+  else
+    return rb_test_obj_sub('sub', 'subid');
+  end if;
+end;
 /

data/test/setup_test_package.sql

@@ -0,0 +1,59 @@
+create or replace package rb_test_pkg is
+  package_version pls_integer := 1;
+
+  type array_of_integer is array(50) of integer;
+  type table_of_pls_integer is table of pls_integer;
+  type table_of_boolean is table of boolean;
+  type indexed_table_of_varchar2 is table of varchar2(10) index by varchar2(5);
+  type rec1 is record (i pls_integer, j integer);
+  type rec2 is record (b boolean, it indexed_table_of_varchar2, rec rec1);
+  type table_of_rec1 is table of rec1;
+  type table_of_rec2 is table of rec2;
+
+  function sum_table_of_pls_integer(tbl in table_of_pls_integer) return pls_integer;
+  function add_rec1_values(tbl in table_of_rec1) return pls_integer;
+  procedure out_rec1_values(tbl out table_of_rec1);
+end;
+/
+create or replace package body rb_test_pkg is
+  function sum_table_of_pls_integer(tbl in table_of_pls_integer) return pls_integer is
+    i pls_integer;
+    ret pls_integer := 0;
+  begin
+    for i in tbl.first..tbl.last loop
+      ret := ret + tbl(i);
+    end loop;
+    return ret;
+  end;
+
+  function add_rec1_values(tbl in table_of_rec1) return pls_integer is
+    i pls_integer;
+    ret pls_integer := 0;
+  begin
+    for i in tbl.first..tbl.last loop
+      ret := ret + nvl(tbl(i).i, 0) + nvl(tbl(i).j, 0);
+    end loop;
+    return ret;
+  end;
+
+  procedure out_rec1_values(tbl out table_of_rec1) is
+    i pls_integer;
+    rec1val rec1;
+  begin
+    tbl := table_of_rec1();
+    for i in 1..20 loop
+      tbl.extend;
+      if i mod 6 != 0 then
+        if i mod 3 != 0 then
+          rec1val.i := i;
+          rec1val.j := i;
+        else
+          rec1val.i := null;
+          rec1val.j := null;
+        end if;
+        tbl(i) := rec1val;
+      end if;
+    end loop;
+  end;
+end;
+/

data/test/test_all.rb

@@ -5,9 +5,11 @@ require "#{srcdir}/config"
 
 require "#{srcdir}/test_oradate"
 require "#{srcdir}/test_oranumber"
+require "#{srcdir}/test_bind_array.rb"
 require "#{srcdir}/test_bind_string"
 require "#{srcdir}/test_bind_time"
 require "#{srcdir}/test_bind_raw"
+require "#{srcdir}/test_bind_integer"
 if $test_clob
   require "#{srcdir}/test_clob"
 end
@@ -24,6 +26,7 @@ require "#{srcdir}/test_oracle_version"
 require "#{srcdir}/test_error"
 require "#{srcdir}/test_connection_pool"
 require "#{srcdir}/test_object"
+require "#{srcdir}/test_properties.rb"
 
 if OCI8.respond_to? :encoding
   require "#{srcdir}/test_encoding"
@@ -31,6 +34,7 @@ end
 
 if $oracle_version >= OCI8::ORAVER_12_1
   require "#{srcdir}/test_package_type"
+  require "#{srcdir}/test_bind_boolean.rb"
 end
 
 # Ruby/DBI

data/test/test_bind_array.rb

@@ -0,0 +1,70 @@
+require 'oci8'
+require File.dirname(__FILE__) + '/config'
+
+class TestBindArray < Minitest::Test
+
+  def test_bind_array_names
+    assert_equal(":id_0", OCI8::in_cond(:id, []).names)
+    assert_equal(":id_0", OCI8::in_cond(:id, [1]).names)
+    assert_equal(":id_0, :id_1", OCI8::in_cond(:id, [1, 2]).names)
+    assert_equal(":id_0, :id_1, :id_2", OCI8::in_cond(:id, [1, 2, 3]).names)
+  end
+
+  def test_bind_array_values
+    assert_equal([[nil, String, nil]], OCI8::in_cond(:id, []).values)
+    assert_equal([[1, nil, nil]], OCI8::in_cond(:id, [1]).values)
+    assert_equal([[1, nil, nil], [2, nil, nil]], OCI8::in_cond(:id, [1, 2]).values)
+    assert_equal([[1, nil, nil], [2, nil, nil], [3, nil, nil]], OCI8::in_cond(:id, [1, 2, 3]).values)
+  end
+
+  def test_bind_array_values_containg_nil
+    assert_equal([[nil, String]], OCI8::in_cond(:id, [nil]).values)
+    assert_equal([[nil, Fixnum], [2, nil, nil], [3, nil, nil]], OCI8::in_cond(:id, [nil, 2, 3]).values)
+    assert_equal([[1, nil, nil], [nil, Fixnum], [3, nil, nil]], OCI8::in_cond(:id, [1, nil, 3]).values)
+  end
+
+  def test_bind_array_values_with_type
+    assert_equal([[nil, Integer, nil]], OCI8::in_cond(:id, [], Integer).values)
+    assert_equal([[1, Integer, nil]], OCI8::in_cond(:id, [1], Integer).values)
+    assert_equal([[1, Integer, nil], [2, Integer, nil]], OCI8::in_cond(:id, [1, 2], Integer).values)
+    assert_equal([[1, Integer, nil], [2, Integer, nil], [3, Integer, nil]], OCI8::in_cond(:id, [1, 2, 3], Integer).values)
+    assert_equal([[nil, Integer, nil], [2, Integer, nil], [3, Integer, nil]], OCI8::in_cond(:id, [nil, 2, 3], Integer).values)
+    assert_equal([[1, Integer, nil], [nil, Integer, nil], [3, Integer, nil]], OCI8::in_cond(:id, [1, nil, 3], Integer).values)
+  end
+
+  def test_select
+    @conn = get_oci8_connection
+    begin
+      drop_table('test_table')
+      @conn.exec(<<EOS)
+CREATE TABLE test_table (ID NUMBER(38))
+EOS
+      cursor = @conn.parse('insert into test_table values(:1)')
+      cursor.bind_param(1, nil, Integer)
+      [1, 3, 5].each do |id|
+        cursor.exec(id)
+      end
+      cursor.close
+
+      [
+       [],
+       [1],
+       [1, 2],
+       [1, 2, 3],
+       [nil],
+       [nil, 2, 3],
+       [1, nil, 3],
+      ].each do |ids|
+        in_cond = OCI8::in_cond(:id, ids)
+        cursor = @conn.exec("select * from test_table where id in (#{in_cond.names}) order by id", *in_cond.values)
+        ([1, 3, 5] & ids).each do |id|
+          assert_equal(id, cursor.fetch[0])
+        end
+      end
+
+      drop_table('test_table')
+    ensure
+      @conn.logoff
+    end
+  end
+end

data/test/test_bind_boolean.rb

@@ -0,0 +1,99 @@
+# Low-level API
+require 'oci8'
+require File.dirname(__FILE__) + '/config'
+
+class TestBindBoolean < Minitest::Test
+  def setup
+    @conn = get_oci8_connection()
+  end
+
+  def test_set_raw
+    stmt = <<EOS
+DECLARE
+  bool_val boolean;
+  int_val pls_integer;
+BEGIN
+  bool_val := :in;
+  IF bool_val THEN
+    int_val := 1;
+  ELSE
+    int_val := 0;
+  END IF;
+  :out := int_val;
+END;
+EOS
+    # explicit bind
+    cursor = @conn.parse(stmt)
+    cursor.bind_param(:in, nil, TrueClass)
+    cursor.bind_param(:out, nil, Integer)
+
+    cursor[:in] = true
+    cursor.exec
+    assert_equal(1, cursor[:out])
+
+    cursor[:in] = false
+    cursor.exec
+    assert_equal(0, cursor[:out])
+
+    # implicit bind
+    do_block_cnt = 0
+    @conn.exec(stmt, true, 0) do |in_val, out_val|
+      assert_equal(true, in_val)
+      assert_equal(1, out_val)
+      do_block_cnt += 1
+    end
+
+    @conn.exec(stmt, false, 0) do |in_val, out_val|
+      assert_equal(false, in_val)
+      assert_equal(0, out_val)
+      do_block_cnt += 1
+    end
+    assert_equal(2, do_block_cnt)
+  end
+
+  def test_get_raw
+    stmt = <<EOS
+DECLARE
+  int_val pls_integer;
+  bool_val boolean;
+BEGIN
+  int_val := :in;
+  IF int_val <> 0 THEN
+    bool_val := TRUE;
+  ELSE
+    bool_val := FALSE;
+  END IF;
+  :out := bool_val;
+END;
+EOS
+    cursor = @conn.parse(stmt)
+    cursor.bind_param(:in, nil, Integer)
+    cursor.bind_param(:out, nil, TrueClass)
+
+    cursor[:in] = 1
+    cursor.exec
+    assert_equal(true, cursor[:out])
+
+    cursor[:in] = 0
+    cursor.exec
+    assert_equal(false, cursor[:out])
+
+    do_block_cnt = 0
+    @conn.exec(stmt, 1, true) do |in_val, out_val|
+      assert_equal(1, in_val)
+      assert_equal(true, out_val)
+      do_block_cnt += 1
+    end
+
+    @conn.exec(stmt, 0, true) do |in_val, out_val|
+      assert_equal(0, in_val)
+      assert_equal(false, out_val)
+      do_block_cnt += 1
+    end
+    assert_equal(2, do_block_cnt)
+  end
+
+  def teardown
+    @conn.logoff
+  end
+end