db 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00818022e4f4c8f40dae41f5f7850b89021cbcb8165f2a1e4637d07520a2c748'
-  data.tar.gz: 5d4ce254968d4f5187469537f2c1553970ba32e9125bea3a43de40ceb8d3bc40
+  metadata.gz: 190f7bf46c9e6f9e7af5b291eb71d07db32a6db3ac8997bc73dd50a058327744
+  data.tar.gz: fac1ca594b8f900b4ff7ac6e68cca1930c24fbc199a5187176f8d5e30e9006e7
 SHA512:
-  metadata.gz: cb6f3c928363fbc5c9a12ebf6bc902636e93202ee3308edf28d4370f40c2c69c5b57d9c64f873e66642bba3afa025bcd1934366011a52040c9f882b931fafc40
-  data.tar.gz: 0d0b154d9817cbc191c9a16203e5088538fe37375af00e060be6ae4c29379c0e03d61933420b15a36ab4efcbe003e1c279b38f0242b25b6afe156a3e10103980
+  metadata.gz: 1d0e7f56d1ea4f323e3c7d1525d3f4f2ef35cc8c9509b3d4f181ac3e992cd9c3ae954c696acc0b898ca1c196fd5638f46d0dac5ac36bdc99d9f989e081f24761
+  data.tar.gz: a5bca6583eeff6c0b1eb4debb7b9b8ff3d3011de914394742905bfad795e9f02ed6f65d452a36a9953db13016df67fffc546430df1f8269c60763fb7bfcfe0dc

data/lib/db/client.rb

@@ -3,11 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2020-2024, by Samuel Williams.
 
-require 'async/pool/controller'
+require "async/pool/controller"
 
-require_relative 'context/transient'
-require_relative 'context/session'
-require_relative 'context/transaction'
+require_relative "context/session"
+require_relative "context/transaction"
 
 module DB
 	# Binds a connection pool to the specified adapter.
@@ -29,19 +28,6 @@ module DB
 			@pool.close
 		end
 		
-		# Acquire a generic context which will acquire a connection on demand.
-		def context(**options)
-			context = Context::Transient.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.
@@ -53,12 +39,16 @@ module DB
 			return session unless block_given?
 			
 			begin
+				session.connect!
+				
 				yield session
 			ensure
 				session.close
 			end
 		end
 		
+		alias context session
+		
 		# Acquires a connection and starts a transaction.
 		# @parameters statement [String | Nil] An optional statement to send. Defaults to `"BEGIN"`.
 		# @yields {|session| ...} A connected session if a block is given. Implicitly commits, or aborts the connnection if an exception is raised.
@@ -67,7 +57,7 @@ module DB
 		def transaction(**options)
 			transaction = Context::Transaction.new(@pool, **options)
 			
-			transaction.call("BEGIN")
+			transaction.begin
 			
 			return transaction unless block_given?
 			

data/lib/db/context/session.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2020-2024, by Samuel Williams.
 
-require_relative '../query'
-require_relative '../records'
+require_relative "../query"
+require_relative "../records"
 
 module DB
 	module Context
@@ -16,12 +16,11 @@ module DB
 				@connection = nil
 			end
 			
-			def connection?
-				@connection != nil
-			end
+			attr :pool
+			attr :connection
 			
-			# Lazy initialize underlying connection.
-			def connection
+			# Pin a connection to the current session.
+			def connect!
 				@connection ||= @pool.acquire
 			end
 			
@@ -37,29 +36,47 @@ module DB
 				@connection.nil?
 			end
 			
-			def query(fragment = String.new, **parameters)
-				if parameters.empty?
-					Query.new(self, fragment)
+			def with_connection(&block)
+				if @connection
+					yield @connection
 				else
-					Query.new(self).interpolate(fragment, **parameters)
+					@pool.acquire do |connection|
+						@connection = connection
+						
+						yield connection
+					ensure
+						@connection = nil
+					end
 				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 = self.connection
-				
-				connection.send_query(statement, **options)
-				
-				if block_given?
-					yield connection
-				elsif result = connection.next_result
-					return Records.wrap(result)
+				self.with_connection do |connection|
+					connection.send_query(statement, **options)
+					
+					if block_given?
+						yield connection
+					elsif result = connection.next_result
+						return Records.wrap(result)
+					end
+				end
+			end
+			
+			def query(fragment = String.new, **parameters)
+				with_connection do
+					if parameters.empty?
+						Query.new(self, fragment)
+					else
+						Query.new(self).interpolate(fragment, **parameters)
+					end
+				end
+			end
+			
+			def clause(fragment = String.new)
+				with_connection do
+					Query.new(self, fragment)
 				end
 			end
 		end

data/lib/db/context/transaction.rb

@@ -3,11 +3,17 @@
 # Released under the MIT License.
 # Copyright, 2020-2024, by Samuel Williams.
 
-require_relative 'session'
+require_relative "session"
 
 module DB
 	module Context
 		class Transaction < Session
+			# Begin a transaction.
+			def begin
+				self.connect!
+				self.call("BEGIN")
+			end
+			
 			# Commit the transaction and return the connection to the connection pool.
 			def commit
 				self.call("COMMIT")

data/lib/db/query.rb

@@ -38,7 +38,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.empty?
+			@buffer << " " unless @buffer.end_with?(" ") || @buffer.empty?
 			
 			@buffer << value
 			
@@ -50,7 +50,7 @@ module DB
 		# @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?(' ')
+			@buffer << " " unless @buffer.end_with?(" ")
 			
 			@connection.append_literal(value, @buffer)
 			
@@ -62,7 +62,7 @@ module DB
 		# @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?(' ')
+			@buffer << " " unless @buffer.end_with?(" ")
 			
 			@connection.append_identifier(value, @buffer)
 			

data/lib/db/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2020-2024, by Samuel Williams.
 
 module DB
-	VERSION = "0.11.0"
+	VERSION = "0.12.0"
 end

data/lib/db.rb

@@ -3,6 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2020-2024, by Samuel Williams.
 
-require_relative 'db/version'
-require_relative 'db/adapters'
-require_relative 'db/client'
+require_relative "db/version"
+require_relative "db/adapters"
+require_relative "db/client"

data/readme.md

@@ -21,6 +21,14 @@ Please see the [project documentation](https://socketry.github.io/db/) for more
 
   - [Data Types](https://socketry.github.io/db/guides/datatypes/index) - This guide explains about SQL data types, and how they are used by the DB gem.
 
+## See Also
+
+  - [db-postgres](https://github.com/socketry/db-postgres) - Postgres adapter for the DB gem.
+  - [db-mariadb](https://github.com/socketry/db-mariadb) - MariaDB/MySQL adapter for the DB gem.
+  - [db-model](https://github.com/socketry/db-model) - A simple object relational mapper (ORM) for the DB gem.
+  - [db-migrate](https://github.com/socketry/db-migrate) - Database migration tooling for the DB gem.
+  - [db-active\_record](https://github.com/socketry/db-active_record) - An ActiveRecord adapter for the DB gem.
+
 ## Contributing
 
 We welcome contributions to this project.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-07-27 00:00:00.000000000 Z
+date: 2024-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -64,7 +64,6 @@ files:
 - lib/db/client.rb
 - lib/db/context/session.rb
 - lib/db/context/transaction.rb
-- lib/db/context/transient.rb
 - lib/db/query.rb
 - lib/db/records.rb
 - lib/db/version.rb

data/lib/db/context/transient.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
-
-require_relative 'session'
-
-module DB
-	module Context
-		# A connected context for sending queries and reading results.
-		class Transient < Session
-			def call(statement, **options, &block)
-				super
-			ensure
-				self.close
-			end
-		end
-	end
-end