jdbc-helper 0.2.1 → 0.3.0

data/lib/jdbc-helper/connection.rb

@@ -1,11 +1,19 @@
 # encoding: UTF-8
 # Junegunn Choi (junegunn.c@gmail.com)
 
-require 'jdbc-helper/connection/statement_pool'
+require 'jdbc-helper/connection/type_map'
+require 'jdbc-helper/connection/parameterized_statement'
 require 'jdbc-helper/connection/prepared_statement'
+require 'jdbc-helper/connection/callable_statement'
+require 'jdbc-helper/connection/statement_pool'
 require 'jdbc-helper/connection/result_set_enumerator'
 require 'jdbc-helper/connection/row'
 
+require 'jdbc-helper/wrapper/object_wrapper'
+require 'jdbc-helper/wrapper/table_wrapper'
+require 'jdbc-helper/wrapper/function_wrapper'
+require 'jdbc-helper/wrapper/procedure_wrapper'
+
 module JDBCHelper
 # Encapsulates JDBC database connection.
 # Lets you easily execute SQL statements and access their results.
@@ -150,7 +158,6 @@ class Connection
 		
 		@conn = JavaSql::DriverManager.get_connection(args[:url], props)
 		@spool = StatementPool.send :new, self
-		@pstmts = {}
 		@bstmt = nil
 
 		@stats = Hash.new { | h, k | h[k] = Stat.new(k, 0, 0, 0) }
@@ -170,12 +177,17 @@ class Connection
 	def prepare(qstr)
 		check_closed
 
-		return @pstmts[qstr] if @pstmts.has_key? qstr
+		PreparedStatement.send(:new, self, qstr,
+				measure_exec(:prepare) { @conn.prepare_statement(qstr) })
+	end
 
-		pstmt =	PreparedStatement.send(:new, self, @pstmts, qstr,
-									  measure_exec(:prepare) { @conn.prepare_statement(qstr) })
-		@pstmts[qstr] = pstmt
-		pstmt
+	# Creates a callable statement.
+	# @param [String] qstr SQL string
+	def prepare_call(qstr)
+		check_closed
+
+		CallableStatement.send(:new, self, qstr,
+				measure_exec(:prepare_call) { @conn.prepare_call qstr })
 	end
 
 	# Executes the given code block as a transaction. Returns true if the transaction is committed.
@@ -321,7 +333,6 @@ class Connection
 	# @return [NilClass]
 	def close
 		return if closed?
-		@pstmts.each { | q, pstmt | pstmt.close }
 		@spool.close
 		@conn.close
 		@conn = @spool = nil
@@ -333,12 +344,30 @@ class Connection
 		@conn.nil?
 	end
 
-	# @param [String] table_name Name of the table to be wrapped
+	# Returns a table wrapper for the given table name
+	# @since 0.2.0
+	# @param [String/Symbol] table_name Name of the table to be wrapped
 	# @return [JDBCHelper::TableWrapper]
 	def table table_name
 		JDBCHelper::TableWrapper.new self, table_name
 	end
 
+	# Returns a function wrapper for the given function name
+	# @since 0.2.2
+	# @param [String/Symbol] func_name Name of the function to be wrapped
+	# @return [JDBCHelper::FunctionWrapper]
+	def function func_name
+		JDBCHelper::FunctionWrapper.new self, func_name
+	end
+
+	# Returns a procedure wrapper for the given procedure name
+	# @since 0.3.0
+	# @param [String/Symbol] proc_name Name of the procedure to be wrapped
+	# @return [JDBCHelper::ProcedureWrapper]
+	def procedure proc_name
+		JDBCHelper::ProcedureWrapper.new self, proc_name
+	end
+
 	# Statistics
 	class Stat
 		attr_accessor :type, :elapsed, :success_count, :fail_count

data/lib/jdbc-helper/sql.rb

@@ -32,7 +32,14 @@ module SQL
 	# Generates SQL where cluase with the given conditions.
 	# Parameter can be either Hash of String.
 	def self.where conds
-		check(where_internal conds)
+		where_clause = where_internal conds
+		where_clause.empty? ? where_clause : check(where_clause)
+	end
+
+	# Generates SQL order by cluase with the given conditions.
+	def self.order_by *criteria
+		str = criteria.map(&:to_s).reject(&:empty?).join(', ')
+		str.empty? ? str : check('order by ' + str)
 	end
 
 	# SQL Helpers
@@ -56,34 +63,45 @@ module SQL
 	# Generates update SQL with hash.
 	# :where element of the given hash is taken out to generate where clause.
 	def self.update table, data_hash
-		where_clause = make_where(data_hash.delete :where)
+		where_clause = where_internal(data_hash.delete :where)
 		updates = data_hash.map { |k, v| "#{k} = #{value v}" }.join(', ')
-		check "update #{table} set #{updates}#{where_clause}"
+		check "update #{table} set #{updates} #{where_clause}".strip
 	end
 
 	# Generates select * SQL with the given conditions
-	def self.select table, conds = nil
-		check "select * from #{table}#{make_where conds}"
+	def self.select table, conds = nil, orders = nil
+		check [
+			"select * from #{table}", 
+			where_internal(conds),
+			order_by(orders)
+		].reject(&:empty?).join(' ')
 	end
 
 	# Generates count SQL with the given conditions
 	def self.count table, conds = nil
-		check "select count(*) from #{table}#{make_where conds}"
+		check "select count(*) from #{table} #{where_internal conds}".strip
 	end
 
 	# Generates delete SQL with the given conditions
 	def self.delete table, conds = nil
-		check "delete from #{table}#{make_where conds}"
+		check "delete from #{table} #{where_internal conds}".strip
 	end
 
 	# FIXME: Naive protection for SQL Injection
-	def self.check expr
+	def self.check expr, is_name = false
 		return nil if expr.nil?
 
-		test = expr.gsub(/'[^']*'/, '').gsub(/`[^`]*`/, '').gsub(/"[^"]*"/, '')
-		raise ArgumentError.new("Expression cannot contain semi-colons: #{test}") if test.include?(';')
-		raise ArgumentError.new("Expression cannot contain comments: #{test}") if test.match(%r{--|/\*|\*/})
-		raise ArgumentError.new("Unclosed quotation mark: #{test}") if test.match(/['"`]/)
+		tag = is_name ? 'Object name' : 'Expression'
+		test = expr.gsub(/'[^']*'/, '').gsub(/`[^`]*`/, '').gsub(/"[^"]*"/, '').strip
+		raise ArgumentError.new("#{tag} cannot contain (unquoted) semi-colons: #{expr}") if test.include?(';')
+		raise ArgumentError.new("#{tag} cannot contain (unquoted) comments: #{expr}") if test.match(%r{--|/\*|\*/})
+		raise ArgumentError.new("Unclosed quotation mark: #{expr}") if test.match(/['"`]/)
+		raise ArgumentError.new("#{tag} is blank") if test.empty?
+
+		if is_name
+			raise ArgumentError.new(
+				"#{tag} cannot contain (unquoted) parentheses: #{expr}") if test.match(%r{\(|\)})
+		end
 
 		return expr
 	end
@@ -93,51 +111,45 @@ private
 		str.gsub("'", "''")
 	end
 
-	def self.make_where conds
-		str = where_internal conds
-		str = ' where ' + str if str
-		str
-	end
-
 	# No check
 	def self.where_internal conds
-		return nil if conds.nil?
-
-		case conds
-		when String
-			return nil if conds.strip.empty?
-			conds
-		when Hash
-			return nil if conds.empty?
-			conds.map { |k, v|
-				"#{k} " +
-					case v
-					when NilClass
-						"is null"
-					when NotNilClass
-						"is not null"
-					when Fixnum, Bignum, Float, JDBCHelper::SQL::Expr
-						"= #{v}"
-					when Range
-						">= #{v.first} and #{k} <#{'=' unless v.exclude_end?} #{v.last}"
-					when Array
-						"in (" + 
-						v.map { |e|
-							case e
-							when String
-								"'#{esc e}'"
-							else
-								e
-							end }.join(', ') + ")"
-					when String
-						"= '#{esc v}'"
-					else
-						raise NotImplementedError.new("Unsupported class: #{v.class}")
-					end
-			}.join(' and ')
-		else
-			raise NotImplementedError.new("Parameter to where must be either Hash or String")
-		end
+		return '' if conds.nil?
+
+		where = 
+			case conds
+			when String
+				conds.strip
+			when Hash
+				conds.map { |k, v|
+					"#{k} " +
+						case v
+						when NilClass
+							"is null"
+						when NotNilClass
+							"is not null"
+						when Fixnum, Bignum, Float, JDBCHelper::SQL::Expr
+							"= #{v}"
+						when Range
+							">= #{v.first} and #{k} <#{'=' unless v.exclude_end?} #{v.last}"
+						when Array
+							"in (" + 
+							v.map { |e|
+								case e
+								when String
+									"'#{esc e}'"
+								else
+									e
+								end }.join(', ') + ")"
+						when String
+							"= '#{esc v}'"
+						else
+							raise NotImplementedError.new("Unsupported class: #{v.class}")
+						end
+				}.join(' and ')
+			else
+				raise NotImplementedError.new("Parameter to where must be either Hash or String")
+			end
+		where.empty? ? '' : 'where ' + where
 	end
 
 	def self.insert_internal cmd, table, data_hash

data/lib/jdbc-helper/wrapper/function_wrapper.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+# Junegunn Choi (junegunn.c@gmail.com)
+
+module JDBCHelper
+# A wrapper object representing a database function.
+# @since 0.2.2
+# @example Usage
+#  conn.function(:coalesce).call(nil, nil, 'king')
+class FunctionWrapper < ObjectWrapper
+	# Returns the name of the function
+	# @return [String]
+	alias to_s name
+
+	# Returns the result of the function call with the given parameters
+	def call(*args)
+		pstmt = @connection.prepare("select #{name}(#{args.map{'?'}.join ','}) from dual")
+		begin
+			pstmt.query(*args)[0][0]
+		ensure
+			pstmt.close
+		end
+	end
+end#FunctionWrapper
+end#JDBCHelper
+
+

data/lib/jdbc-helper/wrapper/object_wrapper.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+# Junegunn Choi (junegunn.c@gmail.com)
+
+module JDBCHelper
+# Abstract base class for wrappers for various database objects.
+# @abstract
+# @since 0.2.0
+# @todo Procedure wrapper with input & output params
+class ObjectWrapper
+	# Underlying JDBCHelper::Connection object
+	# @return [JDBCHelper::Connection]
+	attr_reader :connection
+
+	# Object name (or expression)
+	# @return [String]
+	attr_reader :name
+
+	# Base constructor.
+	# @param [JDBCHelper::Connection] conn JDBCHelper::Connection object
+	# @param [String/Symbol] name Name of the object to be wrapped
+	def initialize(conn, name)
+		raise Exception.new(
+			"JDBCHelper::ObjectWrapper is an abstract class") if 
+					self.instance_of? ObjectWrapper
+
+		@connection = conn
+		@name = name.to_s
+		JDBCHelper::SQL.check @name, true
+	end
+end#ObjectWrapper
+end#JDBCHelper
+

data/lib/jdbc-helper/wrapper/procedure_wrapper.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+# Junegunn Choi (junegunn.c@gmail.com)
+
+module JDBCHelper
+# A wrapper object representing a database procedure.
+# @since 0.3.0
+# @example Usage
+#  conn.function(:coalesce).call(nil, nil, 'king')
+class ProcedureWrapper < ObjectWrapper
+	# Returns the name of the procedure
+	# @return [String]
+	alias to_s name
+
+	# Executes the procedure and returns the values of INOUT & OUT parameters in Hash
+	# @return [Hash]
+	def call(*args)
+		param_count = args.first.kind_of?(Hash) ? args.first.keys.length : args.length
+
+		cstmt = @connection.prepare_call "{call #{name}(#{Array.new(param_count){'?'}.join ', '})}"
+		begin
+			cstmt.call *args
+		ensure
+			cstmt.close
+		end
+	end
+end#ProcedureWrapper
+end#JDBCHelper
+

data/lib/jdbc-helper/{object_wrapper.rb → wrapper/table_wrapper.rb}

@@ -2,33 +2,6 @@
 # Junegunn Choi (junegunn.c@gmail.com)
 
 module JDBCHelper
-# Abstract base class for wrappers for various database objects.
-# @abstract
-# @since 0.2.0
-# @todo Need to add more subclasses (such as for functions and procedures)
-class ObjectWrapper
-	# Underlying JDBCHelper::Connection object
-	# @return [JDBCHelper::Connection]
-	attr_reader :connection
-
-	# Object name (or expression)
-	# @return [String]
-	attr_reader :name
-
-	# Base constructor.
-	# @param [JDBCHelper::Connection] conn JDBCHelper::Connection object
-	# @param [String] name Name of the object to be wrapped
-	def initialize(conn, name)
-		raise Exception.new(
-			"JDBCHelper::ObjectWrapper is an abstract class") if 
-					self.instance_of? ObjectWrapper
-
-		@connection = conn
-		@name = name.to_s
-		JDBCHelper::SQL.check @name
-	end
-end#ObjectWrapper
-
 # A wrapper object representing a database table. Allows you to perform table operations easily.
 # @since 0.2.0
 # @example Usage
@@ -47,10 +20,14 @@ end#ObjectWrapper
 #  conn.table('test.data').truncate_table!
 #  conn.table('test.data').drop_table!
 class TableWrapper < ObjectWrapper
+	# Returns the name of the table
+	# @return [String]
+	alias to_s name
+
 	# Retrieves the count of the table
 	# @return [Fixnum] Count of the records.
 	def count(where = nil)
-		@connection.query(JDBCHelper::SQL.count name, where)[0][0]
+		@connection.query(JDBCHelper::SQL.count name, where)[0][0].to_i
 	end
 
 	# Sees if the table is empty
@@ -121,6 +98,5 @@ class TableWrapper < ObjectWrapper
 		@connection.update(JDBCHelper::SQL.check "drop table #{name}")
 	end
 end#TableWrapper
-
 end#JDBCHelper
 

data/lib/jdbc-helper.rb

@@ -16,7 +16,6 @@ module JavaSql # :nodoc:
 end
 
 require 'jdbc-helper/sql'
-require 'jdbc-helper/object_wrapper'
 require 'jdbc-helper/constants'
 require 'jdbc-helper/connection'
 require 'jdbc-helper/connector'

data/test/database.yml

@@ -2,14 +2,12 @@
 mysql:
     driver: com.mysql.jdbc.Driver
     url: jdbc:mysql://localhost/test
-    user: mysql
+    user: root
     password:
-    database: test
 
-# oracle:
-#     driver: com.mysql.jdbc.Driver
-#     url: jdbc:oracle:thin:@localhost/test
-#     user: test
-#     password:
-#     database: test
+oracle:
+    driver: oracle.jdbc.driver.OracleDriver
+    url: jdbc:oracle:thin:@localhost/test
+    user: user
+    password: password
 

data/test/helper.rb

@@ -22,9 +22,55 @@ module JDBCHelperTestHelper
 		@db_config ||= YAML.load File.read(File.dirname(__FILE__) + '/database.yml')
 	end
 
+	def create_test_procedure conn, name
+		case @type
+		when :mysql
+			conn.update "drop procedure #{name}" rescue nil
+			conn.update("
+				create procedure #{name} 
+				(IN i1 varchar(100), IN i2 int, 
+				 INOUT io1 int, INOUT io2 timestamp,
+				 OUT o1 float, OUT o2 varchar(100))
+				select io1 * 10, 0.1, i1 into io1, o1, o2 from dual")
+		when :oracle
+			conn.update "drop procedure #{name}" rescue nil
+			conn.update "
+				create or replace
+				procedure #{name} 
+				(i1 in varchar2, i2 in int,
+				 io1 in out int, io2 in out date,
+				 o1 out float, o2 out varchar2) as
+				begin
+					  select io1 * 10, 0.1, i1 into io1, o1, o2 from dual;
+				end;"
+		else
+			raise NotImplementedError.new "Procedure test not implemented for #{@type}"
+		end
+	end
+
+	# This is crazy. But Oracle.
+	def assert_equal *args
+		if args.first.class == Fixnum
+			super(args[0].to_s, args[1].to_s)
+		else
+			super(*args)
+		end
+	end
+
 	def each_connection(&block)
 		config.each do | db, conn_info |
 			conn = JDBCHelper::Connection.new(conn_info)
+			# Just for quick and dirty testing
+			@type = case conn_info['driver'] || conn_info[:driver]
+					when /mysql/i
+						:mysql
+					when /oracle/i
+						:oracle
+					else
+						p conn_info
+						:unknown
+					end
+
 			begin
 				if block.arity == 1
 					yield conn

data/test/test_connection.rb

@@ -7,9 +7,12 @@ class TestConnection < Test::Unit::TestCase
 	end
 
 	def teardown
+		conn.update "drop table #{TEST_TABLE}" rescue nil
+		conn.update "drop procedure #{TEST_PROCEDURE}" rescue nil
 	end
 
 	TEST_TABLE = 'tmp_jdbc_helper_test'
+	TEST_PROCEDURE = 'tmp_jdbc_helper_test_proc'
 
 	def get_one_two
 		"
@@ -26,8 +29,8 @@ class TestConnection < Test::Unit::TestCase
 		assert_equal 1, rec[0]
 		assert_equal 1, rec['one']
 		assert_equal 1, rec[:one]
-		assert_equal [1], rec[0...1]
-		assert_equal [1], rec[0, 1]
+		assert_equal ['1'], rec[0...1].map(&:to_s)
+		assert_equal ['1'], rec[0, 1].map(&:to_s)
 
 		assert_equal 'two', rec.two
 		assert_equal 'two', rec[1]
@@ -35,9 +38,9 @@ class TestConnection < Test::Unit::TestCase
 		assert_equal ['two'], rec[1..-1]
 		assert_equal ['two'], rec[1, 1]
 
-		assert_equal [1, 'two'], rec[0..1]
-		assert_equal [1, 'two'], rec[0..-1]
-		assert_equal [1, 'two'], rec[0, 2]
+		assert_equal ['1', 'two'], rec[0..1].map(&:to_s)
+		assert_equal ['1', 'two'], rec[0..-1].map(&:to_s)
+		assert_equal ['1', 'two'], rec[0, 2].map(&:to_s)
 
 		assert_raise(NoMethodError) { rec.three }
 		assert_raise(NameError) { rec['three'] }
@@ -66,8 +69,10 @@ class TestConnection < Test::Unit::TestCase
 	# ---------------------------------------------------------------
 
 	def test_connect_and_close
-		config.each do | db, conn_info |
+		config.each do | db, conn_info_org |
 			4.times do | i |
+				conn_info = conn_info_org.dup
+
 				# With or without timeout parameter
 				conn_info['timeout'] = 60 if i % 2 == 1
 
@@ -197,6 +202,8 @@ class TestConnection < Test::Unit::TestCase
 		each_connection do | conn |
 			reset_test_table conn
 			ins = conn.prepare "insert into #{TEST_TABLE} values (?, ?)"
+			assert_equal 2, ins.parameter_count
+
 			count = 100
 
 			# update
@@ -289,5 +296,75 @@ class TestConnection < Test::Unit::TestCase
 			assert_equal ts.to_i * 1000, got.getTime
 		end
 	end
+
+	# Conditional testing is bad, but
+	# Oracle and MySQL behave differently.
+	def test_callable_statement
+		each_connection do | conn |
+			# Creating test procedure (Defined in JDBCHelperTestHelper)
+			create_test_procedure conn, TEST_PROCEDURE
+
+			# Array parameter
+			cstmt_ord = conn.prepare_call "{call #{TEST_PROCEDURE}(?, ?, ?, ?, ?, ?)}"
+			result = cstmt_ord.call('hello', 10, [100, Fixnum], [Time.now, Time], Float, String)
+			assert_instance_of Hash, result
+			assert_equal 1000, result[3]
+			assert_equal 'hello', result[6]
+
+			# Hash parameter
+			cstmt_name = conn.prepare_call(case @type
+						when :oracle
+							"{call #{TEST_PROCEDURE}(:i1, :i2, :io1, :io2, :o1, :o2)}"
+						else
+							"{call #{TEST_PROCEDURE}(?, ?, ?, ?, ?, ?)}"
+						end)
+			result = cstmt_name.call(
+				:i1 => 'hello', :i2 => 10,
+				:io1 => [100, Fixnum], 'io2' => [Time.now, Time], 
+				:o1 => Float, 'o2' => String)
+			assert_instance_of Hash, result
+			assert_equal 1000, result[:io1]
+			assert_equal 'hello', result['o2']
+
+			# Invalid parameters
+			#assert_raise(NativeException) { cstmt_ord.call 1 }
+			assert_raise(ArgumentError)   { cstmt_ord.call({}, {}) }
+			assert_raise(NativeException) { cstmt_name.call 1 }
+			assert_raise(ArgumentError)   { cstmt_name.call({}, {}) }
+
+			# Close
+			[ cstmt_ord, cstmt_name ].each do | cstmt |
+				assert_equal false, cstmt.closed?
+				cstmt.close
+				assert_equal true, cstmt.closed?
+				assert_raise(RuntimeError) { cstmt.call }
+			end
+
+			# pend('mysql raises data truncation error') do
+			if @type != :mysql
+				cstmt_ord = conn.prepare_call "{call #{TEST_PROCEDURE}(?, 10, ?, ?, ?, ?)}"
+				cstmt_name = conn.prepare_call(case @type
+						when :oracle
+							"{call #{TEST_PROCEDURE}(:i1, 10, :io1, :io2, :o1, :o2)}"
+						else
+							"{call #{TEST_PROCEDURE}(?, 10, ?, ?, ?, ?)}"
+						end)
+				# Hash parameter
+				result = cstmt_name.call(
+					:i1 => 'hello',# :i2 => 10,
+					:io1 => [100, Fixnum], 'io2' => [Time.now, Time], 
+					:o1 => Float, 'o2' => String)
+				assert_instance_of Hash, result
+				assert_equal 1000, result[:io1]
+				assert_equal 'hello', result['o2']
+
+				# Array parameter
+				result = cstmt_ord.call('hello', [100, Fixnum], [Time.now, Time], Float, String)
+				assert_instance_of Hash, result
+				assert_equal 1000, result[2]
+				assert_equal 'hello', result[5]
+			end
+		end
+	end
 end
 

data/test/test_connectors.rb

@@ -11,7 +11,7 @@ class TestConnectors < Test::Unit::TestCase
 
 	def test_connectors
 		config.each do | db, conn_info |
-			if db == 'mysql'
+			if conn_info['driver'] =~ /mysql/
 				host = conn_info['url'].match(%r{//(.*?)/})[1]
 				db = conn_info['url'].match(%r{/([^/?]*?)(\?.*)?$})[1]
 				conn = JDBCHelper::MySQLConnector.connect(host, conn_info['user'], conn_info['password'], db)
@@ -19,8 +19,8 @@ class TestConnectors < Test::Unit::TestCase
 				assert conn.closed? == false
 				conn.close
 				assert conn.closed?
-			elsif db == 'oracle'
-				host = conn_info['url'].match(%r{//(.*?)/})[1]
+			elsif conn_info['driver'] =~ /oracle/
+				host = conn_info['url'].match(%r{@(.*?)/})[1]
 				svc = conn_info['url'].match(%r{/([^/?]*?)(\?.*)?$})[1]
 				conn = JDBCHelper::OracleConnector.connect(host, conn_info['user'], conn_info['password'], svc)