active_tree 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb9ce62863408c33ab2b8db4bdfa7b21a67b15f14927f43d9b168dfe121604a
-  data.tar.gz: 8dc8ad54ec03529d82bab17e219389057a7040fb1340bc691a0c9de06566ef66
+  metadata.gz: b3e791b0f19ec736feb7d89abd9cf24081c7e4bcd862b08cea3f095432cbf9a9
+  data.tar.gz: e74e6e2fec69129d45f6b5c62332c42f3537039bc44dfc0dbf0d711a5eba5e00
 SHA512:
-  metadata.gz: cda0e7157dfa1abd83dd92df6430bce8842500cc93aa58b07a0fa0216ea8c826f9ff61dec764bfa3bfbd915a67f32e8006987a960f7beede67d1a9357e68280d
-  data.tar.gz: 0e62ce8e6fb8d9ffe4d1caecfa32f6129842607452ed217116b0d7802c2c2d190ba48dc58f432c886a95dc902074308fad7071dd4b94a025d2856a73bd18783e
+  metadata.gz: 102b71e83e19b2bcf330eef8d4fbc001cfec5015368301705c79611ef8ea5d19f2e00d8de6944398b7db83250e9a87a135cde71a8a9a87e05695b1c25e7d7938
+  data.tar.gz: fec20af4b4653f1526cdf321e826fb3a125840708f96205ba9ea2da2d5b0a0927d9fe2d7099096eff2b6ee24f497db6499bdd6cb970a8f0f4a0fbc996560c735

data/lib/active_tree/models/concerns/active_tree_able.rb

@@ -13,8 +13,13 @@ module ActiveTree
     	    before_destroy :active_tree_delete_storage
 
             # instance methods
+        	def store
+        	    ActiveTree::Store.new id, ACTIVE_TREE_OPTIONS
+        	end # store
+
         	def active_tree_role
-        	    "active_tree_owner_#{id}_#{ ACTIVE_TREE_OPTIONS[:owner_role_suffix] }"
+        	    #"active_tree_owner_#{id}_#{ ACTIVE_TREE_OPTIONS[:owner_role_suffix] }"
+        	    store.role_name
         	end # role
 
             # Generates a JWT token the client (SPA) can pass to PostgREST for privilege escalation
@@ -24,64 +29,17 @@ module ActiveTree
         	end # .generate_jwt
 
 
-            # Returns the LCA table name as configured within config/active_tree.yml
-        	def active_tree_table_name
-        	    ACTIVE_TREE_OPTIONS[:table_name]
-        	end # .active_tree_table_name
-
-
-            # Creates LCA table partition and role for owner
+            # Creates table partition and role for owner
         	def active_tree_create_storage
-
-        	    # create data partition
-        	    active_tree_sql "create table if not exists #{active_tree_table_name}_#{id} partition of #{active_tree_table_name} for values in (#{id})"
-        	    # create partition indexes
-                active_tree_sql "create index index_#{id}_by_id on #{active_tree_table_name}_#{id} (id)"
-                active_tree_sql "create index index_#{id}_by_owner_id on #{active_tree_table_name}_#{id} (owner_id)"
-                active_tree_sql "create index index_#{id}_by_type on #{active_tree_table_name}_#{id} (type)"
-                active_tree_sql "create index index_#{id}_by_parent_entity_id on #{active_tree_table_name}_#{id} (parent_entity_id)"
-                active_tree_sql "create index index_#{id}_by_path on #{active_tree_table_name}_#{id} using gist (path)"
-                active_tree_sql "create index index_#{id}_by_data_provider_and_data_external_id on #{active_tree_table_name}_#{id} (data_provider, data_external_id)"
-                
-
-            	if ACTIVE_TREE_OPTIONS[:create_postgrest_roles]
-            		# drop role if it exists
-                	active_tree_sql "drop role if exists #{ active_tree_role }"
-
-                	# create role
-            		active_tree_sql "create role #{ active_tree_role }"
-
-        		    # grant privs
-        		    active_tree_sql "grant all privileges on #{active_tree_table_name}_#{id} to #{ active_tree_role }"
-            	end
-
+		    store.up!
         	end # create_storage
 
 
             # Deletes or detaches the partition and removes the role for this owner
         	def active_tree_delete_storage
-
-            	    if ACTIVE_TREE_OPTIONS[:create_postgrest_roles]
-        	        # revoke privs
-        	        active_tree_sql "REVOKE ALL PRIVILEGES ON #{active_tree_table_name}_#{id} FROM #{ active_tree_role }"
-
-        	        # delete role
-        	        active_tree_sql "drop role #{ active_tree_role }"
-            	    end
-
-            	    if ACTIVE_TREE_OPTIONS[:destroy_partition_on_owner_destroy]
-        	        # delete partition
-        	        active_tree_sql "drop table if exists #{active_tree_table_name}_#{id}"
-            	    else
-                	# detach and forget about it
-                	active_tree_sql "alter table #{active_tree_table_name} detach partition #{ active_tree_role }"
-            	    end
+        	    store.down!
         	end # delete_storage
 
-            def active_tree_sql sql
-                ActiveRecord::Base.connection.execute sql
-            end # active_tree_sql
-
     	end # ClassMethods
     end
 end

data/lib/active_tree/models/model.rb

@@ -37,7 +37,8 @@ class ActiveTree::Model < ActiveRecord::Base
 
         partition_suffix = "_#{owner_id}"
 
-        table = "#{ self.table_name }#{ partition_suffix }"
+        #table = "#{ self.table_name }#{ partition_suffix }"
+        table = ActiveTree::Store.new(owner_id).partition_name
 
         ApplicationRecord.connection.schema_cache.clear!
         return self if !ApplicationRecord.connection.schema_cache.data_source_exists? table

data/lib/active_tree/store.rb

@@ -0,0 +1,140 @@
+class ActiveTree::Store
+    attr_accessor :options
+    attr_accessor :debug_sql
+
+    class StoreException < StandardError
+	def initialize(msg="This is a custom exception", exception_type="custom")
+    	    @exception_type = exception_type
+            super(msg)
+	end
+    end
+
+    def initialize(owner_id = nil, options = ACTIVE_TREE_OPTIONS)
+	raise StoreException.new("Unspecified owner_id, please pass an unique identifier for the partitions: ActiveTree::Store.new(your_owner_id)") if !owner_id
+	raise StoreException.new("owner_id must be an integer!") if !owner_id.is_a?(Integer)
+	@owner_id = owner_id
+	@options = options
+	@debug_sql = false
+    end
+
+    def up!
+	create_partition_for_owner # also adds indexes
+	setup_role if @options[:create_postgrest_roles] == true
+    end # up!
+
+    def down!
+	drop_role if @options[:create_postgrest_roles] == true
+	remove_partition
+    end # down!
+
+    def clear_schema_cache
+	ActiveRecord::Base.connection.schema_cache.clear!
+    end # clear_schema_cache
+
+    # partition management
+
+    def has_partition?
+	clear_schema_cache
+	ActiveRecord::Base.connection.schema_cache.data_source_exists? partition_name
+    end
+
+    def create_partition_for_owner(indexes = [ :id, :owner_id, :type, :parent_entity_id, :path, [:data_provider, :data_external_id ] ])
+	create_partition indexes
+    end
+
+    def create_partition(indexes = [])
+	return false if has_partition?
+
+	run "create table if not exists #{partition_name} partition of #{ @options[:table_name] } for values in ( #{@owner_id} )"
+
+	indexes.each do |index|
+	    create_index(index) if !has_index?( index )
+	end if indexes.size > 0
+    end # create_partition
+
+    def partition_name
+	"#{@options[:table_name]}_#{@owner_id}"
+    end # partition_name
+
+    def should_drop_partition?
+	@options[:destroy_partition_on_owner_destroy] == true
+    end
+
+    def remove_partition
+	if should_drop_partition?
+	    drop_partition
+	else
+	    detach_partition
+	end
+    end # remove_partition
+
+    def detach_partition
+	return false if !has_partition?
+	run "alter table #{@options[:table_name]} detach partition #{partition_name}"
+    end # detach_partition
+    def drop_partition
+	return false if !has_partition?
+	run "drop table #{partition_name}"
+    end # drop partition
+
+    # index management
+
+    def partition_indexes
+	clear_schema_cache
+	ActiveRecord::Base.connection.indexes( partition_name ).map(&:name)
+    end
+
+    def has_index? name
+	partition_indexes.include?( index_name(name).truncate(63) )
+    end # has_index
+    def create_index index
+	return false if has_index? index
+	name = index_name index
+	using = name.include?("path") ? "using gist" : ""
+
+	cols = [index].flatten.join(",")
+
+	run "create index #{name} on #{partition_name} #{using} ( #{ cols } )"
+    end # create_index
+    def drop_index index
+	return false if !has_index? index
+	run "drop index if exists #{ index_name(index) }"
+    end # drop_index
+
+    def index_name identifier
+	i = [identifier].flatten.join("_")
+	"#{partition_name}_by_#{i}"
+    end
+
+    # TODO role management
+
+    def setup_role
+	drop_role
+	create_role
+    end # setup_role
+
+    def role_name
+	"active_tree_owner_#{@owner_id}_#{ @options[:owner_role_suffix] }"
+    end # role_name
+
+    def drop_role
+	run "drop role if exists #{role_name}"
+    end # drop role
+
+    def create_role
+	run "create role #{role_name}"
+    end # create role
+
+    def assign_to_partition
+	run "grant all privileges on #{partition_name} to #{ role_name }"
+    end
+
+    # running SQL
+
+    def run sql
+	puts sql if @debug_sql
+	ActiveRecord::Base.connection.execute sql
+	true
+    end
+
+end

data/lib/active_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveTree
-  VERSION = "0.3"
+  VERSION = "0.3.1"
 end

data/lib/active_tree.rb

@@ -6,6 +6,7 @@ require "active_record"
 require "pg_ltree"
 
 require_relative "active_tree/version"
+require_relative "active_tree/store"
 
 require_relative "active_tree/models/concerns/statusable"
 require_relative "active_tree/models/metadata"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_tree
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - Nick @ Earthster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -77,6 +77,7 @@ files:
 - lib/active_tree/models/model.rb
 - lib/active_tree/queries/active_tree_query.rb
 - lib/active_tree/queries/model_query.rb
+- lib/active_tree/store.rb
 - lib/active_tree/version.rb
 - lib/generators/active_tree/install_generator.rb
 - lib/generators/active_tree/templates/config.yml.tt