jdbc-helper 0.4.4 → 0.4.5

data/README.rdoc

@@ -6,13 +6,18 @@ crucial database operations from primitive selects and updates to more complex o
 batch updates, prepared statements and transactions.
 As the name implies, this gem only works on JRuby.
 
-== Examples
+== Installation
+=== Install gem
+ gem install jdbc-helper
 
-=== Prerequisites
-Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
- export CLASSPATH=$CLASSPATH:~/lib/mysql-connector-java.jar
+=== Setting up CLASSPATH
+Add the appropriate JDBC drivers to the CLASSPATH.
+ export CLASSPATH=$CLASSPATH:~/lib/mysql-connector-java-5.1.16-bin.jar:~/lib/ojdbc6.jar
 
+=== In Ruby
+ require 'jdbc-helper'
 
+== Examples
 === Connecting to a database
 
  # :driver and :url must be given
@@ -35,9 +40,13 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
  conn = JDBCHelper::MySQLConnector.connect('localhost', 'mysql', '', 'test')
  conn.close
 
+  # Oracle shortcut connector
+ conn = JDBCHelper::OracleConnector.connect(host, user, password, service_name)
+ conn.close
+
 === Querying database table
 
- conn.query("SELECT a, b, c FROM T") do | row |
+ conn.query("SELECT a, b, c FROM T") do |row|
      row.labels
      row.rownum
 
@@ -55,8 +64,8 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
  uniq_rows = rows.uniq
 
  # You can even nest queries
- conn.query("SELECT a FROM T") do | row1 |
-     conn.query("SELECT * FROM T_#{row1.a}") do | row2 |
+ conn.query("SELECT a FROM T") do |row1|
+     conn.query("SELECT * FROM T_#{row1.a}") do |row2|
          # ...
      end
  end
@@ -65,7 +74,7 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
  # When the result set of the query is expected to be large and you wish to
  # chain enumerators, `enumerate' is much preferred over `query'. (which returns the
  # array of the entire rows)
- conn.enumerate("SELECT * FROM LARGE_T").each_slice(1000) do | slice |
+ conn.enumerate("SELECT * FROM LARGE_T").each_slice(1000) do |slice|
     slice.each do | row |
         # ...
     end
@@ -75,7 +84,7 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
  del_count = conn.update("DELETE FROM T")
 
 === Transaction
- committed = conn.transaction do | tx |
+ committed = conn.transaction do |tx|
      # ...
      # Transaction logic here
      # ...
@@ -96,14 +105,14 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
 
 === Using prepared statements
  p_sel = conn.prepare("SELECT * FROM T WHERE b = ? and c = ?")
- p_sel.query(100, 200) do | row |
+ p_sel.query(100, 200) do |row|
      p row
  end
  p_sel.close
 
  p_upd = conn.prepare("UPDATE T SET a = ? WHERE b = ?")
  count = 0
- 100.times do | i |
+ 100.times do |i|
      count += p_upd.update('updated a', i)
  end
 
@@ -114,68 +123,80 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
  p_upd.close
 
 === Using table wrappers (since 0.2.0)
-  # For more complex examples, refer to test/test_object_wrapper.rb
+ # For more complex examples, refer to test/test_object_wrapper.rb
 
-  # Creates a table wrapper
-  table = conn.table('test.data')
+ # Creates a table wrapper
+ table = conn.table('test.data')
 
-  # Counting the records in the table
-  table.count
-  table.count(:a => 10)
-  table.where(:a => 10).count
+ # Counting the records in the table
+ table.count
+ table.count(:a => 10)
+ table.where(:a => 10).count
 
-  table.empty?
-  table.where(:a => 10).empty?
+ table.empty?
+ table.where(:a => 10).empty?
 
-  # Selects the table by combining select, where, and order methods
-  table.select('a apple', :b).where(:c => (1..10)).order('b desc', 'a asc') do |row|
-    puts row.apple
-  end
+ # Selects the table by combining select, where, and order methods
+ table.select('a apple', :b).where(:c => (1..10)).order('b desc', 'a asc') do |row|
+   puts row.apple
+ end
+
+ # Build select SQL
+ sql = table.select('a apple', :b).where(:c => (1..10)).order('b desc', 'a asc').sql
 
-  # Build select SQL
-  sql = table.select('a apple', :b).where(:c => (1..10)).order('b desc', 'a asc').sql
+ # Updates with conditions
+ table.update(:a => 'hello', :b => JDBCHelper::SQL('now()'), :where => { :c => 3 })
+ # Or equivalently,
+ table.where(:c => 3).update(:a => 'hello', :b => JDBCHelper::SQL('now()'))
 
-  # Updates with conditions
-  table.update(:a => 'hello', :b => JDBCHelper::SQL('now()'), :where => { :c => 3 })
-  # Or equivalently,
-  table.where(:c => 3).update(:a => 'hello', :b => JDBCHelper::SQL('now()'))
+ # Insert into the table
+ table.insert(:a => 10, :b => 20, :c => JDBCHelper::SQL('10 + 20'))
+ table.insert_ignore(:a => 10, :b => 20, :c => 30)
+ table.replace(:a => 10, :b => 20, :c => 30)
 
-  # Insert into the table
-  table.insert(:a => 10, :b => 20, :c => JDBCHelper::SQL('10 + 20'))
-  table.insert_ignore(:a => 10, :b => 20, :c => 30)
-  table.replace(:a => 10, :b => 20, :c => 30)
+ # Update with common default values
+ with_defaults = table.default(:a => 10, :b => 20)
+ with_defaults.insert(:c => 30)
+ with_defaults.where('a != 10 or b != 20').update   # sets a => 10, b => 20
 
-  # Batch updates with batch method
-  table.batch.insert(:a => 10, :b => 20, :c => JDBCHelper::SQL('10 + 20'))
-  table.batch.insert_ignore(:a => 10, :b => 20, :c => 30)
-  conn.execute_batch
+ # Batch updates with batch method
+ table.batch.insert(:a => 10, :b => 20, :c => JDBCHelper::SQL('10 + 20'))
+ table.batch.insert_ignore(:a => 10, :b => 20, :c => 30)
+ conn.execute_batch
 
-  # Delete with conditions
-  table.delete(:c => 3)
-  # Or equivalently,
-  table.where(:c => 3).delete
+ # Delete with conditions
+ table.delete(:c => 3)
+ # Or equivalently,
+ table.where(:c => 3).delete
 
-  # Truncate or drop table (Cannot be undone)
-  table.truncate!
-  table.drop!
+ # Truncate or drop table (Cannot be undone)
+ table.truncate!
+ table.drop!
 
 === Using function wrappers (since 0.2.2)
-  conn.function(:mod).call 5, 3
-  conn.function(:coalesce).call(nil, nil, 'king')
+ conn.function(:mod).call 5, 3
+ conn.function(:coalesce).call(nil, nil, 'king')
 
 === Using procedure wrappers (since 0.3.0)
-  # Working with IN/INOUT/OUT parameteres
-  # Bind by ordinal number
-  conn.procedure(:update_and_fetch_something).call(
+ # Working with IN/INOUT/OUT parameteres
+ # Bind by ordinal number
+ conn.procedure(:update_and_fetch_something).call(
 		  100,                 # Input parameter 
 		  ["value", String],   # Input/Output parameter
 		  Fixnum               # Output parameter
-  )
+ )
 
-  # Bind by parameter name
-  conn.procedure(:update_and_fetch_something).call(
+ # Bind by parameter name
+ conn.procedure(:update_and_fetch_something).call(
 		  :a => 100, :b => ["value", String], :c => Fixnum)
 
+=== Using sequence wrappers (since 0.4.2)
+ seq = conn.sequence(:my_seq)
+ next = seq.nextval
+ curr = seq.currval
+ seq.reset!
+ seq.reset! 100
+
 == Contributing to jdbc-helper
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

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

@@ -50,7 +50,7 @@ class TableWrapper < ObjectWrapper
 	# @param [List of Hash/String] where Filter conditions
 	# @return [Fixnum] Count of the records.
 	def count *where
-		@connection.query(JDBCHelper::SQL.count name, merge_where(self, where))[0][0].to_i
+		@connection.query(JDBCHelper::SQL.count(name, @query_where + where))[0][0].to_i
 	end
 
 	# Sees if the table is empty
@@ -63,8 +63,8 @@ class TableWrapper < ObjectWrapper
 	# Inserts a record into the table with the given hash
 	# @param [Hash] data_hash Column values in Hash
 	# @return [Fixnum] Number of affected records
-	def insert data_hash
-		@connection.send @update_method, JDBCHelper::SQL.insert(name, data_hash)
+	def insert data_hash = {}
+		@connection.send @update_method, JDBCHelper::SQL.insert(name, @query_default.merge(data_hash))
 	end
 
 	# Inserts a record into the table with the given hash.
@@ -72,16 +72,16 @@ class TableWrapper < ObjectWrapper
 	# @note This is not SQL standard. Only works if the database supports insert ignore syntax.
 	# @param [Hash] data_hash Column values in Hash
 	# @return [Fixnum] Number of affected records
-	def insert_ignore data_hash
-		@connection.send @update_method, JDBCHelper::SQL.insert_ignore(name, data_hash)
+	def insert_ignore data_hash = {}
+		@connection.send @update_method, JDBCHelper::SQL.insert_ignore(name, @query_default.merge(data_hash))
 	end
 
 	# Replaces a record in the table with the new one with the same unique key.
 	# @note This is not SQL standard. Only works if the database supports replace syntax.
 	# @param [Hash] data_hash Column values in Hash
 	# @return [Fixnum] Number of affected records
-	def replace data_hash
-		@connection.send @update_method, JDBCHelper::SQL.replace(name, data_hash)
+	def replace data_hash = {}
+		@connection.send @update_method, JDBCHelper::SQL.replace(name, @query_default.merge(data_hash))
 	end
 
 	# Executes update with the given hash.
@@ -89,19 +89,18 @@ class TableWrapper < ObjectWrapper
 	# @param [Hash] data_hash_with_where Column values in Hash.
 	#   :where element of the given hash can (usually should) point to another Hash representing update filters.
 	# @return [Fixnum] Number of affected records
-	def update data_hash_with_where
+	def update data_hash_with_where = {}
 		where_ext = data_hash_with_where.delete(:where)
 		where_ext = [where_ext] unless where_ext.is_a? Array
-		where = merge_where(self, where_ext.compact)
-		@connection.send @update_method, JDBCHelper::SQL.update(name, data_hash_with_where, where)
+		@connection.send @update_method, 
+			JDBCHelper::SQL.update(name, @query_default.merge(data_hash_with_where), @query_where + where_ext.compact)
 	end
 
 	# Deletes records matching given condtion
 	# @param [List of Hash/String] where Delete filters
 	# @return [Fixnum] Number of affected records
 	def delete *where
-		where = merge_where(self, where)
-		@connection.send @update_method, JDBCHelper::SQL.delete(name, where)
+		@connection.send @update_method, JDBCHelper::SQL.delete(name, @query_where + where)
 	end
 
 	# Empties the table.
@@ -128,7 +127,7 @@ class TableWrapper < ObjectWrapper
 	# Returns a new TableWrapper object which can be used to execute a select
 	# statement for the table selecting only the specified fields.
 	# If a block is given, executes the select statement and yields each row to the block.
-	# @return [*String/*Symbol] List of fields to select
+	# @param [*String/*Symbol] fields List of fields to select
 	# @return [JDBCHelper::TableWrapper]
 	# @since 0.4.0
 	def select *fields, &block
@@ -140,21 +139,21 @@ class TableWrapper < ObjectWrapper
 	# Returns a new TableWrapper object which can be used to execute a select
 	# statement for the table with the specified filter conditions.
 	# If a block is given, executes the select statement and yields each row to the block.
-	# @param [List of Hash/String] Filter conditions
+	# @param [List of Hash/String] conditions Filter conditions
 	# @return [JDBCHelper::TableWrapper]
 	# @since 0.4.0
 	def where *conditions, &block
 		raise ArgumentError.new("Wrong number of arguments") if conditions.empty?
 
 		obj = self.dup
-		merge_where(obj, conditions, true)
+		obj.instance_variable_set :@query_where, @query_where + conditions
 		ret obj, &block
 	end
 
 	# Returns a new TableWrapper object which can be used to execute a select
 	# statement for the table with the given sorting criteria.
 	# If a block is given, executes the select statement and yields each row to the block.
-	# @param [*String/*Symbol] Sorting criteria
+	# @param [*String/*Symbol] criteria Sorting criteria
 	# @return [JDBCHelper::TableWrapper]
 	# @since 0.4.0
 	def order *criteria, &block
@@ -164,6 +163,19 @@ class TableWrapper < ObjectWrapper
 		ret obj, &block
 	end
 
+	# Returns a new TableWrapper object with default values, which will be applied to
+	# the subsequent inserts and updates.
+	# @param [Hash] data_hash Default values
+	# @return [JDBCHelper::TableWrapper]
+	# @since 0.4.5
+	def default data_hash
+		raise ArgumentError.new("Hash required") unless data_hash.kind_of? Hash
+
+		obj = self.dup
+		obj.instance_variable_set :@query_default, @query_default.merge(data_hash)
+		obj
+	end
+
 	# Executes a select SQL for the table and returns an Enumerable object,
 	# or yields each row if block is given.
 	# @return [JDBCHelper::Connection::ResultSetEnumerator]
@@ -209,6 +221,8 @@ class TableWrapper < ObjectWrapper
 	def initialize connection, table_name
 		super connection, table_name
 		@update_method = :update
+		@query_default = {}
+		@query_where = []
 	end
 private
 	def ret obj, &block
@@ -218,12 +232,6 @@ private
 			obj
 		end
 	end
-
-	def merge_where obj, where, apply = false
-		merged = (obj.instance_variable_get(:@query_where) || []) + (where || [])
-		obj.instance_variable_set :@query_where, merged if apply
-		merged
-	end
 end#TableWrapper
 end#JDBCHelper
 

data/test/test_object_wrapper.rb

@@ -72,12 +72,15 @@ class TestObjectWrapper < Test::Unit::TestCase
 
 	def insert table, cnt = 100
 		params = {
-			:alpha => 100, 
+			:alpha => 100,
 			:beta => JDBCHelper::SQL('0.1 + 0.2'), 
-			:gamma => 'hello world' }
+		}
 
 		(1..cnt).each do |pk|
-			icnt = table.insert(params.merge(:id => pk))
+			icnt = table.
+					default(:gamma => 'hello world').
+					default(:alpha => 200).
+					insert(params.merge(:id => pk))
 			assert_equal 1, icnt unless table.batch?
 		end
 	end
@@ -334,7 +337,13 @@ class TestObjectWrapper < Test::Unit::TestCase
 
 			assert_equal 10, table.update(:beta => 0, :where => { :id => (1..10) })
 			assert_equal 2, table.where(:id => (55..56)).update(:beta => 0, :where => { :id => (51..60) })
-			assert_equal 10, table.where(:id => (11..20)).update(:beta => 0)
+			assert_equal 10, table.where(:id => (11..20)).update(:beta => 1)
+
+			with_default = table.default(:beta => 0)
+			assert_equal 5, with_default.where(:id => (11..15)).update
+			assert_equal 5, with_default.where(:id => (16..20)).update
+			with_default = table.default(:beta => 1)
+			assert_equal 5, with_default.where(:id => (16..20)).update(:beta => 0) # override
 			assert_equal 22, table.count(:beta => 0)
 			assert_equal 100, table.update(:beta => 1)
 		end

metadata

@@ -2,7 +2,7 @@
 name: jdbc-helper
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors: 
   - Junegunn Choi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-09 00:00:00 +09:00
+date: 2011-06-10 00:00:00 +09:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency