ruby-oci8 2.1.8 → 2.2.0.1

data/docs/install-on-osx.md

@@ -0,0 +1,132 @@
+# @title Install ruby-oci8 on OS X
+
+This page explains the way to install ruby-oci8 os OS X.
+
+Look at {file:docs/install-full-client.md}, {file:docs/install-instant-client.md}
+or {file:docs/install-binary-package.md} for other platforms.
+
+Install C compiler
+==================
+
+You need to install the command line developer tools or the Xcode.
+(The latter includes the former.)
+
+Run `"cc --version"` in a terminal to check whether they are installed.
+
+If the cc version is printed, the tools are installed.
+
+If the follwoing dialog is displayed, click its Install button to
+install the tools.
+You have no need to install the Xcode to compile ruby-oci8.
+It requires command line tools, not an IDE such as the Xcode.
+
+![dialog](osx-install-dev-tools.png)
+
+If `"Agreeing to the Xcode/iOS license requires admin privileges,
+please re-run as root via sudo."` is printed, you need to run
+`"sudo cc --version"`, enter your password, look at the license
+and type `"agree"`.
+
+Install Oracle Instant Client Packages
+======================================
+
+Download Oracle Instant Client Packages
+--------------------------------
+
+Download the following packages from [Oracle Technology Network][]
+
+* Instant Client Package - Basic or Basic Lite
+* Instant Client Package - SDK
+* Instant Client Package - SQL*Plus (optionally)
+
+Install Oracle Instant Client Packages via Homebrew
+---------------------------------------------------
+
+To install `Oracle Instant Client Basic Lite` via [Homebrew][]
+
+* Download two instant client packages: `Basic Lite` and `SDK` and put them
+  in `/Library/Caches/Homebrew` (if the environment variable `HOMEBREW_CACHE`
+  is not set and `$HOME/Library/Caches/Homebrew` doesn't exist.)
+* Run the followining commands:
+
+        brew install InstantClientTap/instantclient/instantclient-basiclite
+        brew install InstantClientTap/instantclient/instantclient-sdk
+
+To install `Oracle Instant Client Basic` via [Homebrew][]
+
+* Download *three* instant client packages: `Basic`, `Basic Lite` and `SDK`
+  and put them in `/Library/Caches/Homebrew` (if the environment variable
+  `HOMEBREW_CACHE` is not set and `$HOME/Library/Caches/Homebrew` doesn't exist.)
+* Run the followining commands:
+
+        brew install InstantClientTap/instantclient/instantclient-basic
+        brew install InstantClientTap/instantclient/instantclient-sdk
+        
+* Set the environment variable OCI_DIR while performing the following installation steps
+  if Homebrew is installed outside `/usr/local`.
+
+        export OCI_DIR=$(brew --prefix)/lib
+
+Install Oracle Instant Client Manually
+---------------------
+
+If you don't use [Homebrew][], do the following:
+
+Unzip the packages as follows:
+
+    mkdir /opt
+    mkdir /opt/oracle
+    cd /opt/oracle
+
+Copy downloaded files to /opt/oracle before running the following commands.
+
+    unzip instantclient-basic-macos.x64-11.2.0.4.0.zip
+    unzip instantclient-sdk-macos.x64-11.2.0.4.0.zip
+    unzip instantclient-sqlplus-macos.x64-11.2.0.4.0.zip
+
+Make a symbolic link to link the library.
+
+    cd /opt/oracle/instantclient11_2
+    ln -s libclntsh.dylib.11.1 libclntsh.dylib
+
+Fix the library install and identification names using [fix_oralib][] to make them work
+without `DYLD_LIBRARY_PATH`.
+
+    cd /opt/oracle/instantclient11_2
+    curl -O https://raw.githubusercontent.com/kubo/fix_oralib_osx/master/fix_oralib.rb
+    ruby fix_oralib.rb
+
+Set the environment variable OCI_DIR while performing the following installation steps.
+
+    export OCI_DIR=/opt/oracle/instantclient11_2
+
+Installation
+============
+
+If you get a problem in the following steps, look at {file:docs/report-installation-issue.md}.
+
+gem package
+-----------
+
+Run the following command.
+
+    gem install ruby-oci8
+
+tar.gz package
+--------------
+
+### Download the source code
+
+Download the latest tar.gz package from [download page][].
+
+### Run make and install
+
+    tar xvfz ruby-oci8-VERSION.tar.gz
+    cd ruby-oci8-VERSION
+    make
+    make install
+
+[download page]: https://bintray.com/kubo/generic/ruby-oci8
+[Homebrew]: http://brew.sh/
+[fix_oralib]: https://github.com/kubo/fix_oralib_osx
+[Oracle Technology Network]: http://www.oracle.com/technetwork/topics/intel-macsoft-096467.html

data/docs/report-installation-issue.md

@@ -1,13 +1,10 @@
 # @title Report Installation Issues
 
-Look at {file:docs/platform-specific-issues.md},
-[the issues page on github][github] and [the ruby-oci8 help forum on rubyforge][rubyforge]
-to check whether your issue is fixed or not.
+Look at {file:docs/platform-specific-issues.md} and [the issues page on github][github] to check whether your issue is fixed or not.
 
 If it is a new one, post the following information to [github][].
 
 [github]: https://github.com/kubo/ruby-oci8/issues
-[rubyforge]: http://rubyforge.org/forum/forum.php?forum_id=1078
 
 *    Messages printed out to the console
 

data/ext/oci8/apiwrap.c.tmpl

@@ -4,11 +4,7 @@
 %>
 #define API_WRAP_C 1
 #include "apiwrap.h"
-#ifdef NATIVE_THREAD_WITH_GVL
 #define BLOCKING_FUNCTION_EPILOGUE(svcctx) do { (svcctx)->executing_thread = Qnil; } while (0)
-#else
-#define BLOCKING_FUNCTION_EPILOGUE(svcctx) do { } while (0)
-#endif
 
 <%
 prev_name = ''

data/ext/oci8/apiwrap.yml

@@ -312,15 +312,6 @@ OCILobFileSetName:
             - CONST text *filename
             - ub2 f_length
 
-# round trip: 1
-OCILobGetLength_nb:
-  :version: 800
-  :args:
-            - OCISvcCtx *svchp
-            - OCIError *errhp
-            - OCILobLocator *locp
-            - ub4 *lenp
-
 # round trip: 0
 OCILobLocatorIsInit:
   :version: 800
@@ -330,48 +321,6 @@ OCILobLocatorIsInit:
             - CONST OCILobLocator *locp
             - boolean *is_initialized
 
-# round trip: 0 or 1
-OCILobRead_nb:
-  :version: 800
-  :args:
-            - OCISvcCtx *svchp
-            - OCIError *errhp
-            - OCILobLocator *locp
-            - ub4 *amtp
-            - ub4 offset
-            - dvoid *bufp
-            - ub4 bufl
-            - dvoid *ctxp
-            - OCICallbackLobRead cbfp
-            - ub2 csid
-            - ub1 csfrm
-
-# round trip: 1
-OCILobTrim_nb:
-  :version: 800
-  :args:
-            - OCISvcCtx *svchp
-            - OCIError *errhp
-            - OCILobLocator *locp
-            - ub4 newlen
-
-# round trip: 0 or 1
-OCILobWrite_nb:
-  :version: 800
-  :args:
-            - OCISvcCtx *svchp
-            - OCIError *errhp
-            - OCILobLocator *locp
-            - ub4 *amtp
-            - ub4 offset
-            - dvoid *bufp
-            - ub4 buflen
-            - ub1 piece
-            - dvoid *ctxp
-            - OCICallbackLobWrite cbfp
-            - ub2 csid
-            - ub1 csfrm
-
 # round trip: 1
 OCILogoff:
   :version: 800
@@ -874,16 +823,6 @@ OCIStmtGetPieceInfo:
             - ub4 *idxp
             - ub1 *piecep
 
-OCIStmtPrepare:
-  :version: 800
-  :args:
-            - OCIStmt *stmtp
-            - OCIError *errhp
-            - CONST text *stmt
-            - ub4 stmt_len
-            - ub4 language
-            - ub4 mode
-
 OCIStmtSetPieceInfo:
   :version: 800
   :args:
@@ -1343,7 +1282,8 @@ OCINlsCharSetNameToId:
             - dvoid *envhp
             - const oratext *name
 
-OCIStmtPrepare2_nb:
+# round trip: 0
+OCIStmtPrepare2:
   :version: 920
   :args:
             - OCISvcCtx *svchp

data/ext/oci8/bind.c

@@ -421,7 +421,5 @@ void Init_oci8_bind(VALUE klass)
     /* register primitive data types. */
     oci8_define_bind_class("String", &bind_string_data_type, bind_string_alloc);
     oci8_define_bind_class("RAW", &bind_raw_data_type, bind_raw_alloc);
-    if (oracle_client_version >= ORAVER_10_1) {
-        oci8_define_bind_class("BinaryDouble", &bind_binary_double_data_type, bind_binary_double_alloc);
-    }
+    oci8_define_bind_class("BinaryDouble", &bind_binary_double_data_type, bind_binary_double_alloc);
 }

data/ext/oci8/encoding.c

@@ -14,17 +14,7 @@
 /* NLS ratio, maximum number of bytes per one chracter */
 int oci8_nls_ratio = 1;
 
-/* Oracle charset id -> Oracle charset name */
-static VALUE csid2name;
-
-/* Oracle charset name -> Oracle charset id */
-static ID id_upcase;
-static VALUE csname2id;
-static VALUE oci8_charset_name2id(VALUE svc, VALUE name);
-#ifdef HAVE_TYPE_RB_ENCODING
 rb_encoding *oci8_encoding;
-#endif
-
 
 /*
  * call-seq:
@@ -33,72 +23,21 @@ rb_encoding *oci8_encoding;
  * Returns the Oracle character set name from the specified
  * character set ID if it is valid. Otherwise, +nil+ is returned.
  *
- * === Oracle 9iR2 client or upper
- *
- * It is done by using the mapping table stored in the client side.
- *
- * === Oracle 9iR1 client or lower
- *
- * It executes the following PL/SQL block internally to use
- * the mapping table stored in the server side.
- *
- *   BEGIN
- *     :name := nls_charset_name(:csid);
- *   END;
- *
  * @param [Fixnum] charset_id   Oracle character set id
  * @return [String]             Oracle character set name or nil
- * @since 2.0.0
+ * @since 2.2.0
  */
-VALUE oci8_charset_id2name(VALUE svc, VALUE csid)
+VALUE oci8_s_charset_id2name(VALUE klass, VALUE csid)
 {
-    VALUE name = rb_hash_aref(csid2name, csid);
+    char buf[OCI_NLS_MAXBUFSZ];
+    sword rv;
 
-    if (!NIL_P(name)) {
-        return name;
-    }
     Check_Type(csid, T_FIXNUM);
-    if (have_OCINlsCharSetIdToName) {
-        /* Oracle 9iR2 or upper */
-        char buf[OCI_NLS_MAXBUFSZ];
-        sword rv;
-
-        rv = OCINlsCharSetIdToName(oci8_envhp, TO_ORATEXT(buf), sizeof(buf), (ub2)FIX2INT(csid));
-        if (rv != OCI_SUCCESS) {
-            return Qnil;
-        }
-        name = rb_usascii_str_new_cstr(buf);
-    } else {
-        /* Oracle 9iR1 or lower */
-        oci8_exec_sql_var_t bind_vars[2];
-        char buf[OCI_NLS_MAXBUFSZ];
-        ub2 buflen = 0;
-        int ival = FIX2INT(csid);
-
-        /* :name */
-        bind_vars[0].valuep = buf;
-        bind_vars[0].value_sz = OCI_NLS_MAXBUFSZ;
-        bind_vars[0].dty = SQLT_CHR;
-        bind_vars[0].indp = NULL;
-        bind_vars[0].alenp = &buflen;
-        /* :csid */
-        bind_vars[1].valuep = &ival;
-        bind_vars[1].value_sz = sizeof(int);
-        bind_vars[1].dty = SQLT_INT;
-        bind_vars[1].indp = NULL;
-        bind_vars[1].alenp = NULL;
-
-        /* convert chaset id to charset name by querying Oracle server. */
-        oci8_exec_sql(oci8_get_svcctx(svc), "BEGIN :name := nls_charset_name(:csid); END;", 0, NULL, 2, bind_vars, 1);
-        if (buflen == 0) {
-            return Qnil;
-        }
-        name = rb_usascii_str_new(buf, buflen);
+    rv = OCINlsCharSetIdToName(oci8_envhp, TO_ORATEXT(buf), sizeof(buf), (ub2)FIX2INT(csid));
+    if (rv != OCI_SUCCESS) {
+        return Qnil;
     }
-    OBJ_FREEZE(name);
-    rb_hash_aset(csid2name, csid, name);
-    rb_hash_aset(csname2id, name, csid);
-    return name;
+    return rb_usascii_str_new_cstr(buf);
 }
 
 /*
@@ -108,70 +47,19 @@ VALUE oci8_charset_id2name(VALUE svc, VALUE csid)
  * Returns the Oracle character set ID for the specified Oracle
  * character set name if it is valid. Othewise, +nil+ is returned.
  *
- * === Oracle 9iR2 client or upper
- *
- * It is done by using the mapping table stored in the client side.
- *
- * === Oracle 9iR1 client or lower
- *
- * It executes the following PL/SQL block internally to use
- * the mapping table stored in the server side.
- *
- *   BEGIN
- *     :csid := nls_charset_id(:name);
- *   END;
- *
  * @param [String] charset_name   Oracle character set name
  * @return [Fixnum]               Oracle character set id or nil
- * @since 2.0.0
+ * @since 2.2.0
  */
-static VALUE oci8_charset_name2id(VALUE svc, VALUE name)
+static VALUE oci8_s_charset_name2id(VALUE klass, VALUE name)
 {
-    VALUE csid;
-
-    name = rb_funcall(name, id_upcase, 0);
-    csid = rb_hash_aref(csname2id, StringValue(name));
-    if (!NIL_P(csid)) {
-        return csid;
-    }
-    if (have_OCINlsCharSetNameToId) {
-        /* Oracle 9iR2 or upper */
-        ub2 rv;
-
-        rv = OCINlsCharSetNameToId(oci8_envhp, RSTRING_ORATEXT(name));
-        if (rv == 0) {
-            return Qnil;
-        }
-        csid = INT2FIX(rv);
-    } else {
-        /* Oracle 9iR1 or lower */
-        oci8_exec_sql_var_t bind_vars[2];
-        int ival;
-        sb2 ind = 0; /* null indicator */
+    ub2 rv;
 
-        /* :csid */
-        bind_vars[0].valuep = &ival;
-        bind_vars[0].value_sz = sizeof(int);
-        bind_vars[0].dty = SQLT_INT;
-        bind_vars[0].indp = &ind;
-        bind_vars[0].alenp = NULL;
-        /* :name */
-        bind_vars[1].valuep = RSTRING_PTR(name);
-        bind_vars[1].value_sz = RSTRING_LEN(name);
-        bind_vars[1].dty = SQLT_CHR;
-        bind_vars[1].indp = NULL;
-        bind_vars[1].alenp = NULL;
-
-        /* convert chaset name to charset id by querying Oracle server. */
-        oci8_exec_sql(oci8_get_svcctx(svc), "BEGIN :csid := nls_charset_id(:name); END;", 0, NULL, 2, bind_vars, 1);
-        if (ind) {
-            return Qnil;
-        }
-        csid = INT2FIX(ival);
+    rv = OCINlsCharSetNameToId(oci8_envhp, TO_ORATEXT(StringValueCStr(name)));
+    if (rv == 0) {
+        return Qnil;
     }
-    rb_hash_aset(csid2name, csid, name);
-    rb_hash_aset(csname2id, name, csid);
-    return csid;
+    return INT2FIX(rv);
 }
 
 /*
@@ -192,33 +80,6 @@ static VALUE oci8_get_nls_ratio(VALUE klass)
     return INT2NUM(oci8_nls_ratio);
 }
 
-#ifndef HAVE_TYPE_RB_ENCODING
-/*
- * call-seq:
- *   OCI8.nls_ratio = integer
- *
- * Sets NLS ratio, maximum number of bytes per one character of the
- * current NLS chracter set. It is initialized in 'oci8/encoding-init.rb'
- * when oci8 is required. You have no need to set it explicitly.
- *
- * @param [Fixnum] integer  NLS ratio
- * @since 2.1.0
- * @private
- * @note ruby 1.8 only
- */
-static VALUE oci8_set_nls_ratio(VALUE klass, VALUE val)
-{
-    int v = NUM2INT(val);
-    if (v <= 0) {
-        rb_raise(rb_eRangeError, "expected a positive integer but %d", v);
-    }
-    oci8_nls_ratio = v;
-    return val;
-}
-#endif
-
-#ifdef HAVE_TYPE_RB_ENCODING
-
 /*
  * call-seq:
  *    OCI8.encoding -> enc
@@ -280,7 +141,43 @@ static VALUE oci8_set_encoding(VALUE klass, VALUE encoding)
     }
     return encoding;
 }
-#endif
+
+/*
+ * call-seq:
+ *   charset_name2id(charset_name) -> charset_id
+ *
+ * Returns the Oracle character set ID for the specified Oracle
+ * character set name if it is valid. Othewise, +nil+ is returned.
+ *
+ * @param [String] charset_name   Oracle character set name
+ * @return [Fixnum]               Oracle character set id or nil
+ * @since 2.0.0
+ * @deprecated Use {OCI8.charset_name2id} instead.
+ */
+static VALUE oci8_charset_name2id(VALUE svc, VALUE name)
+{
+    rb_warning("Use OCI8.charset_name2id instead of OCI8#charset_name2id.");
+    return oci8_s_charset_name2id(Qnil, name);
+}
+
+/*
+ * call-seq:
+ *   charset_id2name(charset_id) -> charset_name
+ *
+ * Returns the Oracle character set name from the specified
+ * character set ID if it is valid. Otherwise, +nil+ is returned.
+ *
+ * @param [Fixnum] charset_id   Oracle character set id
+ * @return [String]             Oracle character set name or nil
+ * @since 2.0.0
+ * @deprecated Use {OCI8.charset_id2name} instead.
+ */
+static VALUE oci8_charset_id2name(VALUE svc, VALUE name)
+{
+    rb_warning("Use OCI8.charset_id2name instead of OCI8#charset_id2name.");
+    return oci8_s_charset_id2name(Qnil, name);
+}
+
 
 void Init_oci8_encoding(VALUE cOCI8)
 {
@@ -288,21 +185,12 @@ void Init_oci8_encoding(VALUE cOCI8)
     oci8_cOCIHandle = rb_define_class("OCIHandle", rb_cObject);
     cOCI8 = rb_define_class("OCI8", oci8_cOCIHandle);
 #endif
-    csid2name = rb_hash_new();
-    rb_global_variable(&csid2name);
-
-    id_upcase = rb_intern("upcase");
-    csname2id = rb_hash_new();
-    rb_global_variable(&csname2id);
 
-    rb_define_method(cOCI8, "charset_name2id", oci8_charset_name2id, 1);
-    rb_define_method(cOCI8, "charset_id2name", oci8_charset_id2name, 1);
+    rb_define_singleton_method(cOCI8, "charset_name2id", oci8_s_charset_name2id, 1);
+    rb_define_singleton_method(cOCI8, "charset_id2name", oci8_s_charset_id2name, 1);
     rb_define_singleton_method(cOCI8, "nls_ratio", oci8_get_nls_ratio, 0);
-#ifndef HAVE_TYPE_RB_ENCODING
-    rb_define_singleton_method(cOCI8, "nls_ratio=", oci8_set_nls_ratio, 1);
-#endif
-#ifdef HAVE_TYPE_RB_ENCODING
     rb_define_singleton_method(cOCI8, "encoding", oci8_get_encoding, 0);
     rb_define_singleton_method(cOCI8, "encoding=", oci8_set_encoding, 1);
-#endif
+    rb_define_method(cOCI8, "charset_name2id", oci8_charset_name2id, 1);
+    rb_define_method(cOCI8, "charset_id2name", oci8_charset_id2name, 1);
 }