ruby-oci8 2.1.3-x86-mingw32 → 2.1.4-x86-mingw32

data/ChangeLog

@@ -1,3 +1,53 @@
+2013-01-06  KUBO Takehiro  <kubo@jiubao.org>
+	* NEWS: add changes between 2.1.4 and 2.1.3
+	* VERSION: change the version to 2.1.4.
+	* docs/platform-specific-issues.md: update solaris-specific document.
+	* ext/oci8/connection_pool.c, ext/oci8/encoding.c, ext/oci8/metadata.c,
+	  ext/oci8/oci8.c,lib/oci8.rb.in, lib/oci8/metadata.rb, lib/oci8/oci8.rb,
+	  lib/oci8/oracle_version.rb, lib/oci8/properties.rb: update comments for yard.
+	* test/test_clob.rb: change a lob size when ORA-24817 is raised to
+	    pass tests on Windows.
+
+2013-01-03  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/oci8.c, lib/oci8/properties.rb: add OCI8.properties[:events_mode]
+	    to support Fast Application Notification (FAN).
+
+2013-01-03  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/extconf.rb, lib/oci8.rb.in: add languange mode to the extension
+	    library name when ths ruby engine is rubinius and explicitly claim that
+	    jruby is not supported when it is jruby.
+
+2013-01-03  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/encoding.c, lib/oci8/encoding-init.rb: delete an internal method
+	    OCI8.nls_ratio= when the ruby is 1.9 or greater. nls_ratio is set by
+	    OCI8.encoding=.
+
+2012-12-23  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/lob.c, ext/oci8/oci8.h, ext/oci8/oci8lib.c, test/test_clob.rb:
+	    fix SEGV when a temporary LOB is freed when OCILobRead returns OCI_NEED_DATA.
+	    (github issue #20 reported by Edgars Beigarts)
+
+2012-12-18  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/error.c, lib/oci8/oci8.rb: change the OCIError constructor to
+	    accept an Oracle error code as the first parameter and create a message
+	    which depends on NLS_LANG.
+	* lib/oci8/metadata.rb: fix OCI8.describe_table not to follow synonyms
+	    until stack overflow. Now the recursive level is limited to 20.
+	    (github issue #26 reported by Brian Henderson)
+
+2012-12-16  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/extconf.rb, lib/oci8.rb.in: use RUBY_VERSION instead of
+	   RbConfig::CONFIG['ruby_version'] to know the ruby ABI version.
+	   The latter may be changed by the configure option --with-ruby-version.
+	   (github issue #24 reported by suhrawardi)
+
+2012-12-03  KUBO Takehiro  <kubo@jiubao.org>
+	* ext/oci8/oraconf.rb: add a script encoding magic comment for ruby 2.0.0 preview2.
+	    (github issue #25 reported by aboltart)
+
+2012-12-02  KUBO Takehiro  <kubo@jiubao.org>
+	* test/test_encoding.rb: fix to pass tests with ruby 2.0.0 preview2.
+
 2012-11-11  KUBO Takehiro  <kubo@jiubao.org>
 	* ext/oci8/lob.c: use OCILobLocatorAssign_nb (non-blocking version)
 	    instead of OCILobLocatorAssign (blocking version).

data/NEWS

@@ -1,5 +1,46 @@
 # @markup markdown
 
+2.1.4
+=====
+
+New Features
+------------
+
+### Fast Application Notification (FAN) support
+
+Look at {http://php.net/manual/en/oci8.connection.php} to know what is FAN.
+[oci8.events](http://php.net/manual/en/oci8.configuration.php#ini.oci8.events) in PHP
+corresponds to {OCI8.properties  OCI8.properties[:events_mode]} in ruby-oci8.
+
+Note: You need to set `OCI8.properties[:events_mode]` after `"require 'oci8'"` and before
+any methods which call Oracle OCI functions.
+
+Fixed Issues
+------------
+
+-   fix SEGV when a temporary LOB is freed when `OCILobRead` returns `OCI_NEED_DATA`.
+    See: [github issue #20](https://github.com/kubo/ruby-oci8/issues/20)
+
+    (reported by Edgars Beigarts)
+
+-   use `RUBY_VERSION` instead of `RbConfig::CONFIG['ruby_version']` to know the
+    ruby ABI version. The latter may be changed by the configure option
+    --with-ruby-version.
+    See: [github issue #24](https://github.com/kubo/ruby-oci8/issues/24)
+
+    (reported by suhrawardi)
+
+-   add a script encoding magic comment for ruby 2.0.0 preview2.
+    See: [github issue #25](https://github.com/kubo/ruby-oci8/issues/25)
+
+    (reported by aboltart)
+
+-   fix {OCI8#describe_table} not to follow synonyms until stack overflow.
+    Now the recursive level is limited to 20.
+    See: [github issue #26](https://github.com/kubo/ruby-oci8/issues/26)
+
+    (reported by Brian Henderson)
+
 2.1.3
 =====
 

data/VERSION

@@ -1 +1 @@
-2.1.3
+2.1.4

data/docs/platform-specific-issues.md

@@ -71,15 +71,23 @@ Solaris
 =======
 
 You need a same compiler which is used to make ruby itself.
-
-There are two ruby packages.
-
-* [Sunfreeware.com](http://www.sunfreeware.com/)
-* [Blastwave.org](http://www.blastwave.org/)
-
-The former is compiled by gcc. The latter is compiled by
-[Sun Studio](http://developers.sun.com/sunstudio/).
-The both compilers are freely available.
+For example, if the ruby is compiled by gcc, you need gcc. If it is compiled by Oracle Solaris Studio
+(formerly called as Sun Studio), you need Oracle Solaris Studio.
+
+If ruby is compiled by gcc and "require 'oci8'" raises "OCI Library Initialization Error",
+you may need to recompile ruby as follows:
+
+    $ bzip2 -dc ruby-1.9.3-pxxx.tar.bz2 | tar xvf -
+    $ cd ruby-1.9.3-pxxx
+    $ vi main.c   # <- Add RUBY_FUNC_EXPORTED just before "int main(..)" as follows:
+    -------------
+    RUBY_FUNC_EXPORTED  /* Add this line */
+    int
+    main(int argc, char **argv)
+    -------------
+    $ ./configure
+    $ make
+    $ make install
 
 If you use Blastwave.org's ruby and want not to install Sun Studio,
 you can edit rbconfig.rb by your self. [(look at here)](http://forum.textdrive.com/viewtopic.php?id=12630)
@@ -91,8 +99,8 @@ If you use Sunfreeware.com's ruby and
 prints "yes", you may need to edit rbconfig.rb distributed with the ruby
 as follows:
 
-   from: CONFIG["LDFLAGS"] = "-L.  -Wl,-E"
-   to:   CONFIG["LDFLAGS"] = "-L. "
+    from: CONFIG["LDFLAGS"] = "-L.  -Wl,-E"
+    to:   CONFIG["LDFLAGS"] = "-L. "
 
 FreeBSD
 =======

data/lib/oci8.rb

@@ -26,14 +26,34 @@ end
 ruby_engine = (defined? RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
 
 so_basename = 'oci8lib_'
-if ruby_engine == 'ruby'
-  # The suffix number indicates the ruby API version.
-  #  1.8   - ruby 1.8.x
-  #  1.9.1 - ruby 1.9.1, 1.9.2
-  #  2.0.0 - ruby 2.0.0-dev at the present time.
+case ruby_engine
+when 'ruby'
+  # The extension library name includes the ruby ABI (application binary interface)
+  # version. It is for binary gems which contain more than one extension library
+  # and use correct one depending on the ABI version.
+  #
+  #  ruby version |  ABI version
+  # --------------+--------------
+  #    1.8.6      |   1.8
+  #    1.8.7      |   1.8
+  # --------------+--------------
+  #    1.9.0      |   1.9.0
+  #    1.9.1      |   1.9.1
+  #    1.9.2      |   1.9.1
+  #    1.9.3      |   1.9.1
+  # --------------+--------------
+  #    2.0.0      |   2.0.0
+  #    2.0.1      |   2.0.1  (See: [ruby-core:49578])
+  #     ...       |    ...
+  #
+  # Note: The ruby ABI version is same with RbConfig::CONFIG['ruby_version']
+  # if it wasn't explicitly changed by the configure option --with-ruby-version.
+  #
   case RUBY_VERSION
   when /^2\.0/
-    so_basename += '200'
+    so_basename += RUBY_VERSION.gsub(/\W/, '')
+  when /^1\.9\.0/
+    raise 'unsupported ruby version: 1.9.0'
   when /^1\.9/
     so_basename += '191'
   when /^1\.8/
@@ -41,15 +61,29 @@ if ruby_engine == 'ruby'
   else
     raise 'unsupported ruby version: ' + RUBY_VERSION
   end
+when 'rbx'
+  # "rbx -X18" and "rbx -X19" use different C header files.
+  case RUBY_VERSION
+  when /^2\.0/
+    so_basename += 'rbx20'
+  when /^1\.9/
+    so_basename += 'rbx19'
+  when /^1\.8/
+    so_basename += 'rbx18'
+  else
+    raise 'unsupported language mode: ' + RUBY_VERSION
+  end
+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."
 else
-  so_basename += ruby_engine
+  raise 'unsupported ruby engine: ' + RUBY_ENGINE
 end
 require so_basename
 
-if OCI8::VERSION != '2.1.3'
+if OCI8::VERSION != '2.1.4'
   require 'rbconfig'
   so_name = so_basename + "." + Config::CONFIG['DLEXT']
-  raise "VERSION MISMATCH! #{so_name} version is #{OCI8::VERSION}, but oci8.rb version is 2.1.3."
+  raise "VERSION MISMATCH! #{so_name} version is #{OCI8::VERSION}, but oci8.rb version is 2.1.4."
 end
 
 require 'oci8/encoding-init.rb'
@@ -89,6 +123,7 @@ class OCI8
   # OCIClientVersion().
   #
   # @return [OCI8::OracleVersion] Oracle client version
+  # @see OCI8#oracle_server_version
   def self.oracle_client_version
     @@oracle_client_version
   end

data/lib/oci8.rb.in

@@ -26,14 +26,34 @@ end
 ruby_engine = (defined? RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
 
 so_basename = 'oci8lib_'
-if ruby_engine == 'ruby'
-  # The suffix number indicates the ruby API version.
-  #  1.8   - ruby 1.8.x
-  #  1.9.1 - ruby 1.9.1, 1.9.2
-  #  2.0.0 - ruby 2.0.0-dev at the present time.
+case ruby_engine
+when 'ruby'
+  # The extension library name includes the ruby ABI (application binary interface)
+  # version. It is for binary gems which contain more than one extension library
+  # and use correct one depending on the ABI version.
+  #
+  #  ruby version |  ABI version
+  # --------------+--------------
+  #    1.8.6      |   1.8
+  #    1.8.7      |   1.8
+  # --------------+--------------
+  #    1.9.0      |   1.9.0
+  #    1.9.1      |   1.9.1
+  #    1.9.2      |   1.9.1
+  #    1.9.3      |   1.9.1
+  # --------------+--------------
+  #    2.0.0      |   2.0.0
+  #    2.0.1      |   2.0.1  (See: [ruby-core:49578])
+  #     ...       |    ...
+  #
+  # Note: The ruby ABI version is same with RbConfig::CONFIG['ruby_version']
+  # if it wasn't explicitly changed by the configure option --with-ruby-version.
+  #
   case RUBY_VERSION
   when /^2\.0/
-    so_basename += '200'
+    so_basename += RUBY_VERSION.gsub(/\W/, '')
+  when /^1\.9\.0/
+    raise 'unsupported ruby version: 1.9.0'
   when /^1\.9/
     so_basename += '191'
   when /^1\.8/
@@ -41,8 +61,22 @@ if ruby_engine == 'ruby'
   else
     raise 'unsupported ruby version: ' + RUBY_VERSION
   end
+when 'rbx'
+  # "rbx -X18" and "rbx -X19" use different C header files.
+  case RUBY_VERSION
+  when /^2\.0/
+    so_basename += 'rbx20'
+  when /^1\.9/
+    so_basename += 'rbx19'
+  when /^1\.8/
+    so_basename += 'rbx18'
+  else
+    raise 'unsupported language mode: ' + RUBY_VERSION
+  end
+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."
 else
-  so_basename += ruby_engine
+  raise 'unsupported ruby engine: ' + RUBY_ENGINE
 end
 require so_basename
 
@@ -89,6 +123,7 @@ class OCI8
   # OCIClientVersion().
   #
   # @return [OCI8::OracleVersion] Oracle client version
+  # @see OCI8#oracle_server_version
   def self.oracle_client_version
     @@oracle_client_version
   end

data/lib/oci8/encoding-init.rb

@@ -39,26 +39,6 @@ class OCI8
     @@client_charset_name = 'US7ASCII'
   end
 
-  # NLS ratio, maximum number of bytes per one chracter
-  case @@client_charset_name
-  when 'UTF8'
-    OCI8.nls_ratio = 3
-  when 'AL16UTF16'
-    OCI8.nls_ratio = 4
-  when /^[[:alpha:]]+(\d+)/
-    # convert maximum number of bits per one chracter to NLS ratio.
-    #   charset name  max bits  max bytes
-    #   ------------  --------  ---------
-    #   US7ASCII          7         1
-    #   WE8ISO8859P1      8         1
-    #   JA16SJIS         16         2
-    #   AL32UTF8         32         4
-    #   ...
-    OCI8.nls_ratio = (($1.to_i + 7) >> 3)
-  else
-    raise "Unknown NLS character set name format: #{@@client_charset_name}"
-  end
-
   # Ruby encoding name for ruby 1.9.
   if OCI8.respond_to? :encoding
     if defined? DEFAULT_OCI8_ENCODING
@@ -75,5 +55,25 @@ class OCI8
       end
     end
     OCI8.encoding = enc
+  else
+    # NLS ratio, maximum number of bytes per one chracter
+    case @@client_charset_name
+    when 'UTF8'
+      OCI8.nls_ratio = 3
+    when 'AL16UTF16'
+      OCI8.nls_ratio = 4
+    when /^[[:alpha:]]+(\d+)/
+      # convert maximum number of bits per one chracter to NLS ratio.
+      #   charset name  max bits  max bytes
+      #   ------------  --------  ---------
+      #   US7ASCII          7         1
+      #   WE8ISO8859P1      8         1
+      #   JA16SJIS         16         2
+      #   AL32UTF8         32         4
+      #   ...
+      OCI8.nls_ratio = (($1.to_i + 7) >> 3)
+    else
+      raise "Unknown NLS character set name format: #{@@client_charset_name}"
+    end
   end
 end

data/lib/oci8/metadata.rb

@@ -1985,72 +1985,115 @@ class OCI8
 =end
   end # OCI8::Metadata
 
-  # return a subclass of OCI8::Metadata::Base
-  # which has information about _object_name_.
-  # OCI8::Metadata::Table, OCI8::Metadata::View,
-  # OCI8::Metadata::Procedure, OCI8::Metadata::Function,
-  # OCI8::Metadata::Package, OCI8::Metadata::Type,
-  # OCI8::Metadata::Synonym or OCI8::Metadata::Sequence
+  # Returns object information.
+  #
+  # The return type is depends on the object type.
+  #
+  # Oracle type:: Ruby type
+  # Table::       {OCI8::Metadata::Table}
+  # View::        {OCI8::Metadata::View}
+  # Procedure::   {OCI8::Metadata::Procedure}
+  # Function::    {OCI8::Metadata::Function}
+  # Package::     {OCI8::Metadata::Package}
+  # Type::        {OCI8::Metadata::Type}
+  # Synonym::     {OCI8::Metadata::Synonym}
+  # Sequence::    {OCI8::Metadata::Sequence}
+  #
+  # @param [String] object_name
+  # @return [a subclass of OCI8::Metadata::Base]
   def describe_any(object_name)
     __describe(object_name, OCI8::Metadata::Unknown, true)
   end
-  # returns a OCI8::Metadata::Table or a OCI8::Metadata::View. If the
-  # name is a current schema's synonym name or a public synonym name,
-  # it returns a OCI8::Metadata::Table or a OCI8::Metadata::View which
+  # Returns table or view information. If the name is a current schema's synonym
+  # name or a public synonym name, it returns table or view information which
   # the synonym refers.
   #
-  # If the second argument is true, this returns a
-  # OCI8::Metadata::Table in the current schema.
+  # If +table_only+ is true, it checks tables in the current schema.
+  #
+  # @param [String] table_name
+  # @param [Boolean] table_only (default: false)
+  # @return [OCI8::Metadata::Table or OCI8::Metadata::View]
   def describe_table(table_name, table_only = false)
     if table_only
       # check my own tables only.
       __describe(table_name, OCI8::Metadata::Table, false)
     else
       # check tables, views, synonyms and public synonyms.
-      metadata = __describe(table_name, OCI8::Metadata::Unknown, true)
-      case metadata
-      when OCI8::Metadata::Table, OCI8::Metadata::View
-        metadata
-      when OCI8::Metadata::Synonym
-        describe_table(metadata.translated_name)
-      else
-        raise OCIError.new("ORA-04043: object #{table_name} does not exist", 4043)
+      recursive_level = 20
+      recursive_level.times do
+        metadata = __describe(table_name, OCI8::Metadata::Unknown, true)
+        case metadata
+        when OCI8::Metadata::Table, OCI8::Metadata::View
+          return metadata
+        when OCI8::Metadata::Synonym
+          table_name = metadata.translated_name
+        else
+          raise OCIError.new(4043, table_name) # ORA-04043: object %s does not exist
+        end
       end
+      raise OCIError.new(36, recursive_level) # ORA-00036: maximum number of recursive SQL levels (%s) exceeded
     end
   end
-  # returns a OCI8::Metadata::View in the current schema.
+  # Returns view information
+  #
+  # @param [String] view_name
+  # @return [OCI8::Metadata::View]
   def describe_view(view_name)
     __describe(view_name, OCI8::Metadata::View, false)
   end
-  # returns a OCI8::Metadata::Procedure in the current schema.
+  # Returns procedure information
+  #
+  # @param [String] procedure_name
+  # @return [OCI8::Metadata::Procedure]
   def describe_procedure(procedure_name)
     __describe(procedure_name, OCI8::Metadata::Procedure, false)
   end
-  # returns a OCI8::Metadata::Function in the current schema.
+  # Returns function information
+  #
+  # @param [String] function_name
+  # @return [OCI8::Metadata::Function]
   def describe_function(function_name)
     __describe(function_name, OCI8::Metadata::Function, false)
   end
-  # returns a OCI8::Metadata::Package in the current schema.
+  # Returns package information
+  #
+  # @param [String] package_name
+  # @return [OCI8::Metadata::Package]
   def describe_package(package_name)
     __describe(package_name, OCI8::Metadata::Package, false)
   end
-  # returns a OCI8::Metadata::Type in the current schema.
+  # Returns type information
+  #
+  # @param [String] type_name
+  # @return [OCI8::Metadata::Type]
   def describe_type(type_name)
     __describe(type_name, OCI8::Metadata::Type, false)
   end
-  # returns a OCI8::Metadata::Synonym in the current schema.
+  # Returns synonym information
+  #
+  # @param [String] synonym_name
+  # @return [OCI8::Metadata::Synonym]
   def describe_synonym(synonym_name, check_public_also = true)
     __describe(synonym_name, OCI8::Metadata::Synonym, check_public_also)
   end
-  # returns a OCI8::Metadata::Sequence in the current schema.
+  # Returns sequence information
+  #
+  # @param [String] sequence_name
+  # @return [OCI8::Metadata::Sequence]
   def describe_sequence(sequence_name)
     __describe(sequence_name, OCI8::Metadata::Sequence, false)
   end
-  # returns a OCI8::Metadata::Schema in the database.
+  # Returns schema information
+  #
+  # @param [String] schema_name
+  # @return [OCI8::Metadata::Schema]
   def describe_schema(schema_name)
     __describe(schema_name, OCI8::Metadata::Schema, false)
   end
-  # returns a OCI8::Metadata::Database.
+  # Returns database information
+  #
+  # @param [String] database_name
+  # @return [OCI8::Metadata::Database]
   def describe_database(database_name)
     __describe(database_name, OCI8::Metadata::Database, false)
   end