audrey 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61cf118da49fbae7bf7dbc82dbf03f1460fe26d9925b135374e97a930039d198
-  data.tar.gz: ffc33814130bfcd6b24f70d3d4aebd5c71aff75922fa1cf9fb090789948d6fc9
+  metadata.gz: 0b9337b0db28e20ad953e7a75d36d9c10a4ed9e5a711dda30fd56a525e91b5ac
+  data.tar.gz: 704de739585df7193c7274f30b2f595e690d2077596160b55996e52e59640310
 SHA512:
-  metadata.gz: b8e4a31b17b175e5c038ba1063bddafca7c9e68e59655a764fade27d6459b43232336fc263d32040e7b8e8f75f7c58066af6a433711b3a020efdffe111f9963f
-  data.tar.gz: 8f015943ce4204efc60ba516bc6e259044d2be8b6b10d73c5873e042eaaecf1165425f5871afa2d251ea71e1deb3939528b9366f99e24ce11b0ec744a30e76a6
+  metadata.gz: 7b0bcc424857753a344a9b0f80df732a39b970dd798a3ddf99ec9366821923ad1c8121c8aac20649addc0b6777aa90a6100b08e438a05a59d2c3f847e3ea2453
+  data.tar.gz: fb6b761b19edcddea9980f3e3e4a6e40ef7532c2e0f43ade1e403ba1e9cae982dce685a774d825cce38d7e752b08249b3730f2b97fd595270cf30bca9a868caa

data/lib/audrey/engine/sqlite3/init.rb

@@ -0,0 +1,573 @@
+require 'sqlite3'
+
+#===============================================================================
+# Audrey::Engine::SQLite3::Init
+#
+module Audrey::Engine::SQLite3::Init
+	#---------------------------------------------------------------------------
+	# build
+	#
+	def self.build(p_dbh)
+		# create database file
+		# @dbh = SQLite3::Database.new(engine.path)
+		@dbh = p_dbh
+		
+		# go into transaction
+		@dbh.transaction
+		
+		# temp tables
+		# Audrey::Engine::SQLite3.session_tables @dbh
+		
+		# create and populate tables
+		journal()
+		settings()
+		partitions()
+		objects()
+		relationships()
+		views()
+		sessions()
+		
+		# commit
+		@dbh.commit
+	end
+	#
+	# build
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# journal
+	#
+	def self.journal
+		# $tm.hrm
+		
+		# build
+		@dbh.execute_batch <<-SQL
+		-- create table
+		create table journal (
+			pk integer primary key autoincrement,
+			ts datetime default current_timestamp,
+			tbl varchar(15)  not null,
+			fpk varchar(36)  not null,
+			action varchar(1) not null,
+			dsc json
+		);
+		
+		-- cannot update journal
+		create trigger journal_bu
+			before update on journal
+		begin
+			select raise(abort, 'cannot-update-journal-record');
+		end;
+		
+		-- cannot delete journal
+		create trigger journal_bd
+			before delete on journal
+		begin
+			select raise(abort, 'cannot-delete-journal-record');
+		end;
+		SQL
+	end
+	#
+	# journal
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# settings
+	#
+	def self.settings
+		# $tm.hrm
+		
+		# build
+		@dbh.execute_batch <<-SQL
+		-- create table
+		create table settings (
+			pk varchar(5) primary key,
+			value varchar(64) not null
+		);
+		
+		-- cannot update pk
+		create trigger settings_bu_pk
+			before update of pk on settings
+		begin
+			select raise(abort, 'cannot-update-setting-pk');
+		end;
+		
+		-- add setting for journaling
+		insert into settings(pk, value) values('journal', 1);
+		
+		-- create version setting
+		insert into settings(pk, value) values('version', '0.1');
+		
+		-- end sql
+		SQL
+	end
+	#
+	# settings
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# partitions
+	#
+	def self.partitions
+		# $tm.hrm
+		
+		# build
+		@dbh.execute_batch <<-SQL
+			-- create table
+			create table partitions (
+				pk varchar(1) primary key,
+				name varchar(30) unique not null
+			);
+			
+			-- cannot update pk
+			create trigger partitions_bu_pk
+				before update of pk on partitions
+			begin
+				select raise(abort, 'cannot-update-partition-pk');
+			end;
+			
+			-- create partitions
+			insert into partitions(pk, name) values('m', 'main');
+			insert into partitions(pk, name) values('r', 'roles');
+			insert into partitions(pk, name) values('d', 'design');
+			
+			-- cannot insert partitions
+			create trigger partitions_bi
+				before insert on partitions
+			begin
+				select raise(abort, 'cannot-insert-new-partition');
+			end;
+			
+			-- cannot update
+			create trigger partitions_bu
+				before update on partitions
+			begin
+				select raise(abort, 'cannot-update-partition');
+			end;
+			
+			-- cannot delete partitions
+			create trigger partitions_bd
+				before delete on partitions
+			begin
+				select raise(abort, 'cannot-delete-partition');
+			end;
+		SQL
+	end
+	#
+	# partitions
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# objects
+	#
+	def self.objects
+		# build
+		@dbh.execute_batch <<-SQL
+		-- fclasses table
+		create table fclasses(
+			pk integer primary key autoincrement,
+			name varchar(255) unique not null,
+			check (length(name)>0)
+		);
+		
+		-- cannot update fclasses
+		create trigger fclasses_bu
+		before update on fclasses
+		begin
+			select raise(abort, 'cannot-update-fclasses');
+		end;
+		
+		-- base_objects table
+		create table base_objects (
+			pk varchar(36) primary key,
+			partition varchar(1) not null references partitions(pk),
+			root boolean,
+			bclass_pk integer not null references fclasses(pk) on delete restrict,
+			fclass_pk integer not null references fclasses(pk) on delete restrict,
+			scalar text,
+			xt uuid references base_objects(pk) unique,
+			changed datetime default current_timestamp,
+			check (root=1)
+		);
+		
+		-- indexes
+		create unique index base_objects_partition_root on base_objects(partition, root);
+		create index base_objects_partition  on base_objects(partition);
+		create index base_objects_bclass_pk  on base_objects(bclass_pk);
+		create index base_objects_fclass_pk  on base_objects(fclass_pk);
+		create index base_objects_scalar     on base_objects(scalar);
+		create index base_objects_changed    on base_objects(changed);
+		
+		-- cannot update most fields
+		create trigger base_objects_bu_pk        before update of pk        on base_objects begin select raise(abort, 'cannot-update-object-pk');        end;
+		create trigger base_objects_bu_partition before update of partition on base_objects begin select raise(abort, 'cannot-update-object-partition'); end;
+		create trigger base_objects_bu_root      before update of root      on base_objects begin select raise(abort, 'cannot-update-object-root');      end;
+		create trigger base_objects_bu_bclass_pk before update of bclass_pk on base_objects begin select raise(abort, 'cannot-update-object-bclass_pk'); end;
+		create trigger base_objects_bu_fclass_pk before update of fclass_pk on base_objects begin select raise(abort, 'cannot-update-object-fclass_pk'); end;
+		create trigger base_objects_bu_scalar    before update of scalar    on base_objects begin select raise(abort, 'cannot-update-object-scalar');    end;
+		
+		-- cannot update xt once it has been defined
+		create trigger base_objects_bu_xt
+			before update of xt on base_objects when (old.xt is not null)
+		begin
+			select raise(abort, 'cannot-update-object-xt-once-set');
+		end;
+		
+		-- cannot delete root object
+		create trigger base_objects_bd_root
+			before delete on base_objects when (old.root)
+		begin
+			select raise(abort, 'cannot-delete-root-object');
+		end;
+		
+		-- insert: journal
+		create trigger base_objects_ai_journal
+			after insert on base_objects when (select value from settings where pk='journal')
+		begin
+			insert into journal(tbl, fpk, action, dsc) values(
+				'o',
+				new.pk,
+				'i',
+				insert_object_journal(
+					new.partition,
+					new.root,
+					(select name from fclasses where pk=new.fclass_pk),
+					new.scalar,
+					new.xt
+				)
+			);
+		end;
+		
+		-- update: journal
+		create trigger base_objects_au_journal
+			after update on base_objects when (select value from settings where pk='journal')
+		begin
+			insert into journal(tbl, fpk, action, dsc) values('o', new.pk, 'u',
+				'{' ||
+				'"x":"' || replace(new.xt, '"', '\"') || '"' ||
+				'}');
+		end;
+		
+		-- after delete on object with xt
+		create trigger base_objects_ad
+			after delete on base_objects
+		begin
+			delete from base_objects where pk=old.xt;
+		end;
+		
+		-- delete: journal
+		create trigger base_objects_ad_journal
+			after delete on base_objects when (select value from settings where pk='journal')
+		begin
+			insert into journal(tbl, fpk, action) values('o', old.pk, 'd');
+		end;
+		
+		-- initial fclass
+		insert into fclasses(name) values('Audrey::Object::Hash');
+		insert into fclasses(name) values('Audrey::Object::Root');
+		
+		-- add root objects
+		insert into base_objects(pk, partition, bclass_pk, fclass_pk, root, changed) values('1', 'm', 1, 2, 1, null);
+		insert into base_objects(pk, partition, bclass_pk, fclass_pk, root, changed) values('2', 'r', 1, 2, 1, null);
+		insert into base_objects(pk, partition, bclass_pk, fclass_pk, root, changed) values('3', 'd', 1, 2, 1, null);
+		
+		-- objects view
+		create view objects as
+			select
+				o.pk, o.partition, o.root, o.scalar, o.xt, o.changed,
+				(select name from fclasses where pk=o.bclass_pk) as bclass,
+				(select name from fclasses where pk=o.fclass_pk) as fclass
+			from base_objects o
+			where o.partition = current_partition();
+			
+		-- insert into objects
+		create trigger objects_insert
+			instead of insert on objects
+		begin
+			-- notify database of change
+			-- select change_to_true(new.fclass);
+			
+			-- ensure bclass record
+			insert or ignore into
+			fclasses(name)
+			values(new.bclass);
+			
+			-- ensure fclass record
+			insert or ignore into
+			fclasses(name)
+			values(new.fclass);
+			
+			-- insert
+			insert into
+				base_objects(
+					pk,
+					partition,
+					root,
+					bclass_pk,
+					fclass_pk,
+					scalar,
+					xt
+				)
+				
+				values(
+					new.pk,
+					current_partition(),
+					new.root,
+					(select pk from fclasses where name=new.bclass),
+					(select pk from fclasses where name=new.fclass),
+					new.scalar,
+					new.xt
+				);
+		end;
+		
+		/*
+		-- update objects
+		create trigger objects_update
+			instead of update of changed on objects
+		begin
+			update base_objects
+			set changed = new.changed
+			where pk = new.pk;
+		end;
+		*/
+		
+		-- delete from objects
+		create trigger objects_delete
+			instead of delete on objects
+		begin
+			delete from base_objects where pk=old.pk and partition = current_partition();
+		end;
+		
+		-- end of sql
+		SQL
+	end
+	#
+	# objects
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# relationships
+	# TODO: Need to rework relationships table so that ord can be changed.
+	#
+	def self.relationships()
+		# $tm.hrm
+		
+		# build
+		@dbh.execute_batch <<-SQL
+		-- create table
+		create table relationships (
+			pk varchar(36) primary key,
+			parent varchar(36) not null references base_objects(pk) on delete cascade,
+			child varchar(36) not null references base_objects(pk) on delete cascade,
+			ord integer not null,
+			hkey varchar(255),
+			check(typeof(ord)='integer')
+		);
+		
+		-- indexes
+		create unique index relationships_parent_hkey on relationships(parent, hkey);
+		create index relationships_parent on relationships(parent);
+		
+		-- must be in same partition
+		create trigger relationships_bi_partitions
+			before insert on relationships
+		begin
+			select case
+				when (select partition from base_objects where pk=new.parent) <> (select partition from base_objects where pk=new.child) then
+					raise(abort, 'relationship-objects-not-in-same-partition')
+				end;
+		end;
+		
+		-- parent must be array or hash
+		create trigger relationships_bi_bclass
+			before insert on relationships
+		begin
+			select case
+			when (select bclass from objects where pk=new.parent) not in ('Audrey::Object::Array', 'Audrey::Object::Hash') then
+				raise(abort, 'relationship-parent-base-class-does-not-support-relatonships')
+			end;
+		end;
+		
+		-- cannot update
+		create trigger relationships_bu
+			before update on relationships
+		begin
+			select raise(abort, 'cannot-update-relationships');
+		end;
+		
+		-- insert: journal
+		create trigger relationships_ai_journal
+			after insert on relationships when (select value from settings where pk='journal')
+		begin
+			insert into journal(tbl, fpk, action, dsc) values('r', new.pk, 'i',
+				'{' ||
+				'"p":"' || replace(new.parent, '"', '\"') || '",' ||
+				'"c":"' || replace(new.child, '"', '\"') || '",' ||
+				'"ord":' || new.ord || ',' ||
+				'"hk":"' || replace(new.hkey, '"', '\"') || '"' ||
+				'}');
+		end;
+		
+		-- insert: changed
+		create trigger relationships_ai_changed
+			after insert on relationships
+		begin
+			update base_objects set changed=current_timestamp where pk=new.parent;
+		end;
+		
+		-- journal: update
+		create trigger relationships_au_journal
+			after update on relationships when (select value from settings where pk='journal')
+		begin
+			insert into journal(tbl, fpk, action, dsc) values('r', new.pk, 'u',
+				'{' ||
+				'"c":"' || replace(new.child, '"', '\"') || '",' ||
+				'"ord":' || new.ord || ',' ||
+				'"hk":"' || replace(new.hkey, '"', '\"') || '"' ||
+				'}');
+		end;
+		
+		-- delete: journal
+		create trigger relationships_ad_journal
+			after delete on relationships when (select value from settings where pk='journal')
+		begin
+			insert into journal(tbl, fpk, action) values('r', old.pk, 'd');
+		end;
+		
+		-- delete: changed
+		create trigger relationships_ad_changed
+			after delete on relationships
+		begin
+			update base_objects set changed=current_timestamp where pk=old.parent;
+		end;
+		
+		-- delete parent if child is graph
+		-- KLUDGE: Cannot figure out why, but if this routine attempts to delete
+		-- from objects view, the delete never happens. So deleting directly
+		-- from base_objects.
+		create trigger relationships_ad_graph
+			after delete on relationships when (select graph_field((select fclass from objects where pk=old.parent), old.hkey))
+		begin
+			delete from base_objects where pk=old.parent;
+		end;
+		
+		-- end of sql
+		SQL
+	end
+	#
+	# relationships
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# views
+	#
+	def self.views
+		# $tm.hrm
+		
+		# build
+		@dbh.execute_batch <<-SQL
+		-- hash_pairs
+		create view hash_pairs as
+		select c.partition, r.parent, r.child, r.hkey, c.scalar, r.ord
+		from objects c, relationships r
+		where (c.pk = r.child) and (r.hkey is not null)
+		order by ord;
+		
+		-- fcos
+		create view fcos as
+			select pk
+			from objects
+			where fclass_fco(fclass);
+		
+		-- fco_descendants
+		create view fco_descendants as
+			with recursive ancestor(child) as (
+				select child from relationships where parent in (select pk from fcos)
+				union
+				select r.child from ancestor a inner join relationships r on r.parent = a.child
+			)
+			select child from ancestor;
+			
+		-- fco_traced
+		create view fco_traced as
+			select distinct pk
+			from objects
+			where fclass_fco(fclass) or (pk in (select child from fco_descendants));
+		
+		-- fco_not_traced
+		create view fco_not_traced as
+			select pk from objects
+			where pk not in (select pk from fco_traced);
+			
+		-- end of SQL
+		SQL
+	end
+	#
+	# views
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# sessions
+	#
+	def self.sessions
+		# $tm.hrm
+		
+		# build
+		@dbh.execute_batch <<-SQL
+		-- sessions
+		create table sessions (
+			pk varchar(36) primary key,
+			pw varchar(36)
+		);
+		
+		-- cannot update sessions
+		create trigger sessions_bu
+			before update on sessions
+		begin
+			select raise(abort, 'cannot-update-sessions');
+		end;
+		
+		-- results
+		create table results (
+			pk varchar(36) primary key,
+			session varchar(36) not null references sessions(pk) on delete cascade
+		);
+		
+		-- cannot update results
+		create trigger results_bu
+			before update on results
+		begin
+			select raise(abort, 'cannot-update-results');
+		end;
+		
+		-- result_rows
+		create table result_rows (
+			pk varchar(36) primary key,
+			result varchar(36) not null references results(pk) on delete cascade,
+			object varchar(36) not null references base_objects(pk) on delete cascade
+		);
+		
+		-- cannot update result_rows
+		create trigger result_rows_bu
+			before update on result_rows
+		begin
+			select raise(abort, 'cannot-update-result_rows');
+		end;
+		
+		-- end of SQL
+		SQL
+	end
+	#
+	# sessions
+	#---------------------------------------------------------------------------
+end
+#
+# Audrey::Engine::SQLite3::Init
+#===============================================================================