db 0.5.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1149f3daa25b0832441ed9c08eeba087be727167ff5ee12b33e2d96a2ae54138
-  data.tar.gz: efc580a879bc9d91c46bc631a76b5761f276ce24e531daf20bc797e75ea06273
+  metadata.gz: f128a427ea4ac05f7182d550d9c9548fb87d1f50d81602a3a9c6e29832f7bb95
+  data.tar.gz: 30fa1ea2be7e82e9731f832cf3147b8b794832922cb2f26a9e9faba66a9a00d5
 SHA512:
-  metadata.gz: 104d7bce64424a3666c1a699e8b06c655a37dc44f5b025530a422188d386c3b84ad00ccc314ba8d0a4f5b9c931375c21c0799e6d0868064d012220d5fc26e6cd
-  data.tar.gz: 856321b31c8894f5fe914100b5892cc160c812f56b6bf0cc8ec4f7bc159d9535195bf5c8d406e0ca1116b6fc4d73ecc2527b03d630bf336c6d768060c11918c2
+  metadata.gz: 27648baebb40112a422a69d5c464bfd5d984ad86ae495368c5a59fb8900f390f2a97e8e7b969bdfbdae6ab790ae7186436fc48101fc1672b13511cf568cdbd04
+  data.tar.gz: 87c2e6137adb9fdfbf33cc42d97ec3d19a5543b72bad9022c8060851a99c6f0a00a0794075bdc7b9e08bd4d84f8e9beef65918f2ed7bbe78ad163d5ed3387a76

data/lib/db/client.rb

@@ -24,7 +24,8 @@ require 'async/io'
 require 'async/io/stream'
 require 'async/pool/controller'
 
-require_relative 'context/query'
+require_relative 'context/generic'
+require_relative 'context/session'
 require_relative 'context/transaction'
 
 module DB
@@ -47,24 +48,33 @@ 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::Query]
-		# @returns [Context::Query] A connected session if no block is given.
-		def call(statement = nil, **options)
-			query = Context::Query.new(@pool, **options)
-			
-			if statement
-				query.send_query(statement)
-			end
+		# 	@parameter session [Context::Session]
+		# @returns [Context::Session] A connected session if no block is given.
+		def session(**options)
+			session = Context::Session.new(@pool, **options)
 			
-			return query unless block_given?
+			return session unless block_given?
 			
 			begin
-				yield query
+				yield session
 			ensure
-				query.close
+				session.close
 			end
 		end
 		
@@ -73,12 +83,10 @@ 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?
 			
@@ -86,8 +94,8 @@ module DB
 				yield transaction
 				
 				transaction.commit
-			ensure
-				transaction.abort if $!
+			rescue
+				transaction.abort
 			end
 		end
 		

data/lib/db/context/{query.rb → generic.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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
@@ -20,65 +20,55 @@
 # 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 Query
+		class Generic
 			# Iniitalize the query context attached to the given connection pool.
 			def initialize(pool, **options)
 				@pool = pool
-				@connection = pool.acquire
+				@connection = nil
+			end
+			
+			def connection?
+				@connection != nil
 			end
 			
-			# The underlying connection.
-			attr :connection
+			# 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
-					self.flush
-					
 					@pool.release(@connection)
-					
 					@connection = nil
 				end
 			end
 			
-			# Send a query to the server.
-			# @parameter statement [String] The SQL query to send.
-			def send_query(statement, **options)
-				@connection.send_query(statement, **options)
+			def query(fragment = String.new, **parameters)
+				if parameters.empty?
+					Query.new(self, fragment)
+				else
+					Query.new(self).interpolate(fragment, **parameters)
+				end
 			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
+			def clause(fragment = String.new)
+				Query.new(self, fragment)
 			end
 			
-			# Send a query to the server and read the next result.
-			# @returns [Enumerable] The resulting records.
+			# Send a query to the server.
+			# @parameter statement [String] The SQL query to send.
 			def call(statement, **options)
-				@connection.send_query(statement, **options)
-				
-				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?
+			ensure
+				self.close
 			end
 		end
 	end

data/lib/db/context/session.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, 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 Session < Generic
+			# Send a query to the server.
+			# @parameter statement [String] The SQL query to send.
+			def call(statement, **options)
+				connection = self.connection
+				
+				connection.send_query(statement, **options)
+				
+				yield connection if block_given?
+			end
+		end
+	end
+end

data/lib/db/context/transaction.rb

@@ -20,11 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'query'
+require_relative 'session'
 
 module DB
 	module Context
-		class Transaction < Query
+		class Transaction < Session
 			# Commit the transaction and return the connection to the connection pool.
 			def commit
 				self.call("COMMIT")

data/lib/db/query.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, 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.
+
+module DB
+	# Represents one or more identifiers for databases, tables or columns.
+	class Identifier < Array
+		def self.coerce(name_or_identifier)
+			case name_or_identifier
+			when Identifier
+				name_or_identifier
+			when Array
+				self.new(name_or_identifier)
+			when Symbol
+				self[name_or_identifier]
+			else
+				self[name_or_identifier.to_sym]
+			end
+		end
+		
+		def append_to(query)
+			query.identifier(self)
+		end
+	end
+	
+	# A mutable query builder.
+	class Query
+		# 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
+		
+		# Append a raw textual clause to the query buffer.
+		# @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.empty?
+			
+			@buffer << value
+			
+			return self
+		end
+		
+		# Append a literal value to the query buffer.
+		# Escapes the field according to the requirements of the underlying connection.
+		# @parameter value [Object] Any kind of object, passed to the underlying database connection for conversion to a string representation.
+		# @returns [Query] The mutable query itself.
+		def literal(value)
+			@buffer << ' ' unless @buffer.end_with?(' ')
+			
+			@connection.append_literal(value, @buffer)
+			
+			return self
+		end
+		
+		# Append an identifier value to the query buffer.
+		# Escapes the field according to the requirements of the underlying connection.
+		# @parameter value [String | Symbol | DB::Identifier] Passed to the underlying database connection for conversion to a string representation.
+		# @returns [Query] The mutable query itself.
+		def identifier(value)
+			@buffer << ' ' unless @buffer.end_with?(' ')
+			
+			@connection.append_identifier(value, @buffer)
+			
+			return self
+		end
+		
+		# Interpolate a query fragment with the specified parameters.
+		# The parameters are escaped before being appended.
+		#
+		# @parameter fragment [String] A fragment of SQL including placeholders, e.g. `WHERE x > %{column}`.
+		# @parameter parameters [Hash] The substitution parameters.
+		# @returns [Query] The mutable query itself.
+		def interpolate(fragment, **parameters)
+			parameters.transform_values! do |value|
+				case value
+				when Symbol, Identifier
+					@connection.append_identifier(value)
+				else
+					@connection.append_literal(value)
+				end
+			end
+			
+			@buffer << sprintf(fragment, parameters)
+			
+			return self
+		end
+		
+		def key_column(*arguments, **options)
+			@buffer << @connection.key_column(*arguments, **options)
+			
+			return self
+		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(&block)
+			@context.call(@buffer, &block)
+		end
+		
+		def to_s
+			@buffer
+		end
+		
+		def inspect
+			"\#<#{self.class} #{@buffer.inspect}>"
+		end
+	end
+end

data/lib/db/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-io
@@ -89,8 +89,10 @@ files:
 - lib/db.rb
 - lib/db/adapters.rb
 - lib/db/client.rb
-- lib/db/context/query.rb
+- lib/db/context/generic.rb
+- lib/db/context/session.rb
 - lib/db/context/transaction.rb
+- lib/db/query.rb
 - lib/db/version.rb
 homepage: https://github.com/socketry/db
 licenses:
@@ -111,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A low level database access gem.