db 0.8.0 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99d4c7411ec402a465403035740d0ecec4827992808204a2f3e6a3ef6747f5f
-  data.tar.gz: da794cd95025fbc95034ea0a7d48853ba5c57d7c0f3f3b2b5d312139628f5c11
+  metadata.gz: 58899749a83841be74872890b6d8486f43edd65cd6fdf03762b9e07e215332a9
+  data.tar.gz: 007506f94a8916a886b6e35c46f9003b6a7610fae308c7491b260ce9f5457a80
 SHA512:
-  metadata.gz: 32c37129983d4b02a00eb42469a5be479909c24a2777c136eb2768f7ecb848b8061dad4f73ea7d5aa984b39a22f9295546a21122da548a2f529e6b5ffefe8ee3
-  data.tar.gz: 90919ecaa9a3ab9aa715ee9ce38cc1deb622e6c515d343e9b2a92a8b4f6c7ff1655053cd0552e4c8a9f68837366acca29d9f7d838ee597e98f41b0e4e1e948d9
+  metadata.gz: 1558a94c7975d20124df67b8adf0f39ff9344af6d8ec54d49cfaeddffefe5b0593987fcf604ae41a8d383a730b393b1e8091c41c6a83b412ba9fc5ff495d54bf
+  data.tar.gz: f2ab71979b2f5f8e75c108313c8ae74016297f7c7d93aab9b4791085467d3dc37c3b47d3e54e7e610246bc22626e12e77f99afba4a02b6ffd66de26cb1be2fc4

data/lib/db.rb

@@ -22,3 +22,4 @@
 
 require_relative 'db/version'
 require_relative 'db/adapters'
+require_relative 'db/client'

data/lib/db/client.rb

@@ -24,6 +24,7 @@ require 'async/io'
 require 'async/io/stream'
 require 'async/pool/controller'
 
+require_relative 'context/generic'
 require_relative 'context/session'
 require_relative 'context/transaction'
 
@@ -47,18 +48,27 @@ module DB
 			@pool.close
 		end
 		
+		# Acquire a generic context which will acquire a connection on demand.
+		def context(**options)
+			context = Context::Generic.new(@pool, **options)
+			
+			return context unless block_given?
+			
+			begin
+				yield context
+			ensure
+				context.close
+			end
+		end
+		
 		# Acquires a connection and sends the specified statement if given.
 		# @parameters statement [String | Nil] An optional statement to send.
 		# @yields {|session| ...} A connected session if a block is given. Implicitly closed.
 		# 	@parameter session [Context::Session]
 		# @returns [Context::Session] A connected session if no block is given.
-		def session(statement = nil, **options)
+		def session(**options)
 			session = Context::Session.new(@pool, **options)
 			
-			if statement
-				session.send_query(statement)
-			end
-			
 			return session unless block_given?
 			
 			begin
@@ -73,21 +83,21 @@ module DB
 		# @yields {|session| ...} A connected session if a block is given. Implicitly commits, or aborts the connnection if an exception is raised.
 		# 	@parameter session [Context::Transaction]
 		# @returns [Context::Transaction] A connected and started transaction if no block is given.
-		def transaction(statement = "BEGIN", **options)
+		def transaction(**options)
 			transaction = Context::Transaction.new(@pool, **options)
 			
-			if statement
-				transaction.call("BEGIN")
-			end
+			transaction.call("BEGIN")
 			
 			return transaction unless block_given?
 			
 			begin
 				yield transaction
 				
-				transaction.commit
+			rescue
+				transaction.abort
+				raise
 			ensure
-				transaction.abort if $!
+				transaction.commit?
 			end
 		end
 		

data/lib/db/context/generic.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative '../query'
+
+module DB
+	module Context
+		# A connected context for sending queries and reading results.
+		class Generic
+			# Iniitalize the query context attached to the given connection pool.
+			def initialize(pool, **options)
+				@pool = pool
+				@connection = nil
+			end
+			
+			def connection?
+				@connection != nil
+			end
+			
+			# Lazy initialize underlying connection.
+			def connection
+				@connection ||= @pool.acquire
+			end
+			
+			# Flush the connection and then return it to the connection pool.
+			def close
+				if @connection
+					@pool.release(@connection)
+					@connection = nil
+				end
+			end
+			
+			def closed?
+				@connection.nil?
+			end
+			
+			def query(fragment = String.new, **parameters)
+				if parameters.empty?
+					Query.new(self, fragment)
+				else
+					Query.new(self).interpolate(fragment, **parameters)
+				end
+			end
+			
+			def clause(fragment = String.new)
+				Query.new(self, fragment)
+			end
+			
+			# Send a query to the server.
+			# @parameter statement [String] The SQL query to send.
+			def call(statement, **options)
+				connection.send_query(statement, **options)
+				
+				yield connection if block_given?
+			ensure
+				self.close
+			end
+		end
+	end
+end

data/lib/db/context/session.rb

@@ -25,76 +25,15 @@ require_relative '../query'
 module DB
 	module Context
 		# A connected context for sending queries and reading results.
-		class Session
-			# Iniitalize the query context attached to the given connection pool.
-			def initialize(pool, **options)
-				@pool = pool
-				@connection = pool.acquire
-			end
-			
-			# The underlying connection.
-			attr :connection
-			
-			# Flush the connection and then return it to the connection pool.
-			def close
-				if @connection
-					self.flush
-					
-					@pool.release(@connection)
-					
-					@connection = nil
-				end
-			end
-			
-			def clause(*arguments)
-				Query.new(self).clause(*arguments)
-			end
-			
-			def query(fragment = String.new, **parameters)
-				if parameters.empty?
-					Query.new(self, fragment)
-				else
-					Query.new(self).interpolate(fragment, **parameters)
-				end
-			end
-			
+		class Session < Generic
 			# Send a query to the server.
 			# @parameter statement [String] The SQL query to send.
-			def send_query(statement, **options)
-				# Console.logger.info(self, statement)
-				@connection.send_query(statement, **options)
-			end
-			
-			# Read the next result. Sending a query usually generates 1 or more results.
-			# @returns [Enumerable] The resulting records.
-			def next_result
-				@connection.next_result
-			end
-			
-			# Send a query to the server and read the next result.
-			# @returns [Enumerable] The resulting records.
 			def call(statement, **options)
-				# Console.logger.info(self, statement)
-				@connection.send_query(statement, **options)
+				connection = self.connection
 				
-				return @connection.next_result
-			end
-			
-			# Enumerate all results.
-			# @yields {|result ...} The results if a block is given.
-			# 	@parameter result [Enumerable]
-			def results
-				while result = self.next_result
-					yield result
-				end
+				connection.send_query(statement, **options)
 				
-				return nil
-			end
-			
-			# Flush all outstanding results.
-			def flush
-				until @connection.next_result.nil?
-				end
+				yield connection if block_given?
 			end
 		end
 	end

data/lib/db/context/transaction.rb

@@ -31,6 +31,12 @@ module DB
 				self.close
 			end
 			
+			def commit?
+				unless self.closed?
+					self.commit
+				end
+			end
+			
 			# Abort the transaction and return the connection to the connection pool.
 			def abort
 				self.call("ROLLBACK")

data/lib/db/query.rb

@@ -23,22 +23,16 @@
 module DB
 	# Represents one or more identifiers for databases, tables or columns.
 	class Identifier < Array
-		# Construct an identifier from an array of names.
-		# e.g. `DB::Identifier[:mytable, :mycolumn]`
-		#
-		# @parameter names [Array] The array of names.
-		def self.[](*names)
-			self.new(names)
-		end
-		
 		def self.coerce(name_or_identifier)
 			case name_or_identifier
 			when Identifier
 				name_or_identifier
-			when Symbol
+			when Array
 				self.new(name_or_identifier)
+			when Symbol
+				self[name_or_identifier]
 			else
-				self.new(name_or_identifier.to_sym)
+				self[name_or_identifier.to_sym]
 			end
 		end
 		
@@ -49,11 +43,11 @@ module DB
 	
 	# A mutable query builder.
 	class Query
-		# Create a new query builder attached to the specified session.
-		# @parameter session [Context::Session] the connected session which is used for escaping arguments.
-		def initialize(session, buffer = String.new)
-			@session = session
-			@connection = session.connection
+		# Create a new query builder attached to the specified context.
+		# @parameter context [Context::Generic] the context which is used for escaping arguments.
+		def initialize(context, buffer = String.new)
+			@context = context
+			@connection = context.connection
 			@buffer = +buffer
 		end
 		
@@ -61,7 +55,7 @@ module DB
 		# @parameter value [String] A raw SQL string, e.g. `WHERE x > 10`.
 		# @returns [Query] The mutable query itself.
 		def clause(value)
-			@buffer << ' ' unless @buffer.end_with?(' ')
+			@buffer << ' ' unless @buffer.end_with?(' ') || @buffer.empty?
 			
 			@buffer << value
 			
@@ -119,15 +113,16 @@ module DB
 			return self
 		end
 		
-		# Send the query to the remote server to be executed. See {Context::Session#send_query} for more details.
-		def send
-			@session.send_query(@buffer)
-		end
-		
 		# Send the query to the remote server to be executed. See {Context::Session#call} for more details.
 		# @returns [Enumerable] The resulting records.
-		def call
-			@session.call(@buffer)
+		def call(&block)
+			if block_given?
+				@context.call(@buffer, &block)
+			else
+				@context.call(@buffer) do |connection|
+					return connection.next_result
+				end
+			end
 		end
 		
 		def to_s

data/lib/db/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module DB
-	VERSION = "0.8.0"
+	VERSION = "0.10.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.3
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-04 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-io
@@ -89,6 +89,7 @@ files:
 - lib/db.rb
 - lib/db/adapters.rb
 - lib/db/client.rb
+- lib/db/context/generic.rb
 - lib/db/context/session.rb
 - lib/db/context/transaction.rb
 - lib/db/query.rb
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: A low level database access gem.