db-model 0.3.0

data/lib/db/model/statement/predicate.rb

@@ -0,0 +1,221 @@
+# 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 'literal'
+
+module DB
+	module Model
+		module Statement
+			module Predicate
+				class Empty
+					def append_to(statement)
+						statement.literal(true)
+					end
+					
+					def + other
+						other
+					end
+					
+					def eql?(other)
+						self.class.eql?(other.class)
+					end
+					
+					def hash
+						self.class.hash
+					end
+				end
+				
+				EMPTY = Empty.new
+				
+				class Between
+					def initialize(key, minimum, maximum)
+						@key = key
+						@minimum = minimum
+						@maximum = maximum
+					end
+					
+					attr :key
+					attr :minimum
+					attr :maximum
+					
+					def append_to(statement)
+						@key.append_to(statement)
+						statement.clause("BETWEEN")
+						@minimum.append_to(statement)
+						statement.clause("AND")
+						@maximum.append_to(statement)
+					end
+					
+					def eql?(other)
+						self.class.eql?(other.class) && self.key.eql?(other.key) && self.minimum.eql?(other.minimum) && self.maximum.eql?(other.maximum)
+					end
+					
+					def hash
+						[self.class, @key, @minimum, @maximum].hash
+					end
+				end
+				
+				class Binary
+					def initialize(key, operator, value)
+						@key = key
+						@operator = operator
+						@value = value
+					end
+					
+					attr :key
+					attr :operator
+					attr :value
+					
+					def append_to(statement)
+						@key.append_to(statement)
+						statement.clause(@operator)
+						@value.append_to(statement)
+					end
+					
+					def eql?(other)
+						self.class.eql?(other.class) && self.key.eql?(other.key) && self.operator.eql?(other.operator) && self.value.eql?(other.value)
+					end
+					
+					def hash
+						[self.class, @key, @operator, @value].hash
+					end
+				end
+				
+				class Null
+					def initialize(key)
+						@key = key
+					end
+					
+					attr :key
+					
+					def append_to(statement)
+						@key.append_to(statement)
+						statement.clause("IS NULL")
+					end
+					
+					def eql?(other)
+						self.class.eql?(other.class) && self.key.eql?(other.key)
+					end
+					
+					def hash
+						[self.class, @key].hash
+					end
+				end
+				
+				class Composite
+					def self.for(predicates)
+						if predicates.size == 0
+							return EMPTY
+						else
+							return self.new(predicates)
+						end
+					end
+					
+					def initialize(predicates, operator = "AND")
+						@predicates = predicates
+						@operator = operator
+					end
+					
+					attr :predicates
+					attr :operator
+					
+					def append_to(statement)
+						first = true
+						
+						statement.clause("(")
+						
+						@predicates.each_with_index do |predicate, index|
+							statement.clause(@operator) unless first
+							first = false
+							
+							predicate.append_to(statement)
+						end
+						
+						statement.clause(")")
+					end
+					
+					def + other
+						Composite.new([self, other])
+					end
+					
+					def & other
+						Composite.new([self, other], "AND")
+					end
+					
+					def | other
+						Composite.new([self, other], "OR")
+					end
+					
+					def eql?(other)
+						self.class.eql?(other.class) && self.predicates.eql?(other.predicates)
+					end
+					
+					def hash
+						[self.class, @predicates, @operator].hash
+					end
+				end
+				
+				def self.coerce(key, value)
+					case value
+					when Array
+						Binary.new(key, "IN", Tuple.new(value))
+					when Range
+						if value.min.nil?
+							if value.exclude_end?
+								Binary.new(key, "<", Literal.new(value.max))
+							else
+								Binary.new(key, "<=", Literal.new(value.max))
+							end
+						elsif value.max.nil?
+							if value.exclude_end?
+								Binary.new(key, ">", Literal.new(value.max))
+							else
+								Binary.new(key, ">=", Literal.new(value.max))
+							end
+						else
+							if value.exclude_end?
+								Composite.new([
+									Binary.new(key, ">", Literal.new(value.min)),
+									Binary.new(key, "<", Literal.new(value.max))
+								])
+							else
+								Between.new(key, Literal.new(value.min), Literal.new(value.max))
+							end
+						end
+					when nil
+						Null.new(key)
+					else
+						Binary.new(key, "=", Literal.new(value))
+					end
+				end
+				
+				def self.where(*arguments, **options, &block)
+					Composite.for(
+						options.map do |key, value|
+							coerce(Identifier.coerce(key), value)
+						end
+					)
+				end
+			end
+		end
+	end
+end

data/lib/db/model/statement/replace.rb

@@ -0,0 +1,62 @@
+# 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.
+
+module DB
+	module Model
+		module Statement
+			class Replace
+				def initialize(source, fields, values)
+					@source = source
+					@fields = fields
+					@values = values
+				end
+				
+				def to_sql(context)
+					statement = context.query("REPLACE INTO")
+					
+					statement.identifier(@source.type)
+					
+					statement.clause("(")
+					@fields.append_to(statement)
+					statement.clause(") VALUES")
+					
+					@values.append_to(statement)
+					
+					statement.clause("RETURNING *")
+					
+					return statement
+				end
+				
+				def to_a(context, klass)
+					to_sql(context).call do |connection|
+						result = connection.next_result
+						keys = result.field_names.map(&:to_sym)
+						
+						result.map do |row|
+							klass.new(context, keys.zip(row).to_h)
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/db/model/statement/select.rb

@@ -0,0 +1,99 @@
+# 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.
+
+module DB
+	module Model
+		module Statement
+			class Select
+				def initialize(source, fields: nil, where: nil, limit: nil)
+					@source = source
+					@fields = fields
+					@where = where
+					@limit = limit
+				end
+				
+				def append_to(statement, limit: @limit)
+					statement = statement.clause("SELECT")
+					
+					if @fields
+						@fields.append_to(statement)
+					else
+						statement.clause("*")
+					end
+					
+					statement.clause("FROM")
+					statement.identifier(@source.type)
+					
+					if @where
+						statement.clause "WHERE"
+						@where.append_to(statement)
+					end
+					
+					limit&.append_to(statement)
+					
+					return statement
+				end
+				
+				def to_sql(context)
+					self.append_to(context)
+				end
+				
+				def to_a(context, cache = nil)
+					to_sql(context).call do |connection|
+						result = connection.next_result
+						
+						return apply(context, result, cache)
+					end
+				end
+				
+				def apply(context, result, cache = nil)
+					keys = result.field_names.map(&:to_sym)
+					
+					result.map do |row|
+						@source.new(context, keys.zip(row).to_h, cache)
+					end
+				end
+				
+				def each(context, cache = nil)
+					to_sql(context).call do |connection|
+						result = connection.next_result
+						keys = result.field_names.map(&:to_sym)
+						
+						result.each do |row|
+							yield @source.new(context, keys.zip(row).to_h, cache)
+						end
+					end
+				end
+				
+				def first(context, count, cache = nil)
+					limit = @limit&.first(count) || Limit.new(count)
+					
+					append_to(context, limit: limit).call do |connection|
+						result = connection.next_result
+						
+						return apply(context, result, cache)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/db/model/statement/truncate.rb

@@ -0,0 +1,45 @@
+# 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.
+
+module DB
+	module Model
+		module Statement
+			class Truncate
+				def initialize(source)
+					@source = source
+				end
+				
+				def to_sql(context)
+					statement = context.clause("TRUNCATE TABLE")
+					
+					statement.identifier(@source.type)
+					
+					return statement
+				end
+				
+				def call(context)
+					to_sql(context).call
+				end
+			end
+		end
+	end
+end

data/lib/db/model/statement/tuple.rb

@@ -0,0 +1,58 @@
+# 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.
+
+module DB
+	module Model
+		module Statement
+			class Tuple
+				def initialize(values)
+					@values = values
+				end
+				
+				attr :values
+				
+				def append_to(statement)
+					first = true
+					
+					statement.clause("(")
+					@values.each do |value|
+						statement.clause(",") unless first
+						first = false
+						
+						statement.literal(value)
+					end
+					statement.clause(")")
+					
+					return statement
+				end
+				
+				def eql?(other)
+					self.class.eql?(other.class) && self.values.eql?(other.values)
+				end
+				
+				def hash
+					[self.class, @values].hash
+				end
+			end
+		end
+	end
+end

data/lib/db/model/statement/update.rb

@@ -0,0 +1,54 @@
+# 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.
+
+module DB
+	module Model
+		module Statement
+			class Update
+				def initialize(source, assignment, where)
+					@source = source
+					@assignment = assignment
+					@where = where
+				end
+				
+				def to_sql(context)
+					statement = context.query("UPDATE")
+					
+					statement.identifier(@source.type)
+					
+					@assignment.append_to(statement)
+					
+					if @where
+						statement.clause "WHERE"
+						@where.append_to(statement)
+					end
+					
+					return statement
+				end
+				
+				def call(context)
+					to_sql(context).call
+				end
+			end
+		end
+	end
+end

data/lib/db/model/table.rb

@@ -0,0 +1,38 @@
+# 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 'relation'
+require_relative 'statement/truncate'
+
+module DB
+	module Model
+		class Table < Relation
+			def cache_key
+				[@model]
+			end
+			
+			def truncate
+				Statement::Truncate.new(@model).call(@context)
+			end
+		end
+	end
+end

data/lib/db/model/version.rb

@@ -0,0 +1,27 @@
+# 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
+	module Model
+		VERSION = "0.3.0"
+	end
+end

data/lib/db/model/where.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# Copyright, 2012, 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 'statement/select'
+require_relative 'statement/predicate'
+
+require_relative 'countable'
+
+module DB
+	module Model
+		class Where
+			def initialize(context, model, *arguments, **options, &block)
+				@context = context
+				@model = model
+				@predicate = Statement::Predicate.where(*arguments, **options, &block)
+				
+				@select = nil
+			end
+			
+			attr_accessor :predicate
+			
+			include Countable, Deletable
+			
+			def or(*arguments, **options, &block)
+				@predicate |= Statement::Predicate.where(*arguments, **options, &block)
+				
+				return self
+			end
+			
+			def and(*arguments, **options, &block)
+				@predicate &= Statement::Predicate.where(*arguments, **options, &block)
+				
+				return self
+			end
+			
+			def find(*key)
+				return Statement::Select.new(@model,
+					where: @predicate & @model.find_predicate(*key),
+					limit: Statement::Limit::ONE
+				).to_a(context)
+			end
+			
+			def where(*arguments, **options, &block)
+				self.class.new(@context, model,
+					@predicate + Statement::Predicate.where(*arguments, **options, &block)
+				)
+			end
+			
+			def select
+				@select ||= Statement::Select.new(@model,
+					where: @predicate
+				)
+			end
+			
+			def each(&block)
+				self.select.each(@context, &block)
+			end
+			
+			def first(count = nil)
+				if count
+					self.select.first(@context, count)
+				else
+					self.select.first(@context, 1).first
+				end
+			end
+			
+			def to_s
+				"\#<#{self.class} #{@model} #{@predicate}>"
+			end
+			
+			alias inspect to_s
+		end
+	end
+end