ruby-oci8 2.1.0 → 2.1.1

data/lib/oci8/oracle_version.rb

@@ -2,14 +2,16 @@
 #
 # Copyright (C) 2009 KUBO Takehiro <kubo@jiubao.org>
 
-#--
-
+#
 class OCI8
 
-  # A data class, representing Oracle version.
+  # The data class, representing Oracle version.
   #
   # Oracle version is represented by five numbers:
   # *major*, *minor*, *update*, *patch* and *port_update*.
+  #
+  # @see OCI8.oracle_client_version
+  # @see OCI8#oracle_server_version
   class OracleVersion
     include Comparable
 
@@ -24,7 +26,7 @@ class OCI8
     # The fourth part of the Oracle version.
     attr_reader :port_update
 
-    # Creates a OCI8::OracleVersion object.
+    # Creates an OCI8::OracleVersion object.
     #
     # If the first argument _arg_ is a String, it is parsed as dotted
     # version string. If it is bigger than 0x08000000, it is parsed as
@@ -33,20 +35,32 @@ class OCI8
     # patch and port_update. Unspecified version numbers are zeros by
     # default.
     #
-    # == Example
-    #   oraver = OCI8::OracleVersion.new('10.2.0.4')
-    #   oraver.major       # => 10
+    # @example
+    #   # When the first argument is a String,
+    #   oraver = OCI8::OracleVersion.new('11.2.0.3')
+    #   oraver.major       # => 11
+    #   oraver.minor       # =>  2
+    #   oraver.update      # =>  0
+    #   oraver.patch       # =>  3
+    #   oraver.port_update # =>  0
+    #
+    #   # When the first argument is bigger than 0x08000000,
+    #   oraver = OCI8::OracleVersion.new(0x0b200300)
+    #   oraver.major       # => 11
     #   oraver.minor       # =>  2
     #   oraver.update      # =>  0
-    #   oraver.patch       # =>  4
+    #   oraver.patch       # =>  3
     #   oraver.port_update # =>  0
     #
-    #   oraver = OCI8::OracleVersion.new(0x0a200400)
-    #   oraver.major       # => 10
+    #   # Otherwise,
+    #   oraver = OCI8::OracleVersion.new(11, 2, 0, 3)
+    #   oraver.major       # => 11
     #   oraver.minor       # =>  2
     #   oraver.update      # =>  0
-    #   oraver.patch       # =>  4
+    #   oraver.patch       # =>  3
     #   oraver.port_update # =>  0
+    #
+    # @return [OCI8::OracleVersion]
     def initialize(arg, minor = nil, update = nil, patch = nil, port_update = nil)
       if arg.is_a? String
         major, minor, update, patch, port_update = arg.split('.').collect do |v|
@@ -68,13 +82,12 @@ class OCI8
       @port_update = port_update || 0
     end
 
-    # :call-seq:
-    #   oraver <=> other_oraver -> -1, 0, +1
-    #
-    # Compares +oraver+ and +other_oraver+.
+    # Compares +self+ and +other+.
     #
     # <=> is the basis for the methods <, <=, ==, >, >=, and between?,
-    # included from module Comparable.
+    # included from the Comparable module.
+    #
+    # @return [-1, 0, +1]
     def <=>(other)
       cmp = @major <=> other.major
       return cmp if cmp != 0
@@ -87,57 +100,50 @@ class OCI8
       @port_update <=> other.port_update
     end
 
-    # :call-seq:
-    #   oraver.to_i -> integer
-    #
     # Returns an integer number contains 5-digit Oracle version.
     #
     # If the hexadecimal notation is 0xAABCCDEE, *major*, *minor*,
     # *update*, *patch* and *port_update* are 0xAA, 0xB, 0xCC, 0xD and
     # 0xEE respectively.
     #
-    # == Example
-    #   oraver = OCI8::OracleVersion.new('10.2.0.4')
-    #   oraver.to_i          # => 169870336
-    #   '%08x' % oraver.to_i # => "0a200400"
+    # @example
+    #   oraver = OCI8::OracleVersion.new('11.2.0.3')
+    #   oraver.to_i          # => 186647296
+    #   '%08x' % oraver.to_i # => "0b200300"
+    #
+    # @return [Integer]
     def to_i
       (@major << 24) | (@minor << 20) | (@update << 12) | (@patch << 8) | @port_update
     end
 
-    # :call-seq:
-    #   oraver.to_s -> string
-    #
     # Returns a dotted version string of the Oracle version.
     #
-    # == Example
-    #   oraver = OCI8::OracleVersion.new('10.2.0.4')
-    #   oraver.to_s          # => '10.2.0.4.0'
+    # @example
+    #   oraver = OCI8::OracleVersion.new('11.2.0.3')
+    #   oraver.to_s          # => '11.2.0.3.0'
+    #
+    # @return [Integer]
     def to_s
       format('%d.%d.%d.%d.%d', @major, @minor, @update, @patch, @port_update)
     end
 
-    # :call-seq:
-    #   oraver.eql? other -> true or false
-    #
-    # Returns true if +oraver+ and +other+ are the same type and have
+    # Returns true if +self+ and +other+ are the same type and have
     # equal values.
-    #--
-    # This is for class Hash to test members for equality.
+    #
+    # @return [true or false]
     def eql?(other)
       other.is_a? OCI8::OracleVersion and (self <=> other) == 0
     end
 
-    # :call-seq:
-    #   oraver.hash -> integer
+    # Returns a hash based on the value of +self+.
     #
-    # Returns a hash based on the value of +oraver+.
-    #--
-    # This is for class Hash.
+    # @return [Integer]
     def hash
       to_i
     end
 
-    def inspect # :nodoc:
+    # @private
+    def inspect
       "#<#{self.class.to_s}: #{self.to_s}>"
     end
   end

data/lib/oci8/properties.rb

@@ -2,14 +2,20 @@
 #
 # Copyright (C) 2010-2011 KUBO Takehiro <kubo@jiubao.org>
 
+#
 class OCI8
 
   @@properties = {
     :length_semantics => :byte,
     :bind_string_as_nchar => false,
     :float_conversion_type => :ruby,
+    :statement_cache_size => 20,
   }
 
+  if OCI8.oracle_client_version < OCI8::ORAVER_9_2
+    @@properties[:statement_cache_size] = nil
+  end
+
   def @@properties.[](name)
     raise IndexError, "No such property name: #{name}" unless @@properties.has_key?(name)
     super(name)
@@ -27,6 +33,12 @@ class OCI8
     when :float_conversion_type
       # handled by native code in oci8lib_xx.so.
       OCI8.__set_property(name, val)
+    when :statement_cache_size
+      if OCI8.oracle_client_version < OCI8::ORAVER_9_2
+        raise RuntimeError, ":statement_cache_size is disabled on Oracle 9iR1 client."
+      end
+      val = val.to_i
+      raise ArgumentError, "The property value for :statement_cache_size must not be negative." if val < 0
     end
     super(name, val)
   end
@@ -74,6 +86,13 @@ class OCI8
   #     15.700000000000001 by Float#to_s.
   #     See: http://rubyforge.org/forum/forum.php?thread_id=50030&forum_id=1078
   #
+  # [:statement_cache_size]
+  #     (new in 2.1.1)
+  #     
+  #     The statement cache size per each session. The default value is 20 statements.
+  #     This feature is available on Oracle 9iR2 or later.
+  #     See: http://docs.oracle.com/cd/E11882_01/appdev.112/e10646/oci09adv.htm#i471377
+  #
   def self.properties
     @@properties
   end

data/pre-distclean.rb

@@ -1,7 +1,7 @@
 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"
 if RUBY_PLATFORM =~ /cygwin/
   rm_f "#{curr_objdir}/ext/oci8/OCI.def"
   rm_f "#{curr_objdir}/ext/oci8/libOCI.a"
-else
-  rm_f "#{curr_objdir}/ext/oci8/oracle_objs.a"
 end

data/ruby-oci8.gemspec

@@ -31,7 +31,7 @@ spec = Gem::Specification.new do |s|
   s.description = <<EOS
 ruby-oci8 is a ruby interface for Oracle using OCI8 API. It is available with Oracle8, Oracle8i, Oracle9i, Oracle10g and Oracle Instant Client.
 EOS
-  s.has_rdoc = true
+  s.has_rdoc = 'yard'
   s.authors = ['KUBO Takehiro']
   s.platform = gem_platform
   files = File.read('dist-files').split("\n")
@@ -54,6 +54,10 @@ EOS
     else
       raise "No compiled binary are found. Run make in advance."
     end
+    # add map files to analyze a core (minidump) file.
+    so_files << 'ext/oci8/oci8lib_18.map' if has_1_8 and File.exists? 'ext/oci8/oci8lib_18.map'
+    so_files << 'ext/oci8/oci8lib_191.map' if has_1_9_1 and File.exists? 'ext/oci8/oci8lib_191.map'
+
     FileUtils.copy so_files, 'lib', :preserve => true
     files.reject! do |fname|
       fname =~ /^ext/
@@ -63,8 +67,8 @@ EOS
     end
     files << 'lib/oci8.rb'
   end
+  s.require_paths = ['lib', 'ext/oci8']
   s.files = files
   s.test_files = 'test/test_all.rb'
-  s.rdoc_options = ['--main', 'README']
-  s.extra_rdoc_files = ['README']
+  s.extra_rdoc_files = ['README.md']
 end

data/test/config.rb

@@ -13,12 +13,7 @@ ENV['ORA_NCHAR_LITERAL_REPLACE'] = 'TRUE' if OCI8.client_charset_name.include? '
 nls_lang = ENV['NLS_LANG']
 nls_lang = nls_lang.split('.')[1] unless nls_lang.nil?
 nls_lang = nls_lang.upcase unless nls_lang.nil?
-case nls_lang
-when 'JA16EUC'
-  $lobfile = File.dirname(__FILE__) + '/../doc/api.ja.rd' # EUC-JP file
-else
-  $lobfile = File.dirname(__FILE__) + '/../doc/api.en.rd' # ASCII file
-end
+$lobfile = File.dirname(__FILE__) + '/../setup.rb'
 $lobreadnum = 256 # counts in charactors
 
 # don't modify below.

data/test/test_datetime.rb

@@ -13,15 +13,22 @@ class TestDateTime < Test::Unit::TestCase
     end
   end
 
+  @@time_new_accepts_timezone = begin
+                                  Time.new(2001, 1, 1, 0, 0, 0, '+00:00')
+                                  true
+                                rescue
+                                  false
+                                end
+
   def string_to_time(str)
-    /(\d+)-(\d+)-(\d+) ?(?:(\d+):(\d+):(\d+))?(?:\.(\d+))? ?([+-]\d+:\d+)?/ =~ str
+    /(\d+)-(\d+)-(\d+) ?(?:(\d+):(\d+):(\d+))?(?:\.(\d+))? ?(([+-])(\d+):(\d+))?/ =~ str
     args = []
     args << $1.to_i # year
     args << $2.to_i # month
     args << $3.to_i # day
     args << $4.to_i if $4 # hour
     args << $5.to_i if $5 # minute
-    if $8
+    if $8 and @@time_new_accepts_timezone
       args << $6.to_i + $7.to_i.to_r / ('1' + '0' * ($7.length)).to_i
       args << $8
       Time.new(*args)
@@ -32,15 +39,37 @@ class TestDateTime < Test::Unit::TestCase
       if $7
         args << $7.to_i.to_r * 1000000 / ('1' + '0' * ($7.length)).to_i
       end
-      # no time zone
-      Time.local(*args)
+      if $8
+        # with time zone
+        offset = ($9 + '1').to_i * ($10.to_i * 60 + $11.to_i)
+        if offset == 0
+          Time.utc(*args)
+        else
+          tm = Time.local(*args)
+          raise "Failed to convert #{str} to Time" if tm.utc_offset != offset * 60
+          tm
+        end
+      else
+        # without time zone
+        Time.local(*args)
+      end
     end
     #Time.local(*str.split(/[- :\.]/).collect do |n| n.to_i; end)
   end
 
+  def string_to_datetime(str)
+    /(\d+-\d+-\d+ ?(?:\d+:\d+:\d+)?(?:\.\d+)?) ?([+-]\d+:\d+)?/ =~ str
+    if $2
+      # with time zone
+      DateTime.parse(str)
+    else
+      tm = string_to_time(str)
+      DateTime.parse(str + timezone_string(*((tm.utc_offset / 60).divmod 60)))
+    end
+  end
+
   def setup
     @conn = get_oci8_connection
-    @local_timezone = timezone_string(*((::Time.now.utc_offset / 60).divmod 60))
   end
 
   def teardown
@@ -48,7 +77,8 @@ class TestDateTime < Test::Unit::TestCase
   end
 
   def test_date_select
-    ['2005-12-31 23:59:59',
+    ['2005-06-01 00:00:00',
+     '2005-12-31 23:59:59',
      '2006-01-01 00:00:00'].each do |date|
       @conn.exec(<<-EOS) do |row|
 SELECT TO_DATE('#{date}', 'YYYY-MM-DD HH24:MI:SS') FROM dual
@@ -66,11 +96,12 @@ END;
 EOS
     cursor.bind_param(:out, nil, DateTime)
     cursor.bind_param(:in, nil, String, 36)
-    ['2005-12-31 23:59:59',
+    ['2005-06-01 00:00:00',
+     '2005-12-31 23:59:59',
      '2006-01-01 00:00:00'].each do |date|
       cursor[:in] = date
       cursor.exec
-      assert_equal(DateTime.parse(date + @local_timezone), cursor[:out])
+      assert_equal(string_to_datetime(date), cursor[:out])
     end
     cursor.close
   end
@@ -86,9 +117,10 @@ END;
 EOS
     cursor.bind_param(:out, nil, String, 33)
     cursor.bind_param(:in, nil, DateTime)
-    ['2005-12-31 23:59:59',
+    ['2005-06-01 00:00:00',
+     '2005-12-31 23:59:59',
      '2006-01-01 00:00:00'].each do |date|
-      cursor[:in] = DateTime.parse(date + @local_timezone)
+      cursor[:in] = string_to_datetime(date)
       cursor.exec
       assert_equal(date, cursor[:out])
     end
@@ -96,7 +128,8 @@ EOS
   end
 
   def test_timestamp_select
-    ['2005-12-31 23:59:59.999999000',
+    ['2005-06-01 00:00:00.999999000',
+     '2005-12-31 23:59:59.999999000',
      '2006-01-01 00:00:00.000000000'].each do |date|
       @conn.exec(<<-EOS) do |row|
 SELECT TO_TIMESTAMP('#{date}', 'YYYY-MM-DD HH24:MI:SS.FF') FROM dual
@@ -114,11 +147,12 @@ END;
 EOS
     cursor.bind_param(:out, nil, DateTime)
     cursor.bind_param(:in, nil, String, 36)
-    ['2005-12-31 23:59:59.999999000',
+    ['2005-06-01 00:00:00.999999000',
+     '2005-12-31 23:59:59.999999000',
      '2006-01-01 00:00:00.000000000'].each do |date|
       cursor[:in] = date
       cursor.exec
-      assert_equal(DateTime.parse(date + @local_timezone), cursor[:out])
+      assert_equal(string_to_datetime(date), cursor[:out])
     end
     cursor.close
   end
@@ -131,9 +165,10 @@ END;
 EOS
     cursor.bind_param(:out, nil, String, 33)
     cursor.bind_param(:in, nil, DateTime)
-    ['2005-12-31 23:59:59.999999000',
+    ['2005-06-01 00:00:00.999999000',
+     '2005-12-31 23:59:59.999999000',
      '2006-01-01 00:00:00.000000000'].each do |date|
-      cursor[:in] = DateTime.parse(date + @local_timezone)
+      cursor[:in] = string_to_datetime(date)
       cursor.exec
       assert_equal(date, cursor[:out])
     end
@@ -141,7 +176,8 @@ EOS
   end
 
   def test_timestamp_tz_select
-    ['2005-12-31 23:59:59.999999000 +08:30',
+    ['2005-06-01 00:00:00.999999000 +00:00',
+     '2005-12-31 23:59:59.999999000 +08:30',
      '2006-01-01 00:00:00.000000000 -08:30'].each do |date|
       @conn.exec(<<-EOS) do |row|
 SELECT TO_TIMESTAMP_TZ('#{date}', 'YYYY-MM-DD HH24:MI:SS.FF TZH:TZM') FROM dual
@@ -149,7 +185,7 @@ EOS
         expected_val = begin
                          string_to_time(date)
                        rescue
-                         DateTime.parse(date)
+                         string_to_datetime(date)
                        end
         assert_equal(expected_val, row[0])
       end
@@ -164,11 +200,12 @@ END;
 EOS
     cursor.bind_param(:out, nil, DateTime)
     cursor.bind_param(:in, nil, String, 36)
-    ['2005-12-31 23:59:59.999999000 +08:30',
-     '2006-01-01 00:00:00.000000000 -08:30'].each do |date|
+    ['2005-06-01 00:00:00.999999000 -08:30',
+     '2005-12-31 23:59:59.999999000 +00:00',
+     '2006-01-01 00:00:00.000000000 +08:30'].each do |date|
       cursor[:in] = date
       cursor.exec
-      assert_equal(DateTime.parse(date), cursor[:out])
+      assert_equal(string_to_datetime(date), cursor[:out])
     end
     cursor.close
   end
@@ -181,9 +218,10 @@ END;
 EOS
     cursor.bind_param(:out, nil, String, 36)
     cursor.bind_param(:in, nil, DateTime)
-    ['2005-12-31 23:59:59.999999000 +08:30',
-     '2006-01-01 00:00:00.000000000 -08:30'].each do |date|
-      cursor[:in] = DateTime.parse(date)
+    ['2005-06-01 00:00:00.999999999 +08:30',
+     '2005-12-31 23:59:59.999999000 -08:30',
+     '2006-01-01 00:00:00.000000000 +00:00'].each do |date|
+      cursor[:in] = string_to_datetime(date)
       cursor.exec
       assert_equal(date, cursor[:out])
     end
@@ -201,48 +239,48 @@ EOS
     def obj.day; 31; end
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 00:00:00' + @local_timezone), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 00:00:00'), cursor[:out])
     # test hour
     def obj.hour; 23; end
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 23:00:00' + @local_timezone), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 23:00:00'), cursor[:out])
     # test min
     def obj.min; 59; end
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 23:59:00' + @local_timezone), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 23:59:00'), cursor[:out])
     # test sec
     def obj.sec; 59; end
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 23:59:59' + @local_timezone), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 23:59:59'), cursor[:out])
 
     # test sec_fraction
     def obj.sec_fraction; DateTime.parse('0001-01-01 00:00:00.000001').sec_fraction * 999999 ; end
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 23:59:59.999999' + @local_timezone), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 23:59:59.999999'), cursor[:out])
     # test utc_offset (Time)
     def obj.utc_offset; @utc_offset; end
     obj.instance_variable_set(:@utc_offset, 9 * 60 * 60)
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 23:59:59.999999 +09:00'), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 23:59:59.999999 +09:00'), cursor[:out])
     obj.instance_variable_set(:@utc_offset, -5 * 60 * 60)
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 23:59:59.999999 -05:00'), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 23:59:59.999999 -05:00'), cursor[:out])
     # test offset (DateTime)
     def obj.offset; @offset; end
     obj.instance_variable_set(:@offset, 9.to_r / 24)
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 23:59:59.999999 +09:00'), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 23:59:59.999999 +09:00'), cursor[:out])
     obj.instance_variable_set(:@offset, -5.to_r / 24)
     cursor[:in] = obj
     cursor.exec
-    assert_equal(DateTime.parse('2006-12-31 23:59:59.999999 -05:00'), cursor[:out])
+    assert_equal(string_to_datetime('2006-12-31 23:59:59.999999 -05:00'), cursor[:out])
   end
 
   def test_timezone