ruby-plsql 0.9.0 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e240a454b5016fb465baaff47830601ea5f06f9a0f4ed7f2e032e2e8027c8841
-  data.tar.gz: 8209b0f8b037838e7be37578a396b8652855540abd6a0c2cbf226adfaf7a598e
+  metadata.gz: 8ce42b7f40a83d55130a51e1acae222dbb1361a7d4a43b712873e2cddae24571
+  data.tar.gz: 7cd295463301ff322ed0312cabd73f08337068a8b3b3c57e724a5dae8efb51a0
 SHA512:
-  metadata.gz: af3ba3c7a782369e6e4f94afe467194f155fc961dc80e946ebbbaec07f48244169d33f1c0c387d6710752b7590f70c9cc5fb84bc21f8687b8c520d32ed09f557
-  data.tar.gz: 2fe1c1fa55a48cc547a3f34f371aba37147c4d3c8efc2c34d104b42b8e250251f6d233d65c6fedba42855774ccf559d6aed4164f341823b5c6fbbbb605acb047
+  metadata.gz: '08dabe0856244a3b1e487df17664d996a204f026ce6c19c50dec721bcc42be7936ce41b90ddecfc7d2b798351e624df068602d8da4c1e091e1096f534d8b96c6'
+  data.tar.gz: 5b25be049a7575a74911028db9b82986a692af4aa895d1561e1de3600bcfd418429c969bb45832536782ef84c70cf60bb8549207470d0cac962203666f7c035d

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.com/rsim/ruby-plsql.svg?branch=master)](https://travis-ci.com/rsim/ruby-plsql)
+[![Test](https://github.com/rsim/ruby-plsql/actions/workflows/test.yml/badge.svg)](https://github.com/rsim/ruby-plsql/actions/workflows/test.yml)
 
 ruby-plsql
 ==========
@@ -120,6 +120,22 @@ plsql.activerecord_class = ActiveRecord::Base
 and then you do not need to specify plsql.connection (this is also safer when ActiveRecord reestablishes connection to database).
 
 
+### JRuby JDBC connection:
+
+When using JRuby, the `connect!` method with `:host` and `:database` options uses the thin-style service name syntax by default:
+
+```ruby
+# Connects using service name syntax: jdbc:oracle:thin:@//localhost:1521/MYSERVICENAME
+plsql.connect! username: "hr", password: "hr", host: "localhost", database: "MYSERVICENAME"
+```
+
+If you need to connect using the legacy SID syntax (for Oracle databases older than 12c), prefix the database name with a colon:
+
+```ruby
+# Connects using SID syntax: jdbc:oracle:thin:@localhost:1521:MYSID
+plsql.connect! username: "hr", password: "hr", host: "localhost", database: ":MYSID"
+```
+
 ### Cheat Sheet:
 
 You may have a look at this [Cheat Sheet](http://cheatography.com/jgebal/cheat-sheets/ruby-plsql-cheat-sheet/) for instructions on how to use ruby-plsql
@@ -135,10 +151,10 @@ or include gem in Gemfile if using bundler.
 
 In addition install either ruby-oci8 (for MRI/YARV) or copy Oracle JDBC driver to $JRUBY_HOME/lib (for JRuby).
 
-If you are using MRI Ruby implementation then you need to install ruby-oci8 gem (version 2.0.x or 2.1.x)
+If you are using MRI Ruby implementation then you need to install ruby-oci8 gem (version 2.1 or higher)
 as well as Oracle client, e.g. [Oracle Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html).
 
-If you are using JRuby then you need to download latest [Oracle JDBC driver](http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html) - either ojdbc7.jar for Java 8 and 7, ojdbc6.jar for Java 6, 7, 8 or ojdbc5.jar for Java 5. You can refer [the support matrix](http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-faq-090281.html#01_03) for details.
+If you are using JRuby then you need to download the appropriate [Oracle JDBC driver](https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html) for your Java version - ojdbc17.jar for Java 17+, ojdbc11.jar for Java 11+, ojdbc8.jar for Java 8+, ojdbc7.jar for Java 7, ojdbc6.jar for Java 6, or ojdbc5.jar for Java 5.
 
 And copy this file to one of these locations. JDBC driver will be searched in this order:
 

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.9

data/lib/plsql/jdbc_connection.rb

@@ -1,23 +1,26 @@
+ojdbc_jars = []
+
 begin
   require "java"
   require "jruby"
 
-  # ojdbc6.jar or ojdbc5.jar file should be in JRUBY_HOME/lib or should be in ENV['PATH'] or load path
+  # Oracle JDBC driver jar should be in JRUBY_HOME/lib or should be in ENV['PATH'] or load path
 
   java_version = java.lang.System.getProperty("java.version")
-  ojdbc_jars = if java_version =~ /^1.5/
-    %w(ojdbc5.jar)
-  elsif java_version =~ /^1.6/
-    %w(ojdbc6.jar)
-  elsif java_version >= "1.7"
-    # Oracle 11g client ojdbc6.jar is also compatible with Java 1.7
-    # Oracle 12c client provides new ojdbc7.jar
-    %w(ojdbc7.jar ojdbc6.jar)
+  java_major = if java_version =~ /^1\.(\d+)/
+    $1.to_i
   else
-    []
+    java_version.to_i
   end
 
-  if ENV_JAVA["java.class.path"] !~ Regexp.new(ojdbc_jars.join("|"))
+  ojdbc_jars << "ojdbc17.jar" if java_major >= 17
+  ojdbc_jars << "ojdbc11.jar" if java_major >= 11
+  ojdbc_jars << "ojdbc8.jar"  if java_major >= 8
+  ojdbc_jars << "ojdbc7.jar"  if java_major >= 7
+  ojdbc_jars << "ojdbc6.jar"  if java_major >= 6
+  ojdbc_jars << "ojdbc5.jar"  if java_major == 5
+
+  if ENV_JAVA["java.class.path"] !~ Regexp.union(ojdbc_jars)
     # On Unix environment variable should be PATH, on Windows it is sometimes Path
     env_path = (ENV["PATH"] || ENV["Path"] || "").split(File::PATH_SEPARATOR)
     # Look for JDBC driver at first in lib subdirectory (application specific JDBC file version)
@@ -25,7 +28,7 @@ begin
     ["./lib"].concat($LOAD_PATH).concat(env_path).detect do |dir|
       # check any compatible JDBC driver in the priority order
       ojdbc_jars.any? do |ojdbc_jar|
-        if File.exists?(file_path = File.join(dir, ojdbc_jar))
+        if File.exist?(file_path = File.join(dir, ojdbc_jar))
           require file_path
           true
         end
@@ -33,29 +36,66 @@ begin
     end
   end
 
-  java.sql.DriverManager.registerDriver Java::oracle.jdbc.OracleDriver.new
-
   # set tns_admin property from TNS_ADMIN environment variable
   if !java.lang.System.get_property("oracle.net.tns_admin") && ENV["TNS_ADMIN"]
     java.lang.System.set_property("oracle.net.tns_admin", ENV["TNS_ADMIN"])
   end
 
-rescue LoadError, NameError
+rescue LoadError
   # JDBC driver is unavailable.
   raise LoadError, "ERROR: ruby-plsql could not load Oracle JDBC driver. Please install #{ojdbc_jars.empty? ? "Oracle JDBC" : ojdbc_jars.join(' or ') } library."
 end
 
 module PLSQL
   class JDBCConnection < Connection  # :nodoc:
+    begin
+      ORACLE_DRIVER = Java::oracle.jdbc.OracleDriver.new
+      java.sql.DriverManager.registerDriver ORACLE_DRIVER
+    rescue NameError
+      raise LoadError, "ERROR: ruby-plsql could not load Oracle JDBC driver. " \
+        "Please install the appropriate Oracle JDBC driver. " \
+        "See https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html"
+    end
+
     def self.create_raw(params)
+      url = jdbc_connection_url(params)
+      conn = begin
+        java.sql.DriverManager.getConnection(url, params[:username], params[:password])
+      rescue Java::JavaSql::SQLException => e
+        raise unless e.message =~ /no suitable driver/i
+        # bypass DriverManager to work in cases where ojdbc*.jar
+        # is added to the load path at runtime and not on the
+        # system classpath
+        ORACLE_DRIVER.connect(url, java.util.Properties.new.tap do |props|
+          props.setProperty("user", params[:username])
+          props.setProperty("password", params[:password])
+        end)
+      end
+      conn.setAutoCommit(false)
+      new(conn)
+    end
+
+    def self.jdbc_connection_url(params)
       database = params[:database]
-      url = if ENV["TNS_ADMIN"] && database && !params[:host] && !params[:url]
+      if ENV["TNS_ADMIN"] && database && database !~ %r{\A[:/]} && !params[:host] && !params[:url]
         "jdbc:oracle:thin:@#{database}"
       else
-        database = ":#{database}" unless database.match(/^(\:|\/)/)
-        params[:url] || "jdbc:oracle:thin:@#{params[:host] || 'localhost'}:#{params[:port] || 1521}#{database}"
+        return params[:url] if params[:url]
+
+        raise ArgumentError, "database or url option is required" if database.nil? || database.empty?
+
+        host = params[:host] || "localhost"
+        port = params[:port] || 1521
+
+        if database =~ /^:/
+          # SID syntax: jdbc:oracle:thin:@host:port:SID
+          "jdbc:oracle:thin:@#{host}:#{port}#{database}"
+        else
+          # service name syntax: jdbc:oracle:thin:@//host:port/service_name
+          database = "/#{database}" unless database =~ /^\//
+          "jdbc:oracle:thin:@//#{host}:#{port}#{database}"
+        end
       end
-      new(java.sql.DriverManager.getConnection(url, params[:username], params[:password]))
     end
 
     def set_time_zone(time_zone = nil)

data/lib/plsql/oci_connection.rb

@@ -14,13 +14,9 @@ rescue LoadError
   raise LoadError, "ERROR: ruby-plsql could not load ruby-oci8 library. #{msg}"
 end
 
-require "plsql/oci8_patches"
-
 # check ruby-oci8 version
-required_oci8_version = [2, 0, 3]
-oci8_version_ints = OCI8::VERSION.scan(/\d+/).map { |s| s.to_i }
-if (oci8_version_ints <=> required_oci8_version) < 0
-  raise LoadError, "ERROR: ruby-oci8 version #{OCI8::VERSION} is too old. Please install ruby-oci8 version #{required_oci8_version.join('.')} or later."
+if Gem::Version.new(OCI8::VERSION) < Gem::Version.new("2.1.0")
+  raise LoadError, "ERROR: ruby-oci8 version #{OCI8::VERSION} is too old. Please install ruby-oci8 version 2.1.0 or later."
 end
 
 module PLSQL

data/lib/plsql/procedure.rb

@@ -361,7 +361,7 @@ module PLSQL
           WHERE t.OWNER = :owner AND t.type_name = :type_name AND t.package_name = :package_name
           AND ta.OWNER = t.owner AND ta.TYPE_NAME = t.TYPE_NAME AND ta.PACKAGE_NAME = t.PACKAGE_NAME
           ORDER BY attr_no",
-          @schema_name, argument_metadata[:type_name], argument_metadata[:type_subname]) do |r|
+          argument_metadata[:type_owner], argument_metadata[:type_name], argument_metadata[:type_subname]) do |r|
 
           attr_no, attr_name, attr_type_owner, attr_type_name, attr_type_package, attr_length, attr_precision, attr_scale, attr_char_used = r
 
@@ -391,12 +391,15 @@ module PLSQL
       when "TABLE", "VIEW"
         @schema.select_all(
           "SELECT column_id, column_name, data_type, data_length, data_precision, data_scale, char_length, char_used
-           FROM ALL_TAB_COLS WHERE OWNER = :owner AND TABLE_NAME = :type_name
+           FROM ALL_TAB_COLUMNS WHERE OWNER = :owner AND TABLE_NAME = :type_name
            ORDER BY column_id",
-          @schema_name, argument_metadata[:type_name]) do |r|
+          argument_metadata[:type_owner], argument_metadata[:type_name]) do |r|
 
           col_no, col_name, col_type_name, col_length, col_precision, col_scale, col_char_length, col_char_used = r
 
+          # remove precision (n) from data_type (returned for TIMESTAMPs and INTERVALs)
+          col_type_name = col_type_name.sub(/\(\d+\)/, "")
+
           fields[col_name.downcase.to_sym] = {
             position: col_no.to_i,
             data_type: col_type_name,
@@ -426,7 +429,7 @@ module PLSQL
             "SELECT elem_type_owner, elem_type_name, elem_type_package, length, precision, scale, char_used, index_by
              FROM ALL_PLSQL_COLL_TYPES t
              WHERE t.OWNER = :owner AND t.TYPE_NAME = :type_name AND t.PACKAGE_NAME = :package_name",
-            @schema_name, argument_metadata[:type_name], argument_metadata[:type_subname])
+            argument_metadata[:type_owner], argument_metadata[:type_name], argument_metadata[:type_subname])
 
           elem_type_owner, elem_type_name, elem_type_package, elem_length, elem_precision, elem_scale, elem_char_used, index_by = r
 
@@ -460,13 +463,30 @@ module PLSQL
 
           if elem_type_package != nil
             element_metadata[:fields] = get_field_definitions(element_metadata)
+          elsif elem_type_name && elem_type_name =~ /\A(.+)%ROWTYPE\z/
+            # TABLE OF table%ROWTYPE: Oracle stores elem_type_name as "TABLE_NAME%ROWTYPE"
+            rowtype_table_name = $1
+            check_owner = elem_type_owner || @schema_name
+            object_type_row = @schema.select_first(
+              "SELECT object_type FROM ALL_OBJECTS WHERE owner = :owner AND object_name = :name AND object_type IN ('TABLE', 'VIEW')",
+              check_owner, rowtype_table_name)
+            if object_type_row
+              element_metadata[:type_owner] ||= check_owner
+              element_metadata[:type_name] = rowtype_table_name
+              element_metadata[:sql_type_name] = build_sql_type_name(check_owner, nil, rowtype_table_name)
+              element_metadata[:data_type] = "PL/SQL RECORD"
+              element_metadata[:type_object_type] = object_type_row[0]
+              element_metadata[:fields] = get_field_definitions(element_metadata)
+            else
+              raise ArgumentError, "Could not resolve #{check_owner}.#{rowtype_table_name} to a table or view for #{elem_type_name}"
+            end
           end
         when "TYPE"
           r = @schema.select_first(
             "SELECT elem_type_owner, elem_type_name, length, precision, scale, char_used
              FROM ALL_COLL_TYPES t
              WHERE t.owner = :owner AND t.TYPE_NAME = :type_name",
-            @schema_name, argument_metadata[:type_name]
+            argument_metadata[:type_owner], argument_metadata[:type_name]
           )
           elem_type_owner, elem_type_name, elem_length, elem_precision, elem_scale, elem_char_used = r
 

data/lib/plsql/schema.rb

@@ -41,7 +41,7 @@ module PLSQL
     # or
     #
     #   plsql.connection = java.sql.DriverManager.getConnection(
-    #     "jdbc:oracle:thin:@#{database_host}:#{database_port}/#{database_service_name}",
+    #     "jdbc:oracle:thin:@//#{database_host}:#{database_port}/#{database_service_name}",
     #     database_user, database_password)
     #
     def connection=(conn)
@@ -99,12 +99,15 @@ module PLSQL
         @original_schema.default_timezone
       else
         @default_timezone ||
-          # Use ActiveRecord default_timezone when ActiveRecord connection is used,
-          # preferring the connection's activerecord_class so a subclass override
-          # (available in AR < 8.0) is honored before falling back to the
-          # module-level accessor (AR 7.0+; the only one in AR 8.0+).
-          (@connection && (ar_class = @connection.activerecord_class) &&
-            (ar_class.respond_to?(:default_timezone) ? ar_class.default_timezone : ActiveRecord.default_timezone)) ||
+          # Use ActiveRecord default_timezone when ActiveRecord connection is used.
+          # Prefer the module-level accessor (AR 7.0+; the only one in AR 8.0+) so
+          # that AR 7.0/7.1's deprecation warning for ActiveRecord::Base.default_timezone
+          # is not emitted. Fall back to the per-class accessor only on pre-7.0 AR,
+          # where ActiveRecord.default_timezone does not exist.
+          (@connection && @connection.activerecord_class &&
+            (ActiveRecord.respond_to?(:default_timezone) ?
+              ActiveRecord.default_timezone :
+              @connection.activerecord_class.default_timezone)) ||
           # default to local timezone
           :local
       end

data/lib/plsql/variable.rb

@@ -9,7 +9,8 @@ module PLSQL
           AND type = 'PACKAGE'
           AND UPPER(text) LIKE :variable_name",
             override_schema_name || schema.schema_name, package, "%#{variable_upcase}%").each do |row|
-        if row[0] =~ /^\s*#{variable_upcase}\s+(CONSTANT\s+)?([A-Z0-9_. %]+(\([\w\s,]+\))?)\s*(NOT\s+NULL)?\s*((:=|DEFAULT).*)?;\s*(--.*)?$/i
+        if row[0] =~ /^\s*#{variable_upcase}\s+(CONSTANT\s+)?([A-Z0-9_. %]+(\([\w\s,]+\))?)\s*(NOT\s+NULL)?\s*((:=|DEFAULT).*)?;\s*(--.*)?$/i ||
+           row[0] =~ /^\s*#{variable_upcase}\s+(CONSTANT\s+)?([A-Z0-9_. %]+(\([\w\s,]+\))?)\s*(NOT\s+NULL)?\s*(:=|DEFAULT)\s*$/i
           return new(schema, variable, package, $2.strip, override_schema_name)
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-plsql
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.9
 platform: ruby
 authors:
 - Raimonds Simanovskis
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -96,7 +96,6 @@ files:
 - lib/plsql/connection.rb
 - lib/plsql/helpers.rb
 - lib/plsql/jdbc_connection.rb
-- lib/plsql/oci8_patches.rb
 - lib/plsql/oci_connection.rb
 - lib/plsql/package.rb
 - lib/plsql/procedure.rb

data/lib/plsql/oci8_patches.rb

@@ -1,25 +0,0 @@
-# apply TIMESTAMP fractional seconds patch to ruby-oci8 2.0.3
-# see http://rubyforge.org/forum/forum.php?thread_id=46576&forum_id=1078
-if OCI8::VERSION == "2.0.3" &&
-  !OCI8::BindType::Util.method_defined?(:datetime_to_array_without_timestamp_patch)
-
-  OCI8::BindType::Util.module_eval do
-    alias :datetime_to_array_without_timestamp_patch :datetime_to_array
-    def datetime_to_array(val, full)
-      result = datetime_to_array_without_timestamp_patch(val, full)
-      if result && result[6] == 0
-        if val.respond_to? :nsec
-          fsec = val.nsec
-        elsif val.respond_to? :usec
-          fsec = val.usec * 1000
-        else
-          fsec = 0
-        end
-        result[6] = fsec
-      end
-      result
-    end
-    private :datetime_to_array_without_timestamp_patch, :datetime_to_array
-  end
-
-end