db-model 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4961d9ec72ec4c904a5d2e31edc7348a54f3566f943bbff050221c8f3a74c308
+  data.tar.gz: 0fd96962a1344ba0523bd1a1092c1c53f52217d457596d0d9099346aaa7136e0
+SHA512:
+  metadata.gz: fc5eeb9b36dc16a1fd698e9ffdc7eba85c9eb88a94a1cc1f7804c734a39677b663ce7f2544e78023b6dee5f95d104d76ca9cac1c954dda7017fab94dd4c4231a
+  data.tar.gz: d7a0b177c3956a6cb016094d2031220b1881bc7341f9440fa1aa88b7eb3e9edc6f953d28da556e5dd60e4fb061448e508a2c84e5c0c5a89266b7a7cffb6b338c

data/lib/db/model/cache.rb

@@ -0,0 +1,65 @@
+# 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/count'
+
+module DB
+	module Model
+		class Cache
+			def initialize
+				@relations = {}
+				@records = {}
+			end
+			
+			def empty?
+				@relations.empty?
+			end
+			
+			def size
+				@relations.size
+			end
+			
+			def fetch(key)
+				@relations.fetch(key) do
+					deduplicate(yield)
+				end
+			end
+			
+			def update(key, records)
+				@relations[key] = records
+			end
+			
+			def inspect
+				"\#<#{self.class} #{@relations.size} relations; #{@records.size} records>"
+			end
+			
+		protected
+			
+			def deduplicate(records)
+				records.map do |record|
+					@records[record] = record
+				end
+			end
+		end
+	end
+end

data/lib/db/model/countable.rb

@@ -0,0 +1,48 @@
+# 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/count'
+
+module DB
+	module Model
+		module Countable
+			def count(fields = Statement::Count::ALL)
+				Statement::Select.new(@model,
+					fields: fields,
+					where: self.predicate,
+				).to_sql(@context).call do |connection|
+					result = connection.next_result
+					
+					row = result.to_a.first
+					
+					# Return the count:
+					return row.first
+				end
+			end
+			
+			def empty?
+				self.count == 0
+			end
+		end
+	end
+end

data/lib/db/model/deletable.rb

@@ -0,0 +1,35 @@
+# 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/delete'
+
+module DB
+	module Model
+		module Deletable
+			def delete
+				Statement::Delete.new(@model,
+					where: self.predicate,
+				).call(@context)
+			end
+		end
+	end
+end

data/lib/db/model/record.rb

@@ -0,0 +1,267 @@
+# 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 'statement/select'
+require_relative 'statement/equal'
+require_relative 'statement/limit'
+
+require_relative 'statement/insert'
+require_relative 'statement/multiple'
+require_relative 'statement/fields'
+require_relative 'statement/tuple'
+
+require_relative 'statement/update'
+require_relative 'statement/assignment'
+
+require_relative 'scope'
+require_relative 'where'
+
+module DB
+	module Model
+		module Record
+			class SerializationError < RuntimeError
+			end
+			
+			module Base
+				def self.extended(klass)
+					klass.instance_variable_set(:@properties, {})
+					klass.instance_variable_set(:@relationships, {})
+					
+					klass.instance_variable_set(:@key_columns, [:id].freeze)
+					
+					default_type = klass.name.split('::').last.gsub(/(.)([A-Z])/,'\1_\2').downcase!.to_sym
+					klass.instance_variable_set(:@type, default_type)
+				end
+				
+				attr :type
+				attr :properties
+				attr :relationships
+				attr :key_columns
+				
+				def primary_key
+					@key_columns.map do |name|
+						DB::Identifier[@type, name]
+					end
+				end
+				
+				# Directly create one record.
+				def create(context, **attributes)
+					Statement::Insert.new(self,
+						Statement::Fields.new(attributes.keys),
+						Statement::Tuple.new(attributes.values)
+					).to_a(context).first
+				end
+				
+				# Directly insert one or more records.
+				def insert(context, keys, rows, **attributes)
+					if attributes.any?
+						fields = Statement::Fields.new(attributes.keys + keys)
+						values = attributes.values
+						tuples = rows.map{|row| Statement::Tuple.new(values + row)}
+					else
+						fields = Statement::Fields.new(keys)
+						tuples = rows.map{|row| Statement::Tuple.new(row)}
+					end
+					
+					return Statement::Insert.new(self, fields, Statement::Multiple.new(tuples)).to_a(context)
+				end
+				
+				# Find records which match the given primary key.
+				def find(context, *key)
+					Statement::Select.new(self,
+						where: find_predicate(*key),
+						limit: Statement::Limit::ONE
+					).to_a(context).first
+				end
+				
+				def find_predicate(*key)
+					Statement::Equal.new(self, self.primary_key, key)
+				end
+				
+				def where(context, *arguments, **options, &block)
+					Where.new(context, self, *arguments, **options, &block)
+				end
+				
+				def property(name, klass = nil)
+					if @properties.key?(name)
+						raise ArgumentError.new("Property #{name.inspect} already defined!")
+					end
+					
+					@properties[name] = klass
+					
+					if klass
+						self.define_method(name) do
+							if @changed&.key?(name)
+								return @changed[name]
+							elsif @attributes.key?(name)
+								value = @attributes[name]
+								klass.load(value)
+							else
+								nil
+							end
+						end
+					else
+						self.define_method(name) do
+							if @changed&.key?(name)
+								return @changed[name]
+							else
+								@attributes[name]
+							end
+						end
+					end
+					
+					self.define_method(:"#{name}=") do |value|
+						@changed ||= Hash.new
+						@changed[name] = value
+					end
+					
+					self.define_method(:"#{name}?") do
+						value = self.send(name)
+						
+						if !value
+							false
+						elsif value.respond_to?(:empty?)
+							!value.empty?
+						else
+							true
+						end
+					end
+				end
+			end
+			
+			def self.included(klass)
+				klass.extend(Base)
+			end
+			
+			def initialize(context, attributes, cache = nil)
+				@context = context
+				@attributes = attributes
+				@changed = changed
+				@cache = cache
+			end
+			
+			attr :context
+			attr :attributes
+			attr :changed
+			attr :cache
+			
+			def to_s
+				"\#<#{self.class.type} #{@attributes.inspect}>"
+			end
+			
+			def inspect
+				if @changed&.any?
+					"\#<#{self.class.type} #{@attributes.inspect} changed=#{@changed.inspect}>"
+				else
+					to_s
+				end
+			end
+			
+			def assign(changed)
+				@changed = changed
+				
+				return self
+			end
+			
+			def reload(context = @context)
+				if key = self.persisted?
+					self.class.find(context, *key)
+				end
+			end
+			
+			# A record which has a valid primary key is considered to be persisted.
+			def persisted?
+				self.class.key_columns.map do |field|
+					@attributes[field] or return false
+				end
+			end
+			
+			def new_record?
+				!persisted?
+			end
+			
+			def save(context: @context)
+				return unless attributes = self.flatten!
+				
+				if key = persisted?
+					statement = Statement::Update.new(self.class,
+						Statement::Assignment.new(attributes),
+						self.class.find_predicate(*key)
+					)
+				else
+					statement = Statement::Insert.new(self.class,
+						Statement::Fields.new(attributes.keys),
+						Statement::Tuple.new(attributes.values)
+					)
+				end
+				
+				statement.call(@context) do |attributes|
+					# Only insert will hit this code path:
+					@attributes.update(attributes)
+				end
+				
+				return self
+			end
+			
+			def scope(model, attributes)
+				Scope.new(@context, model, attributes, @cache)
+			end
+			
+			def eql?(other)
+				return false unless self.class.eql?(other.class)
+				return false unless key = self.persisted?
+				
+				return key.eql?(other.persisted?)
+			end
+			
+			def hash
+				if key = self.persisted?
+					key.hash
+				else
+					raise KeyError, "Record is not persisted!"
+				end
+			end
+			
+		protected
+			
+			# Moves values from `@changed` into `@attributes`.
+			def flatten!
+				return nil unless @changed&.any?
+				
+				properties = self.class.properties
+				changed = {}
+				
+				@changed.each do |key, value|
+					if klass = properties[key]
+						value = klass.dump(value)
+					end
+					
+					changed[key] = @attributes[key] = value
+				end
+				
+				@changed = nil
+				
+				return changed
+			end
+		end
+	end
+end

data/lib/db/model/relation.rb

@@ -0,0 +1,160 @@
+# 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 'countable'
+require_relative 'deletable'
+
+module DB
+	module Model
+		class Relation
+			def initialize(context, model, cache = nil)
+				@context = context
+				@model = model
+				@cache = cache
+				
+				@select = nil
+			end
+			
+			attr :context
+			attr :model
+			attr :cache
+			
+			include Countable, Deletable
+			
+			def create(**attributes)
+				self.new(**attributes).save
+			end
+			
+			def new(**attributes)
+				@model.new(@context, {}, @cache).assign(attributes)
+			end
+			
+			def insert(keys, rows, **attributes)
+				@model.insert(@context, keys, rows, **attributes)
+			end
+			
+			def find(*key)
+				if predicate = self.predicate
+					predicate = predicate & @model.find_predicate(*key)
+				else
+					predicate = @model.find_predicate(*key)
+				end
+				
+				return Statement::Select.new(@model,
+					where: predicate,
+					limit: Statement::Limit::ONE
+				).to_a(@context).first
+			end
+			
+			def where(*arguments, **options, &block)
+				where = @model.where(@context, *arguments, **options, &block)
+				
+				if predicate = self.predicate
+					where.predicate &= predicate
+				end
+				
+				return where
+			end
+			
+			def predicate
+				nil
+			end
+			
+			def preload(name)
+				@cache ||= Cache.new
+				
+				scopes = []
+				self.each do |record|
+					scopes << record.send(name)
+				end
+				
+				# Build a buffer of queries:
+				query = @context.query
+				first = true
+				
+				scopes.each do |scope|
+					query.clause(";") unless first
+					first = false
+					
+					scope.select.append_to(query)
+				end
+				
+				query.call do |connection|
+					scopes.each do |scope|
+						result = connection.next_result
+						scope.update_cache(result)
+					end
+				end
+				
+				return self
+			end
+			
+			def each(cache: @cache, &block)
+				if @cache
+					@cache.fetch(self.cache_key) do
+						self.select.to_a(@context, @cache)
+					end.each(&block)
+				else
+					self.select.each(@context, &block)
+				end
+			end
+			
+			def first(count = nil)
+				if count
+					self.select.first(@context, count, @cache)
+				else
+					self.select.first(@context, 1, @cache).first
+				end
+			end
+			
+			def to_a
+				records = []
+				
+				self.each do |record|
+					records << record
+				end
+				
+				return records
+			end
+			
+			def cache_key
+				[@model, self.predicate]
+			end
+			
+			def update_cache(result)
+				@cache.update(self.cache_key, self.select.apply(@context, result))
+			end
+			
+			def select
+				@select ||= Statement::Select.new(@model, where: self.predicate)
+			end
+			
+			def to_s
+				"\#<#{self.class} #{@model}>"
+			end
+			
+			def inspect
+				to_s
+			end
+		end
+	end
+end

data/lib/db/model/schema.rb

@@ -0,0 +1,46 @@
+# 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 'table'
+require_relative 'cache'
+
+module DB
+	module Model
+		module Schema
+			def initialize(context, cache: Cache.new)
+				@context = context
+				@cache = cache
+			end
+			
+			attr :context
+			attr :cache
+			
+			def table(model)
+				Table.new(@context, model, @cache)
+			end
+			
+			def inspect
+				"\#<#{self.class} #{@context.class} cache=#{@cache}>"
+			end
+		end
+	end
+end

data/lib/db/model/scope.rb

@@ -0,0 +1,57 @@
+# 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 'relation'
+
+module DB
+	module Model
+		class Scope < Relation
+			def initialize(context, model, attributes, cache = nil)
+				super(context, model, cache)
+				
+				@attributes = attributes
+			end
+			
+			attr :attributes
+			
+			def new(**attributes)
+				@model.new(@context, {}, @cache).assign(**@attributes.merge(attributes))
+			end
+			
+			def insert(keys, rows, **attributes)
+				@model.insert(@context, keys, rows, **@attributes.merge(attributes))
+			end
+			
+			def predicate
+				Statement::Equal.new(@model, @attributes.keys, @attributes.values)
+			end
+			
+			def cache_key
+				[@model, @attributes]
+			end
+			
+			def to_s
+				"\#<#{self.class} #{@model} #{@attributes}>"
+			end
+		end
+	end
+end