ruby-oci8 2.2.3 → 2.2.12

data/NEWS

@@ -1,7 +1,300 @@
 # @markup markdown
 
-2.2.3
-=====
+2.2.12 (2022-12-30)
+===================
+
+- Fix warning: undefining the allocator of T_DATA class OraNumber against Ruby 3.2.0dev. (GH-243)
+- Fix warnings on tests and on compile.
+- Remove code for old ruby versions.
+
+2.2.11 (2022-02-22)
+===================
+
+- Fix "No DLL is not foud to hook" when `OCI8.properties[:tcp_keepalive_time]` is set and Oracle client is 21c on Windows.
+
+  (reported at rsim/oracle-enhanced#2262)
+
+- Fix "OCI8.properties[:tcp_keepalive_time] isn't available" error when ruby version is 3.1 on Windows.
+
+2.2.10 (2022-01-12)
+===================
+
+- Use `File.exist?` instead of removed `File.exists?` in Ruby 3.2 (GH-242)
+
+  (contributed by Yasuo Honda)
+
+- Support ruby 3.1 distributed by rubyinstaller.org
+
+- Remove code for obsolete platforms
+  - Ruby compiled by Borland C++
+  - macOS released several years ago
+
+- Detect arm64 macOS shared library in oraconf.rb in preparation for Instant Client for Apple Silicon release.
+
+2.2.9 (2020-12-30)
+==================
+
+- Support [TruffleRuby](https://github.com/oracle/truffleruby).  (GH-225)
+
+  (contributed by Brandon Fish)
+
+- Remove extension libraries for unmaintained ruby versions from binary gems.
+
+Fixed issue
+-----------
+
+- Allow --with-instant-client-dir along with --with-instant-client-lib/include. (GH-223)
+
+  (reported by Victor Nawothnig)
+
+2.2.8 (2020-01-11)
+==================
+
+New features
+------------
+
+* Add support to specify include and lib directories of Oracle library on installation. (GH-210)
+
+  The following three flags are added.
+  
+  * --with-instant-client-dir
+  * --with-instant-client-include
+  * --with-instant-client-lib
+
+Fixed issue
+-----------
+
+- Suppress warnings compiling oci8lib.so (GH-212 and others)
+
+- Fix compilation and tests on Windows.
+
+- Fix spelling in install-instant-client.md (GH-217)
+
+- Use fiddler instead obsolete Win32API on Windows (GH-212)
+
+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 (2018-08-22)
+==================
+
+This release fixed issues about Oracle 18c except one.
+
+Fixed issue
+-----------
+
+### Setting some properties failed with Oracle 18c client
+
+Setting `OCI8::properties[:tcp_keepalive_time]` or `OCI8::properties[:cancel_read_at_exit]`
+failed with the error message "No shared library is found to hook" when Oracle
+client version is 18c.
+(rsim/oracle-enhanced#1754)
+
+### Fix `OCI8#oracle_server_version` to get full version of Oracle 18c
+
+`OCI8#oracle_server_version` returned Oracle version number whose
+number components after the first dot are zeros such as '18.0.0.0.0'
+even when the server version is `18.3.0.0.0`. This issue was fixed by
+using a new OCI function. However the function is available since
+Oracle 18c client. So when the Oracle client version is 12c or earlier
+and the Oracle server version is 18c or later, it cannot get the *full*
+Oracle version number.
+
+### Fix tests when the Oracle server version is 18c.
+
+### LOB#sync, LOB#sync= and LOB#flush do nothing now.
+
+They have not worked by mistake from the beginning because incorrect
+arguments has been passed to OCILobOpen(). Moreover it crashed Oracle
+18c server-side processes and caused "ORA-03113: end-of-file on
+communication channel."
+(github issue #198)
+
+### `unsupported typecode timestamp` when timestamp with time zone is in object type attributes.
+
+(github issue #185)
+
+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.
+
+### Suppress warnings in tests with ruby 2.5
+
+(github issue #180, #181)
+
+2.2.5 (2017-10-21)
+==================
+
+New Features
+------------
+
+### Try to load $ORACLE_HOME/lib/libclntsh.so also when runtime api check is enabled on Unix.
+
+When ruby-oci8 is configured with `--with-runtime-check`, it loads Oracle client
+library and checks available functions in the library at runtime. This feature was
+added to release Windows binary gems which cannot know Oracle version at compile time.
+This is available also on Unix. However it tries to load libraries in LD_LIBRARY_PATH only.
+From this version, it tries to load $ORACLE_HOME/lib/libclntsh.so also.
+
+### Check error reasons when loading failed with 'The specified module could not be found' on Windows.
+
+The error messages are same when OCI.DLL isn't found and when Visual
+C++ runtime library depended on by OCI.DLL isn't found. From this
+version, ruby-oci8 distinguishes the difference and prints other message
+for the latter case.
+
+Fixed issue
+-----------
+
+### Fix segmentation fault when Oracle client library is prelinked.
+
+When Oracle instant client rpm package is used on RHEL5 or RHEL6,
+Oracle client library is modified by [prelink][] and ruby-oci8 crashed
+with segmentation fault. This is not due to Oracle, but due to
+plthook used by ruby-oci8. The plthook was fixed to work with
+prelinked libraries.
+(github issue #172)
+
+[prelink]: https://en.wikipedia.org/wiki/Prelink#Linux
+
+### Fix not to hide the original error message of LoadError on recent cygwin.
+
+Ruby-oci8 tries to check error messages when `require 'oci8lib_xxx.so` fails.
+However the message was hidden by an exception while checking on cygwin.
+(github issue #176)
+
+### Don't call unnecessary __paramGet(i) when a cursor is executed more than once.
+
+pointed by OMOTO Kenji
+(github issue #171)
+
+### Suppress warning: method redefined; discarding old initialize.
+
+(github issue #168)
+
+Other Changes
+-------------
+
+### Add document about the mapping between Oracle number types and Ruby classes.
+
+See {file:docs/number-type-mapping.md Number Type Mapping between Oracle and Ruby}.
+(github issue #173)
+
+2.2.4.1 (2017-06-17)
+====================
+
+Fixed issue
+-----------
+
+### Fix invalid function calls when TCP keepalive time parameter is set on Windows x86
+
+When TCP keepalive time parameter is set, The win32 API `setsockopt` was hooked
+with incorrect calling convention on Windows x86. As far as I checked it doesn't
+cause bad effects. But it is by chance. If the code in `oci.dll` is optimized
+differently, it may cause unexpected behavior.
+
+### Fix compilation errors in 2.2.4 on cygwin
+
+2.2.4 (2017-06-11)
+==================
+
+New Features
+------------
+
+### TCP keepalive parameters
+
+`tcp_keepalive` and `tcp_keepalive_time` parameters were added.
+This may fix hanging caused by a firewall after a long period of inactivity
+
+See {file:docs/hanging-after-inactivity.md this document} for more detail.
+
+### Workaround of function interposition on Linux and macOS
+
+When both `oci8` and `pg` are required and LDAP authentication is used,
+it may trigger segmentation faults or unexpected behaviours.
+This issue was fixed by forcibly modified PLT (Procedure Linkage Table)
+entries in the Oracle client library.
+
+See {file:docs/ldap-auth-and-function-interposition.md this document} for more detail.
+
+Fixed Issues
+------------
+
+### Support RubyInstaller2 for Windows
+
+Fix for RubyInstaller2 for Windows as suggested [here](https://github.com/oneclick/rubyinstaller2/wiki/For-gem-developers#dll-loading).
+
+### Fix for latest cygwin
+
+Use Win32::Registry instead of Win32API to compile ruby-oci8 on the latest cygwin.
+
+(contributed by tomasjura. [github issue #167](https://github.com/kubo/ruby-oci8/issues/167))
+
+### Removed too specific ruby version constraint in binary gems.
+
+(contributed by davidbrs. [github issue #156](https://github.com/kubo/ruby-oci8/issues/156))
+
+2.2.3 (2016-12-27)
+==================
 
 New Features
 ------------
@@ -14,8 +307,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
 ------------
@@ -61,8 +354,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
 ------------
@@ -90,16 +383,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.
@@ -115,8 +408,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
 
@@ -157,8 +450,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
 ------------
@@ -218,8 +511,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
 ------------
@@ -231,8 +524,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
 ------------
@@ -272,8 +565,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
 ------------
@@ -293,8 +586,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
 ------------
@@ -334,8 +627,8 @@ Fixed Issues
 
     (reported by Brian Henderson)
 
-2.1.3
-=====
+2.1.3 (2012-11-11)
+==================
 
 New Features
 ------------
@@ -392,8 +685,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
 ---------------------
@@ -414,8 +707,8 @@ Fixed Issues
 
     (reported by Yasuo Honda)
 
-2.1.1
-=====
+2.1.1 (2012-04-22)
+==================
 
 New Features
 ------------
@@ -462,8 +755,8 @@ Fixed Issues
 
     (repored by Leoš Bitto)
 
-2.1.0
-=====
+2.1.0 (2011-12-13)
+==================
 
 New Features
 ------------
@@ -578,8 +871,8 @@ Fixed Issues
 
     (reported by jbirdjavi)
 
-2.0.6
-=====
+2.0.6 (2011-06-14)
+==================
 
 Fixed issues
 ------------
@@ -590,8 +883,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
 ------------
@@ -679,8 +972,8 @@ Fixed issues
 
     (reported by Sebastian YEPES)
 
-2.0.4
-=====
+2.0.4 (2010-02-28)
+==================
 
 New Features
 ------------
@@ -741,8 +1034,8 @@ Fixed issues
 
     (reported by Raimonds Simanovskis)
 
-2.0.3
-=====
+2.0.3 (2009-10-21)
+==================
 
 Incompatible Changes
 --------------------
@@ -882,8 +1175,8 @@ Fixed installation issues
 
     (reported by Kazuya Teramoto)
 
-2.0.2
-=====
+2.0.2 (2009-05-17)
+==================
 
 *   add new methods
     -   {OCI8#select_one}
@@ -923,8 +1216,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/README.md

@@ -1,5 +1,11 @@
+Ruby-oci8
+=========
+
+[![Gem Version](https://badge.fury.io/rb/ruby-oci8.svg)](http://badge.fury.io/rb/ruby-oci8)
+[![Tests](https://github.com/kubo/ruby-oci8/actions/workflows/tests.yml/badge.svg)](https://github.com/kubo/ruby-oci8/actions/workflows/tests.yml)
+
 What is ruby-oci8
-=================
+-----------------
 
 Ruby-oci8 is a ruby interface for Oracle Database. The latest version
 is available for all Oracle versions after Oracle 10g including Oracle
@@ -11,24 +17,26 @@ Note that ruby 1.8 support was dropped in ruby-oci8 2.2.0.
 Use ruby-oci8 2.1.8 for ruby 1.8.
 
 What's new
-==========
+----------
 
 See {file:NEWS}.
 
 Sample one-liner
-================
+----------------
 
-Connect to scott/tiger, select `emp` and print as CSV format.
+When you have an Oracle database server to which `sqlplus scott/tiger` can connect
+and `scott` user has `emp` table, you can select `emp` and print rows
+as CSV by the followig one liner.
 
     ruby -r oci8 -e "OCI8.new('scott', 'tiger').exec('select * from emp') do |r| puts r.join(','); end"
 
 Homepage
-========
+--------
 
 * http://www.rubydoc.info/github/kubo/ruby-oci8
 
 Installation
-============
+------------
 
 * {file:docs/install-full-client.md Install for Oracle Full Client}
 * {file:docs/install-instant-client.md Install for Oracle Instant Client}
@@ -36,20 +44,23 @@ Installation
 * {file:docs/install-on-osx.md Install on OS X}
 
 Report issues
-=============
+-------------
 
 * {file:docs/report-installation-issue.md Report Installation Issues}
 * [The issues page on github](https://github.com/kubo/ruby-oci8/issues)
 
 Other documents
-===============
+---------------
 
+* {file:docs/number-type-mapping.md Number Type Mapping between Oracle and Ruby}
 * {file:docs/timeout-parameters.md Timeout Parameters}
 * {file:docs/conflicts-local-connections-and-processes.md Conflicts between Local Connections and Child Process Handling on Unix}
+* {file:docs/hanging-after-inactivity.md Hanging After a Long Period of Inactivity}
 * {file:docs/bind-array-to-in_cond.md Bind an Array to IN-condition}
+* {file:docs/ldap-auth-and-function-interposition.md LDAP Authentication and Function Interposition}
 
 License
-=======
+-------
 
 * {file:COPYING 2-clause BSD-style license} from ruby-oci8 2.1.3
 * {file:COPYING_old old Ruby license} until 2.1.2

data/dist-files

@@ -11,12 +11,14 @@ pre-distclean.rb
 ruby-oci8.gemspec
 setup.rb
 docs/bind-array-to-in_cond.md
+docs/conflicts-local-connections-and-processes.md
+docs/hanging-after-inactivity.md
 docs/install-binary-package.md
 docs/install-full-client.md
 docs/install-instant-client.md
 docs/install-on-osx.md
-docs/conflicts-local-connections-and-processes.md
-docs/osx-install-dev-tools.png
+docs/ldap-auth-and-function-interposition.md
+docs/number-type-mapping.md
 docs/platform-specific-issues.md
 docs/report-installation-issue.md
 docs/timeout-parameters.md
@@ -77,16 +79,19 @@ 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
 test/test_all.rb
 test/test_appinfo.rb
 test/test_array_dml.rb
 test/test_bind_array.rb
+test/test_bind_boolean.rb
 test/test_bind_raw.rb
 test/test_bind_string.rb
 test/test_bind_time.rb
+test/test_bind_integer.rb
 test/test_break.rb
 test/test_clob.rb
 test/test_connection_pool.rb
@@ -103,4 +108,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/bind-array-to-in_cond.md

@@ -1,4 +1,4 @@
-@ Bind an Array to IN-condition
+# @title Bind an Array to IN-condition
 
 Bind an Array to IN-condition
 =============================
@@ -27,7 +27,7 @@ The above code is rewritten as follows:
 
     ids = [ ... ] # an arbitrary-length array containing user IDs.
     
-    in_cond = OCI8::in_cond(:id, ids)]
+    in_cond = OCI8::in_cond(:id, ids)
     cursor = conn.exec("select * from users where id in (#{in_cond.names})", *in_cond.values)
 
 or

data/docs/conflicts-local-connections-and-processes.md

@@ -1,7 +1,10 @@
 # @title Conflicts between Local Connections and Child Process Handling on Unix
 
+Conflicts between Local Connections and Child Process Handling on Unix
+======================================================================
+
 Background
-==========
+----------
 
 When a local (not-TCP) Oracle connection is established on Unix,
 Oracle client library changes signal handlers in the process to reap
@@ -9,7 +12,7 @@ all dead child processes. However it conflicts with child process
 handling in ruby.
 
 Problem 1: It trashes child process handling of Open3::popen.
-==========
+----------
 
     require 'oci8'
     require 'open3'
@@ -35,7 +38,7 @@ The above code outputs the following result:
 the child process on the process termination before ruby detects it.
 
 Problem 2: It creates defunct processes after disconnection if signal handlers are reset.
-==========
+----------
 
 The `system` function overwrites signal handlers.
 It fixes the problem 1 as follows.
@@ -80,7 +83,7 @@ If a program repeatedly creates a local connection and disconnects it,
 the number of defunct processes increases gradually.
 
 Solution: BEQUEATH_DETACH=YES
-==========
+----------
 
 By setting [BEQUEATH_DETACH=YES][] in `sqlnet.ora`, Oracle client library
 doesn't change signal handlers. The above two problems are fixed.