jdbc-helper 0.1.2

data/lib/jdbc-helper/connector/oracle_connector.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+# Junegunn Choi (junegunn.c@gmail.com)
+
+module JDBCHelper
+# Shortcut connector for Oracle
+module OracleConnector
+	include Constants
+	include Constants::Connector
+
+	def self.connect(host, user, password, service_name, timeout = DEFAULT_LOGIN_TIMEOUT)
+		Connection.new(
+			:driver   => JDBC_DRIVER[:oracle],
+			:url      => "jdbc:oracle:thin:@#{host}/#{service_name}",
+			:user     => user,
+			:password => password,
+			:timeout  => timeout)
+	end
+
+	def self.connect_by_sid(host, user, password, sid, timeout = DEFAULT_LOGIN_TIMEOUT)
+		Connection.new(
+			:driver   => JDBC_DRIVER[:oracle],
+			:url      => "jdbc:oracle:thin:@#{host}:#{sid}",
+			:user     => user,
+			:password => password,
+			:timeout  => timeout)
+	end
+end#OracleConnector
+end#JDBCHelper
+

data/lib/jdbc-helper/constants.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+# Junegunn Choi (junegunn.c@gmail.com)
+
+module JDBCHelper
+module Constants
+	# Default login timeout is set to 60 seconds
+	DEFAULT_LOGIN_TIMEOUT = 60
+
+	# Constants only for Connectors
+	module Connector
+		JDBC_DRIVER = {
+			:oracle => 'oracle.jdbc.driver.OracleDriver',
+			:mysql  => 'com.mysql.jdbc.Driver'
+		}
+
+		DEFAULT_PARAMETERS = {
+			:mysql => {
+				'zeroDateTimeBehavior' => 'convertToNull',
+				'rewriteBatchedStatements' => 'true',
+				'useServerPrepStmts' => 'true',
+				'useCursorFetch' => 'true'
+			}
+		}
+	end#Connector
+end#Constants
+end#JDBCHelper

data/test/database.yml

@@ -0,0 +1,13 @@
+---
+mysql:
+    driver: com.mysql.jdbc.Driver
+    url: jdbc:mysql://localhost/test
+    user: mysql
+    password:
+
+# oracle:
+#     driver: com.mysql.jdbc.Driver
+#     url: jdbc:mysql://localhost/test
+#     user: mysql
+#     password:
+

data/test/helper.rb

@@ -0,0 +1,17 @@
+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 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jdbc-helper'
+
+class Test::Unit::TestCase
+end

data/test/test_jdbc-helper.rb

@@ -0,0 +1,292 @@
+require 'helper'
+
+class TestJdbcHelper < Test::Unit::TestCase
+	def setup
+		require 'yaml'
+		@config = YAML.load File.read(File.dirname(__FILE__) + '/database.yml')
+	end
+
+	def teardown
+
+	end
+
+	TEST_TABLE = 'tmp_jdbc_helper_test'
+
+	def each_connection
+		@config.each do | db, conn_info |
+			conn = JDBCHelper::Connection.new(conn_info)
+			begin
+				yield conn
+			ensure
+				conn.close
+			end
+		end
+	end
+
+	def get_one_two
+		"
+		select 1 one, 'two' two from dual
+		union all
+		select 1 one, 'two' two from dual
+		"
+	end
+
+	def check_one_two(rec)
+		assert_equal 2, rec.length
+
+		assert_equal 1, rec.one
+		assert_equal 1, rec[0]
+		assert_equal 1, rec['one']
+
+		assert_equal 'two', rec.two
+		assert_equal 'two', rec[1]
+		assert_equal 'two', rec['two']
+
+		assert_raise(NameError) { rec.three }
+		assert_raise(NameError) { rec['three'] }
+		assert_raise(RangeError) { rec[3] }
+	end
+
+	def reset_test_table conn
+		conn.update "drop table #{TEST_TABLE}" rescue nil
+		cnt = conn.update '
+			create table tmp_jdbc_helper_test (
+				a int primary key,
+				b varchar(100)
+			)'
+		assert_equal 0, cnt
+	end
+
+	# ---------------------------------------------------------------
+
+	def test_connect_and_close
+		@config.each do | db, conn_info |
+			4.times do | i |
+				# With or without timeout parameter
+				conn_info['timeout'] = 60 if i % 2 == 1
+
+				# Can connect with hash with symbol keys?
+				conn_info.keys.each do | str_key |
+					conn_info[str_key.to_sym] = conn_info.delete str_key
+				end if i % 2 == 0
+
+				conn = JDBCHelper::Connection.new(conn_info)
+				assert_equal(conn.closed?, false)
+				conn.close
+				assert_equal(conn.closed?, true)
+				[ :query, :update, :add_batch, :prepare ].each do | met |
+					assert_raise(RuntimeError) { conn.send met, "A" }
+				end
+				[ :execute_batch, :clear_batch ].each do | met |
+					assert_raise(RuntimeError) { conn.send met }
+				end
+
+				# initialize with execution block
+				conn = JDBCHelper::Connection.new(conn_info) do | c |
+					c.query('select 1 from dual')
+					assert_equal c.closed?, false
+				end
+				assert conn.closed?
+			end
+		end
+	end
+
+	def test_query_enumerate
+		each_connection do | conn |
+			# Query without a block => Array
+			query_result = conn.query get_one_two
+			assert query_result.is_a? Array
+			assert_equal 2, query_result.length
+			check_one_two(query_result.first)
+
+			# Query with a block
+			count = 0
+			conn.query(get_one_two) do | row |
+				check_one_two row
+				count += 1
+			end
+			assert_equal 2, count
+
+			# Enumerate
+			enum = conn.enumerate(get_one_two)
+			assert enum.is_a? Enumerable
+			assert enum.closed? == false
+			a = enum.to_a
+			assert_equal 2, a.length
+			check_one_two a.first
+			assert enum.closed? == true
+		end
+	end
+
+	def test_update_batch
+		each_connection do | conn |
+			reset_test_table conn
+			count = 100
+
+			iq = lambda do | i |
+				"insert into #{TEST_TABLE} values (#{i}, 'A')"
+			end
+
+			# update
+			assert_equal 1, conn.update(iq.call 0)
+			assert_equal 1, conn.prev_stat.success_count
+
+			# add_batch execute_batch
+			reset_test_table conn
+
+			count.times do | p |
+				conn.add_batch iq.call(p)
+			end
+			conn.execute_batch
+			assert_equal count, conn.query("select count(*) from #{TEST_TABLE}")[0][0]
+
+			# add_batch clear_batch
+			reset_test_table conn
+
+			count.times do | p |
+				conn.add_batch iq.call(p)
+			end
+			conn.clear_batch
+			assert_equal 0, conn.query("select count(*) from #{TEST_TABLE}")[0][0]
+		end
+	end
+
+	def test_prepared_query_enumerate
+		each_connection do | conn |
+			sel = conn.prepare get_one_two
+			assert sel.closed? == false
+
+			# Query without a block => Array
+			query_result = sel.query
+			assert query_result.is_a? Array
+			assert_equal 2, query_result.length
+			check_one_two(query_result.first)
+
+			# Query with a block
+			count = 0
+			sel.query do | row |
+				check_one_two row
+				count += 1
+			end
+			assert_equal 2, count
+
+			# Enumerate
+			enum = sel.enumerate
+			assert enum.is_a? Enumerable
+			assert enum.closed? == false
+			a = enum.to_a
+			assert_equal 2, a.length
+			check_one_two a.first
+			assert enum.closed? == true
+
+			sel.close
+			assert sel.closed?
+			[ :query, :update, :add_batch, :execute_batch, :clear_batch ].each do | met |
+				assert_raise(RuntimeError) { sel.send met }
+			end
+		end
+	end
+
+	def test_prepared_update_batch
+		each_connection do | conn |
+			reset_test_table conn
+			ins = conn.prepare "insert into #{TEST_TABLE} values (?, ?)"
+			count = 100
+
+			# update
+			assert ins.closed? == false
+			assert_equal 1, ins.update(0, 'A')
+			assert_equal 1, conn.prev_stat.success_count
+			ins.close
+
+			# add_batch execute_batch
+			reset_test_table conn
+			ins = conn.prepare "insert into #{TEST_TABLE} values (?, ?)"
+
+			count.times do | p |
+				ins.add_batch(p + 1, 'A')
+			end
+			ins.execute_batch
+			assert_equal count, conn.query("select count(*) from #{TEST_TABLE}")[0][0]
+			ins.close
+
+			# add_batch clear_batch
+			reset_test_table conn
+			ins = conn.prepare "insert into #{TEST_TABLE} values (?, ?)"
+
+			count.times do | p |
+				ins.add_batch(p + 1, 'A')
+			end
+			ins.clear_batch
+			assert_equal 0, conn.query("select count(*) from #{TEST_TABLE}")[0][0]
+
+			# close closed?
+			assert ins.closed? == false
+			ins.close
+			assert ins.closed?
+			[ :query, :update, :add_batch, :execute_batch, :clear_batch ].each do | met |
+				assert_raise(RuntimeError) { ins.send met }
+			end
+		end
+	end
+	
+	def test_transaction
+		each_connection do | conn |
+			reset_test_table conn
+			count = 100
+
+			3.times do | i |
+				sum = 0
+				conn.update "delete from #{TEST_TABLE}"
+				conn.transaction do | tx |
+					count.times.each_slice(10) do | slice |
+						slice.each do | p |
+							conn.add_batch("insert into #{TEST_TABLE} values (#{p}, 'xxx')")
+							sum += p
+						end
+						conn.execute_batch
+					end
+					result = conn.query("select count(*), sum(a) from #{TEST_TABLE}").first
+
+					assert_equal count, result.first
+					assert_equal sum, result.last.to_i
+
+					case i
+					when 0 then tx.rollback
+					when 1 then tx.commit
+					else
+						nil # committed implicitly
+					end
+
+					flunk 'This should not be executed' if i < 2
+				end
+
+				assert_equal (i == 0 ? 0 : count),
+					conn.query("select count(*) from #{TEST_TABLE}").first.first
+			end
+		end
+	end
+
+	def test_connectors
+		@config.each do | db, conn_info |
+			if db == '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)
+
+				assert conn.closed? == false
+				conn.close
+				assert conn.closed?
+			elsif db == '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)
+
+				assert conn.closed? == false
+				conn.close
+				assert conn.closed?
+			end
+		end
+	end
+end
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: jdbc-helper
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.2
+platform: ruby
+authors: 
+  - Junegunn Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-01 00:00:00 +09:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.0.0
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: jeweler
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.5.2
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: rcov
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id003
+description: JDBCHelper::Connection object wraps around a JDBC connection and provides much nicer interface to crucial database operations from primitive selects and updates to more complex ones involving batch updates, prepared statements and transactions.
+email: junegunn.c@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - LICENSE.txt
+  - README.rdoc
+files: 
+  - lib/jdbc-helper.rb
+  - lib/jdbc-helper/connection.rb
+  - lib/jdbc-helper/connection/prepared_statement.rb
+  - lib/jdbc-helper/connection/result_set_enumerator.rb
+  - lib/jdbc-helper/connection/row.rb
+  - lib/jdbc-helper/connection/statement_pool.rb
+  - lib/jdbc-helper/connector.rb
+  - lib/jdbc-helper/connector/mysql_connector.rb
+  - lib/jdbc-helper/connector/oracle_connector.rb
+  - lib/jdbc-helper/constants.rb
+  - LICENSE.txt
+  - README.rdoc
+  - test/database.yml
+  - test/helper.rb
+  - test/test_jdbc-helper.rb
+has_rdoc: true
+homepage: http://github.com/junegunn/jdbc-helper
+licenses: 
+  - MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: A JDBC helper for Ruby/Database developers
+test_files: 
+  - test/database.yml
+  - test/helper.rb
+  - test/test_jdbc-helper.rb