sack 1.1.3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36631ab9960ab0352fc67299eb542d4c45ff7bea
-  data.tar.gz: 68295a9026aec98c51b35a6574608568510f22de
+  metadata.gz: 5c9e2e71505eb323e90a5113162fb887269f089d
+  data.tar.gz: fc1de55fd35990aba81d923f39cd05e22003c477
 SHA512:
-  metadata.gz: eb2c612f125c841885c785f7ade20715d5afea212c3346a6b98c40499e758d2e2d145051ca57afc21d64f07eb5a1ab1ed2a3bec2a584cca5e941ad0609098d9a
-  data.tar.gz: 3580ba64a327c27972d694da5a7e7962967303a0507638b9286d689dc3fe3d768c3e2778d70df01bf0567d659fb20f86cab046b62c952f9c3532aaf9b443f6e1
+  metadata.gz: 3bc090d5caaa1be73bbc06d7e03b0cb735fe299738b235f110da87835544bd8ee175444ffa1806640871b9474cb1c014190a1cdc3c0b3cd9a2b4b4d912a841fe
+  data.tar.gz: d0f2664d7ff967d4ecb6508c3cf17438c4ae1e0411881f74c601ab924bbeaedfd230acd317894904561d8ba693eb3fef9f5f49ade232c2210984b4f1eff23cfb

data/README.md

@@ -60,6 +60,9 @@ users = db.fetch_all :user
 # Find (fetch by ID - first result)
 u = db.find :user, u[:id]
 
+# Find by Field
+u = db.find_by :user, :name, 'foobar'
+
 # Count
 user_count = db.count :user
 
@@ -259,16 +262,20 @@ The name of the association can be anything. The target model NEEDS to be specif
 
 Unless explicitly specified, Sack will use the name of the current model to determine the foreign key (the field within the target model which holds the ID of the current model).
 
+Delete actions can be defined on 'has_many' relationships:
+* detach (nullifies the foreign key)
+* delete (removes the related entities)
+
 ```ruby
 module Foo
 	include Sack::Database::Model
 	field id: [:int, :pk, :ai]
 	
 	# Foreign Key in Bar is 'foo'
-	has_many bars: :bar
+	has_many bars: :bar, on_delete: :detach
 	
 	# Foreign Key in Bork is 'parent'
-	has_many borks: :bork, fk: :parent
+	has_many borks: :bork, fk: :parent, on_delete: :delete
 end
 
 module Bar
@@ -297,7 +304,7 @@ Upon initialization, Sack verifies the database against the schema defined by yo
 
 New tables will be created, as well as new fields (columns) in already-existing tables.
 
-*HOWEVER* it must be noted that things only get +added+. Tables and fields are NEVER removed. Existing fields are NEVER modified.
+*HOWEVER* it must be noted that things only get added. Tables and fields are NEVER removed. Existing fields are NEVER modified.
 This keeps the concept of migration VERY simple.
 
 ## License

data/lib/sack/database.rb

@@ -21,13 +21,16 @@ module Sack
 			:create_table,
 			:count,
 			:find,
+			:find_by,
 			:fetch,
 			:fetch_by,
 			:fetch_all,
 			:create,
 			:update,
+			:update_by,
 			:save,
-			:delete
+			:delete,
+		    :delete_by
 		]
 
 		# Construct:

data/lib/sack/database/data.rb

@@ -60,6 +60,12 @@ module Sack
 				fetch(table, id).try :first
 			end
 
+			# Find By Field:
+			# Fetches the first matching row from a given _table_ where _field_ matches _val_.
+			def find_by table, field, val
+				fetch_by(table, field, val).try :first
+			end
+
 			# Fetch:
 			# Fetches rows from a given _table_ by _id_.
 			# @param [Symbol] table Table name
@@ -104,6 +110,16 @@ module Sack
 				@db.execute Statement.prep("update #{Sanitizer.table @schema, table} set #{Generator.update_marks @schema, table, fields} where id = ?;", [Generator.values(fields.values), id].flatten)
 			end
 
+			# Update By Field:
+			# Updates _fields_ in rows where _field_ matches _val_.
+			# @param [Symbol] table Table name
+			# @param [Symbol] field Field name
+			# @param [Object] val Field value
+			# @param [Hash] fields Fields to be updated
+			def update_by table, field, val, fields
+				@db.execute Statement.prep("update #{Sanitizer.table @schema, table} set #{Generator.update_marks @schema, table, fields} where #{Sanitizer.field @schema, table, field} = ?;", [Generator.values(fields.values), val].flatten)
+			end
+
 			# Save:
 			# Creates or updates _fields_ in a given _table_, depending on the presence of an _id_.
 			# @param [Symbol] table Table name
@@ -117,6 +133,15 @@ module Sack
 			end
 
 			# Destroy:
+			# Removes rows from a given _table_ where _field_ matches _val_.
+			# @param [Symbol] table Table name
+			# @param [Symbol] field Field name
+			# @param [Object] val Field value
+			def delete_by table, field, val
+				@db.execute Statement.prep("delete from #{Sanitizer.table @schema, table} where #{Sanitizer.field @schema, table, field} = ?;", [val])
+			end
+
+			# Destroy By Field:
 			# Removes rows identified by _id_ from a given _table_.
 			# @param [Symbol] table Table name
 			# @param [Object] id ID of rows to be removed

data/lib/sack/database/generator.rb

@@ -39,7 +39,7 @@ module Sack
 			# @param [Hash] field_hash Hash containing field names as keys
 			# @return [String] A comma-separated list of field value markers ('field = ?')
 			def self.update_marks schema, table, field_hash
-				field_hash.keys.collect { |k| "#{Sanitizer.field schema, table, k} = ?" }.join ', '
+				field_hash.collect { |k, v| "#{Sanitizer.field schema, table, k} = #{v ? '?' : 'NULL'}" }.join ', '
 			end
 
 			# Values:
@@ -47,7 +47,7 @@ module Sack
 			# @param [Array] vals Array of value objects
 			# @return [Array] A copy of _vals_ where every symbol has been replaced by its string representation
 			def self.values vals
-				vals.collect { |v| v.is_a?(Symbol) ? v.to_s : v }
+				vals.collect { |v| v.nil? ? nil : (v.is_a?(Symbol) ? v.to_s : v) }.reject { |e| e.nil? }
 			end
 		end
 	end

data/lib/sack/database/model/data.rb

@@ -52,6 +52,54 @@ module Sack
 						raise Validation::ValidationException.new "Invalid Entity [#{data}] for Model #{@model}", errors unless is_valid? db, data, errors
 					end
 
+					# Check Delete
+					if name == :delete
+
+						# Get ID
+						id = args.first
+
+						# Run through Relations
+						relationships.each do |_rname, relationship|
+
+							# Acquire Target Model
+							tmodel = @model_root.const_get relationship[:target].to_s.camelcase
+
+							# Switch on delete action
+							case relationship[:options][:on_delete]
+								when :detach
+									tmodel.update_by db, relationship[:fk], id, relationship[:fk] => nil
+								when :delete
+									tmodel.delete_by db, relationship[:fk], id
+								else
+									# NoOp
+							end
+						end
+					end
+
+					# Check Delete By
+					if name == :delete_by
+
+						# Fetch Set
+						set = fetch_by db, *args
+
+						# Run through Relations
+						relationships.each do |_rname, relationship|
+
+							# Acquire Target Model
+							tmodel = @model_root.const_get relationship[:target].to_s.camelcase
+
+							# Switch on delete action
+							case relationship[:options][:on_delete]
+								when :detach
+									set.each { |e| tmodel.update_by db, relationship[:fk], e[:id], relationship[:fk] => nil }
+								when :delete
+									set.each { |e| tmodel.delete_by db, relationship[:fk], e[:id] }
+								else
+									# NoOp
+							end
+						end
+					end
+
 					# Forward to Database
 					result = db.send name, table_name, *args
 

data/lib/sack/database/model/relationships.rb

@@ -28,6 +28,12 @@ module Sack
 				# Class Methods:
 				# Collection of methods to be injected into anything that includes this module.
 				module ClassMethods
+
+					# Relationships:
+					# Gets the relationships for the Model.
+					def relationships
+						@relationships ||= {}
+					end
 				end
 			end
 		end

data/lib/sack/database/model/relationships/has_many.rb

@@ -22,7 +22,7 @@ module Sack
 					def has_many options
 
 						# Internalise Options (so we can mess it up)
-						options = options.clone
+						options = options.dclone
 
 						# Pull Relationship Name & Target Model
 						name, target_model_name = options.first
@@ -31,6 +31,9 @@ module Sack
 						# Determine Foreign Key (which field in the remote model holds our ID)
 						foreign_key = options[:fk] || table_name
 
+						# Register Relationship
+						relationships[name] = { target: target_model_name, fk: foreign_key, options: options.dclone }
+
 						# Construct Proxy Method Module
 						proxy = Module.new do
 

data/lib/sack/version.rb

@@ -5,5 +5,5 @@
 module Sack
 
 	# Version
-	VERSION = '1.1.3'
+	VERSION = '1.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sack
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.1
 platform: ruby
 authors:
 - Eresse