ruby-plsql 0.4.4 → 0.5.0

data/Gemfile

@@ -1,14 +1,14 @@
 source 'http://rubygems.org'
 
-gem 'jeweler'
-gem 'rspec', "~> 1.3.0"
+group :development do
+  gem 'jeweler', '~> 1.8.3'
+  gem 'rspec', '~> 2.9'
 
-unless ENV['NO_ACTIVERECORD']
-  # avoid loading activerecord 3.0 beta
-  gem 'activerecord', '=2.3.8'
-  gem 'activerecord-oracle_enhanced-adapter', '=1.3.1'
-end
+  unless ENV['NO_ACTIVERECORD']
+    gem 'activerecord', '~> 3.2.3'
+    gem 'activerecord-oracle_enhanced-adapter', '~> 1.4.1'
+  end
 
-if !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby'
-  gem 'ruby-oci8', '>=2.0.4'
+  # gem 'ruby-oci8', '~> 2.1.0'
+  gem 'ruby-oci8', :git => 'git://github.com/kubo/ruby-oci8.git', :platforms => :mri
 end

data/History.txt

@@ -1,3 +1,17 @@
+== 0.5.0 2012-04-16
+
+* Improvements
+  * Support for ruby-oci8 2.1.0 and ActiveRecord 3.2
+  * Tested with Ruby 1.9.3
+  * Tests migrated to RSpec 2
+  * Use ojdbc6.jar or ojdbc5.jar JDBC drivers when using JRuby
+* Bug fixes
+  * Fixed clearing of global temp tables before procedure calls
+  * Fixed passing NULL value for CLOB type arguments
+  * Fixed procedure call that returns array of records
+  * Fixed support for NCHAR and NVARCHAR argument types
+  * Accept any ActiveRecord inherited model class for activerecord_class= method
+
 == 0.4.4 2010-10-06
 
 * Improvements

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2010 Raimonds Simanovskis
+Copyright (c) 2008-2012 Raimonds Simanovskis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,182 @@
+ruby-plsql
+==========
+
+Ruby API for calling Oracle PL/SQL procedures.
+
+DESCRIPTION
+-----------
+
+ruby-plsql gem provides simple Ruby API for calling Oracle PL/SQL procedures. It could be used both for accessing Oracle PL/SQL API procedures in legacy applications as well as it could be used to create PL/SQL unit tests using Ruby testing libraries.
+
+NUMBER, BINARY_INTEGER, PLS_INTEGER, VARCHAR2, NVARCHAR2, CHAR, NCHAR, DATE, TIMESTAMP, CLOB, BLOB, BOOLEAN, PL/SQL RECORD, TABLE, VARRAY, OBJECT and CURSOR types are supported for input and output parameters and return values of PL/SQL procedures and functions.
+
+ruby-plsql supports Ruby 1.8.7, 1.9.3 and JRuby 1.6.7 implementations.
+
+USAGE
+-----
+
+### Calling PL/SQL functions and procedures:
+
+```ruby
+require "rubygems"
+require "ruby-plsql"
+
+plsql.connection = OCI8.new("hr","hr","xe")
+
+plsql.test_uppercase('xxx')               # => "XXX"
+plsql.test_uppercase(:p_string => 'xxx')  # => "XXX"
+plsql.test_copy("abc", nil, nil)          # => { :p_to => "abc", :p_to_double => "abcabc" }
+plsql.test_copy(:p_from => "abc", :p_to => nil, :p_to_double => nil)
+                                          # => { :p_to => "abc", :p_to_double => "abcabc" }
+plsql.hr.test_uppercase('xxx')            # => "XXX"
+plsql.test_package.test_uppercase('xxx')  # => 'XXX'
+
+# PL/SQL records or object type parameters should be passed as Hash
+p_employee = { :employee_id => 1, :first_name => 'First', :last_name => 'Last', :hire_date => Time.local(2000,01,31) }
+plsql.test_full_name(p_employee)
+
+# TABLE or VARRAY parameters should be passed as Array
+plsql.test_sum([1,2,3,4])
+
+# Nested objects or arrays are also supported
+p_employee = { :employee_id => 1, :first_name => 'First', :last_name => 'Last', :hire_date => Time.local(2000,01,31),
+  :address => {:street => 'Street', :city => 'City', :country => 'Country'},
+  :phones => [{:type => 'mobile', :phone_number => '123456'}, {:type => 'fixed', :phone_number => '654321'}]}
+plsql.test_store_employee(p_employee)
+
+# Returned cursor can be fetched
+plsql.test_cursor do |cursor|
+  cursor.fetch                            # => one row from cursor
+  cursor.fetch_all                        # => all rows from cursor
+end
+
+plsql.connection.autocommit = false
+plsql.commit
+plsql.rollback
+
+plsql.logoff
+```
+
+Look at RSpec tests under spec directory for more usage examples.
+
+
+### Table operations:
+
+ruby-plsql also provides simple API for select/insert/update/delete table operations (with Sequel-like syntax). This could be useful if ruby-plsql is used without ActiveRecord (e.g. for writing PL/SQL unit tests):
+
+```ruby
+# insert record in table
+employee = { :employee_id => 1, :first_name => 'First', :last_name => 'Last', :hire_date => Time.local(2000,01,31) }
+plsql.employees.insert employee           # INSERT INTO employees VALUES (1, 'First', 'Last', ...)
+
+# insert many records 
+employees = [employee1, employee2, ... ]  # array of many Hashes
+plsql.employees.insert employees
+
+# insert many records as list of values
+plsql.employees.insert_values [:employee_id, :first_name, :last_name],
+  [1, 'First 1', 'Last 1'],
+  [2, 'First 2', 'Last 2']
+
+# select one record
+plsql.employees.first                     # SELECT * FROM employees
+                                          # fetch first row => {:employee_id => ..., :first_name => '...', ...}
+plsql.employees.first(:employee_id => 1)  # SELECT * FROM employees WHERE employee_id = 1
+plsql.employees.first("WHERE employee_id = 1")
+plsql.employees.first("WHERE employee_id = :employee_id", 1)
+
+# select many records
+plsql.employees.all                       # => [{...}, {...}, ...]
+plsql.employees.all(:order_by => :employee_id)
+plsql.employees.all("WHERE employee_id > :employee_id", 5)
+
+# count records
+plsql.employees.count                     # SELECT COUNT(*) FROM employees
+plsql.employees.count("WHERE employee_id > :employee_id", 5)
+
+# update records
+plsql.employees.update(:first_name => 'Second', :where => {:employee_id => 1})
+                                          # UPDATE employees SET first_name = 'Second' WHERE employee_id = 1
+
+# delete records
+plsql.employees.delete(:employee_id => 1) # DELETE FROM employees WHERE employee_id = 1
+
+# select from sequences
+plsql.employees_seq.nextval               # SELECT employees_seq.NEXTVAL FROM dual
+plsql.employees_seq.currval               # SELECT employees_seq.CURRVAL FROM dual
+
+
+### Usage with Rails:
+
+If using with Rails then include in initializer file:
+
+```ruby
+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).
+
+INSTALLATION
+------------
+
+Install as gem with
+
+    gem install ruby-plsql
+
+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 1.8 or 1.9 Ruby implementation then you need to install ruby-oci8 gem (version 2.0.x or 2.1.x)
+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 ojdbc6.jar for Java 6 or ojdbc5.jar for Java 5. And copy this file to one of these locations:
+
+* in `./lib` directory of Rails application and require it manually
+* in some directory which is in `PATH`
+* in `JRUBY_HOME/lib` directory
+* or include path to JDBC driver jar file in Java `CLASSPATH`
+
+
+LINKS
+-----
+
+* Source code: http://github.com/rsim/ruby-plsql
+* Bug reports / Feature requests: http://github.com/rsim/ruby-plsql/issues
+* Discuss at oracle_enhanced adapter group: http://groups.google.com/group/oracle-enhanced
+
+CONTRIBUTORS
+------------
+
+* Raimonds Simanovskis
+* Edgars Beigarts
+* Oleh Mykytyuk
+* Wiehann Matthysen
+* Dayle Larson
+* Yasuo Honda
+
+LICENSE
+-------
+
+(The MIT License)
+
+Copyright (c) 2008-2012 Raimonds Simanovskis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,47 +1,42 @@
 require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "ruby-plsql"
-    gem.summary = "Ruby API for calling Oracle PL/SQL procedures."
-    gem.description = <<-EOS
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "ruby-plsql"
+  gem.summary = "Ruby API for calling Oracle PL/SQL procedures."
+  gem.description = <<-EOS
 ruby-plsql gem provides simple Ruby API for calling Oracle PL/SQL procedures.
 It could be used both for accessing Oracle PL/SQL API procedures in legacy applications
 as well as it could be used to create PL/SQL unit tests using Ruby testing libraries.
 EOS
-    gem.email = "raimonds.simanovskis@gmail.com"
-    gem.homepage = "http://github.com/rsim/ruby-plsql"
-    gem.authors = ["Raimonds Simanovskis"]
-    gem.add_development_dependency "rspec", "~> 1.3.0"
-    gem.add_development_dependency "activerecord", "= 2.3.8"
-    gem.add_development_dependency "activerecord-oracle_enhanced-adapter", "~> 1.3.1"
-    gem.extra_rdoc_files = ['README.rdoc']
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+  gem.email = "raimonds.simanovskis@gmail.com"
+  gem.homepage = "http://github.com/rsim/ruby-plsql"
+  gem.authors = ["Raimonds Simanovskis"]
+  gem.extra_rdoc_files = ['README.md']
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-  spec.rcov_opts = ['--exclude', '/Library,spec/']
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts =  ['--exclude', '/Library,spec/']
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/VERSION

@@ -1 +1 @@
-0.4.4
+0.5.0

data/lib/plsql/connection.rb

@@ -10,7 +10,7 @@ module PLSQL
     end
 
     def self.create(raw_conn, ar_class = nil) #:nodoc:
-      if ar_class && !(defined?(::ActiveRecord) && [ar_class, ar_class.superclass].include?(::ActiveRecord::Base))
+      if ar_class && !(defined?(::ActiveRecord) && ar_class.ancestors.include?(::ActiveRecord::Base))
         raise ArgumentError, "Wrong ActiveRecord class"
       end
       case driver_type

data/lib/plsql/jdbc_connection.rb

@@ -2,19 +2,28 @@ begin
   require "java"
   require "jruby"
 
-  # ojdbc14.jar file should be in JRUBY_HOME/lib or should be in ENV['PATH'] or load path
-
-  ojdbc_jar = "ojdbc14.jar"
+  # ojdbc6.jar or ojdbc5.jar file should be in JRUBY_HOME/lib or should be in ENV['PATH'] or load path
+
+  java_version = java.lang.System.getProperty("java.version")
+  ojdbc_jar = if java_version =~ /^1.5/
+    "ojdbc5.jar"
+  elsif java_version >= '1.6'
+    "ojdbc6.jar"
+  else
+    nil
+  end
 
   unless ENV_JAVA['java.class.path'] =~ Regexp.new(ojdbc_jar)
     # On Unix environment variable should be PATH, on Windows it is sometimes Path
-    env_path = ENV["PATH"] || ENV["Path"] || ''
-    if ojdbc_jar_path = env_path.split(/[:;]/).concat($LOAD_PATH).find{|d| File.exists?(File.join(d,ojdbc_jar))}
+    env_path = (ENV["PATH"] || ENV["Path"] || '').split(/[:;]/)
+    # Look for JDBC driver at first in lib subdirectory (application specific JDBC file version)
+    # then in Ruby load path and finally in environment PATH
+    if ojdbc_jar_path = ['./lib'].concat($LOAD_PATH).concat(env_path).find{|d| File.exists?(File.join(d,ojdbc_jar))}
       require File.join(ojdbc_jar_path,ojdbc_jar)
     end
   end
 
-  java.sql.DriverManager.registerDriver Java::oracle.jdbc.driver.OracleDriver.new
+  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"]
@@ -23,10 +32,7 @@ begin
 
 rescue LoadError, NameError
   # JDBC driver is unavailable.
-  error_message = "ERROR: ruby-plsql could not load Oracle JDBC driver. "+
-                  "Please install ojdbc14.jar library."
-  STDERR.puts error_message
-  raise LoadError
+  raise LoadError, "ERROR: ruby-plsql could not load Oracle JDBC driver. Please install #{ojdbc_jar || "Oracle JDBC"} library."
 end
 
 module PLSQL
@@ -228,7 +234,9 @@ module PLSQL
 
     SQL_TYPE_TO_RUBY_CLASS = {
       java.sql.Types::CHAR => String,
+      java.sql.Types::NCHAR => String,
       java.sql.Types::VARCHAR => String,
+      java.sql.Types::NVARCHAR => String,
       java.sql.Types::LONGVARCHAR => String,
       java.sql.Types::NUMERIC => BigDecimal,
       java.sql.Types::INTEGER => Fixnum,
@@ -389,7 +397,7 @@ module PLSQL
           clob.setString(1, value)
           clob
         else
-          Java::OracleSql::CLOB.getEmptyCLOB
+          nil
         end
       when :'Java::OracleSql::BLOB'
         if value
@@ -397,7 +405,7 @@ module PLSQL
           blob.setBytes(1, value.to_java_bytes)
           blob
         else
-          Java::OracleSql::BLOB.getEmptyBLOB
+          nil
         end
       when :'Java::OracleSql::ARRAY'
         if value

data/lib/plsql/oci_connection.rb

@@ -194,8 +194,7 @@ module PLSQL
         end
       when :"OCI8::CLOB", :"OCI8::BLOB"
         # ruby-oci8 cannot create CLOB/BLOB from ''
-        value = nil if value == ''
-        type.new(raw_oci_connection, value)
+        value.to_s.length > 0 ? type.new(raw_oci_connection, value) : nil
       when :"OCI8::Cursor"
         value && value.raw_cursor
       else

data/lib/plsql/procedure.rb

@@ -52,12 +52,17 @@ module PLSQL
       when 'NUMBER'
         precision, scale = metadata[:data_precision], metadata[:data_scale]
         "NUMBER#{precision ? "(#{precision}#{scale ? ",#{scale}": ""})" : ""}"
-      when 'VARCHAR2', 'CHAR', 'NVARCHAR2', 'NCHAR'
-        length = metadata[:data_length]
-        if length && (char_used = metadata[:char_used])
-          length = "#{length} #{char_used == 'C' ? 'CHAR' : 'BYTE'}"
+      when 'VARCHAR2', 'CHAR'
+        length = case metadata[:char_used]
+        when 'C' then "#{metadata[:char_length]} CHAR"
+        when 'B' then "#{metadata[:data_length]} BYTE"
+        else
+          metadata[:data_length]
         end
-        "#{metadata[:data_type]}#{length ? "(#{length})": ""}"
+        "#{metadata[:data_type]}#{length && "(#{length})"}"
+      when 'NVARCHAR2', 'NCHAR'
+        length = metadata[:char_length]
+        "#{metadata[:data_type]}#{length && "(#{length})"}"
       when 'PL/SQL TABLE', 'TABLE', 'VARRAY', 'OBJECT'
         metadata[:sql_type_name]
       else
@@ -87,7 +92,7 @@ module PLSQL
       @schema.select_all(
         "SELECT #{subprogram_id_column}, object_name, TO_NUMBER(overload), argument_name, position, data_level,
               data_type, in_out, data_length, data_precision, data_scale, char_used,
-              type_owner, type_name, type_subname
+              char_length, type_owner, type_name, type_subname
         FROM all_arguments
         WHERE object_id = :object_id
         AND owner = :owner
@@ -98,7 +103,7 @@ module PLSQL
 
         subprogram_id, object_name, overload, argument_name, position, data_level,
             data_type, in_out, data_length, data_precision, data_scale, char_used,
-            type_owner, type_name, type_subname = r
+            char_length, type_owner, type_name, type_subname = r
 
         @overloaded ||= !overload.nil?
         # if not overloaded then store arguments at key 0
@@ -134,6 +139,7 @@ module PLSQL
           :data_precision => data_precision && data_precision.to_i,
           :data_scale => data_scale && data_scale.to_i,
           :char_used => char_used,
+          :char_length => char_length && char_length.to_i,
           :type_owner => type_owner,
           :type_name => type_name,
           :type_subname => type_subname,