mikras_utils 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a66c5d0dcdafd3fb71c101b1cb02d5acb3ebe464418c070ed98c9e192301a45
-  data.tar.gz: 6bf90eead1cf7fd35b8a5082bae1a68cc6aec3a8ef158f025d6f3643c49f0f8f
+  metadata.gz: 1c7d48444e75236d0188b539182a80aefeaea2770cdf7982188d7f055c8b552e
+  data.tar.gz: 5d790361a1c314d7bda6013c1db9c904b50c81f3be39c8396d6c9e4da43e68bd
 SHA512:
-  metadata.gz: 8339a0a8a6f4180aa26b3f1430ce722d3f399d45b9875e59dfa0ace4086dcd9db82dc8b8b2c66596b52391e4140e0475bfb033b29470ee71cc2de000c138b0c1
-  data.tar.gz: 525550b69df7f1151f6f617c4cf9b9f5f034501cff135d2de268ed2d76c7e393f57b8aa3cf68f8e768d03dfd04669cea9c81536891c0c73b645f4e00493eeaf8
+  metadata.gz: 8e117ef1b45f0217ec14065d37405cf4b043259465c82a7df09caebc416a60ec15b80293c45c349ffb9cd0b9bd07fe8b9420b85e19f24a88a5dd62d3be62380f
+  data.tar.gz: 285faf4c815810af7111d49176218401f86afc1568a915c721ee67787cbb11df2cd6c016bad9d7b33db61b6120d5726d65aa8e2f0d27fc4cfb06a5685f69de9f

data/lib/mikras_utils/mkacl/generators/acl_functions.rb

@@ -68,8 +68,8 @@ module MkAcl
               _domain_id integer;
               _acls integer[]; -- per-rule ACLs
               _acl_select integer[][]; -- per-action ACLs
-              _acl_update integer[][];
-              _acl_delete integer[][];
+              _acl_update integer[][]; -- 
+              _acl_delete integer[][]; --
             begin
           ).align
           indent {

data/lib/mikras_utils/mkacl/generators/id_functions.rb

@@ -9,7 +9,7 @@ module MkAcl
 
       # Map from domain table to list of [table, path, links] tuples. The
       # entries describes the SQL link chain from the table to the given domain
-      # table (cases or events)
+      # table (cases, events, or visits)
       attr_reader :chains
 
       def initialize(generator)
@@ -30,7 +30,7 @@ module MkAcl
             meta.chains
           where src_schema_name = '#{app_schema}'
             and dst_schema_name = '#{app_schema}'
-            and dst_table_name in ('cases', 'events')
+            and dst_table_name in #{conn.quote_value_list(DOMAIN_TABLES)}
         )
 
         generate_per_table_id_functions
@@ -45,10 +45,10 @@ module MkAcl
 #     def table_seq() @table_seq ||= spec.tables.map(&:uid).join(', ') end
 
       # Generate a set of per-table functions that returns the associated
-      # case_id/event_id for the given record. The Functions are generated for
-      # each table in the spec file
+      # case_id/event_id/vist_id for the given record. The Functions are
+      # generated for each table in the spec file
       #
-      # The geneated functions are 
+      # The geneated functions are
       #
       #   case_id_of_RECORD(id integer)
       #   event_id_of_RECORD(id integer)
@@ -72,7 +72,7 @@ module MkAcl
       #
       def generate_per_table_id_functions
         # Generate functions by domain
-        for domain in %w(case event)
+        for domain in DOMAINS
 
           # Create the identity functions first. The identity functions are
           # case_id_of_case() and event_id_of_event(). This makes some stuff
@@ -95,7 +95,7 @@ module MkAcl
             record_name = Prick::Inflector.singularize(table_name)
             id_arg = "_#{id_field}"
             signature = "#{acl_schema}.#{id_field}_of_#{record_name}(#{id_arg} integer)"
-            puts "drop function if exists #{signature} cascade;" 
+            puts "drop function if exists #{signature} cascade;"
             puts "create function #{signature} returns integer as $$"
             indent {
               tables.pop
@@ -120,14 +120,17 @@ module MkAcl
           end
         end
 
+        # Tables that references visits, events, and cases
+        visit_tables = chains['visits'].map(&:first)
+
         # Tables that references events and cases
-        event_tables = chains['events'].map(&:first)
+        event_tables = chains['events'].map(&:first) - visit_tables
 
-        # Tables that references only cases 
+        # Tables that references only cases
         case_tables = chains['cases'].map(&:first) - event_tables
 
         # Create domain functions
-        for domain, tables in { case: case_tables, event: event_tables }
+        for domain, tables in { case: case_tables, event: event_tables, visit: visit_tables }
           for table_name in tables
             record_name = Prick::Inflector.singularize(table_name)
             signature = "#{acl_schema}.domain_id_of_#{record_name}(_id integer)"
@@ -154,7 +157,7 @@ module MkAcl
       # specialized versions above
       #
       def generate_general_id_functions
-        for domain in %w(case event)
+        for domain in DOMAINS
           domain_table = Prick::Inflector.pluralize(domain)
           field = "#{domain}_id"
           signature = "#{acl_schema}.#{field}_of(_table varchar, _id integer)"
@@ -162,7 +165,7 @@ module MkAcl
           puts %(
             drop function if exists #{signature} cascade;
             create function #{signature} returns integer as $$
-              select 
+              select
           ).align
           indent(2) {
             puts "case _table"
@@ -174,6 +177,7 @@ module MkAcl
               end
               puts "when 'cases' then _id"
               puts "when 'events' then _id"
+              puts "when 'visits' then _id"
               puts "else null"
             }
             puts "end case;"
@@ -187,7 +191,11 @@ module MkAcl
           -- FIXME: Ugly implementation
           drop function if exists #{signature} cascade;
           create function #{signature} returns integer as $$
-            select coalesce(acl_portal.event_id_of(_table, _id), acl_portal.case_id_of(_table, _id));
+            select coalesce(
+              acl_portal.visit_id_of(_table, _id),
+              acl_portal.event_id_of(_table, _id),
+              acl_portal.case_id_of(_table, _id)
+            );
           $$ language sql;
         ).align
         puts
@@ -199,8 +207,8 @@ module MkAcl
       #   event_id_of(r record)
       #   domain_id_of(r record)
       #
-      # Returns the case or event id associated with the given record. The
-      # record should be an ACL table record type
+      # Returns the case, event, or visit id associated with the given record.
+      # The record should be an ACL table record type
       #
       # Very useful in before insert triggers because it takes a record (eg.
       # NEW) instead of an ID
@@ -216,7 +224,7 @@ module MkAcl
           where schema_name = '#{app_schema}'
         )).group_by(&:table_name)
 
-        for domain in %w(case event)
+        for domain in MkAcl::DOMAINS
           domain_id_field = "#{domain}_id"
           signature = "#{acl_schema}.#{domain_id_field}_of(_r record)"
           puts %(
@@ -233,22 +241,22 @@ module MkAcl
             ).align
             indent {
               indent {
-                
-                
                 for table in spec.tables
                   next if domain == "event" && table.domain == "case"
-#                 puts "------------------------"
-#                 p table.name
-#                 p links.keys
+                  next if domain == "visit" && table.domain == "event"
                   link = links[table.name]&.first or next
                   if table.name == "cases"
                     puts "when '#{table.uid}' then return _r.id;"
                   elsif domain == "event" && table.name == "events"
                     puts "when '#{table.uid}' then return _r.id;"
+                  elsif domain == "visit" && table.name == "visits"
+                    puts "when '#{table.uid}' then return _r.id;"
                   elsif link.ref_table_name == "cases"
                     puts "when '#{table.uid}' then return _r.#{link.column_name};"
                   elsif link.ref_table_name == "events" && table.domain == "event"
                     puts "when '#{table.uid}' then return _r.#{link.column_name};"
+                  elsif link.ref_table_name == "visits" && table.domain == "visit"
+                    puts "when '#{table.uid}' then return _r.#{link.column_name};"
                   else
                     ref_record = spec[link.ref_table_name]&.record_name or next
                     id_of_function = "#{acl_schema}.#{domain_id_field}_of_#{ref_record}"
@@ -276,9 +284,8 @@ module MkAcl
             declare
               _id integer;
             begin
-              select coalesce(acl_portal.event_id_of(_r), acl_portal.case_id_of(_r))
+              select coalesce(acl_portal.visit_id_of(_r), acl_portal.event_id_of(_r), acl_portal.case_id_of(_r))
                 into _id;
-
               return _id;
             end;
           $$ language plpgsql

data/lib/mikras_utils/mkacl/generators/role_functions.rb

@@ -11,59 +11,128 @@ module MkAcl
       end
 
       def generate
-        generate_role_functions
+        generate_user_role_functions
+        generate_current_role_functions
       end
 
       def self.generate(generator) self.new(generator).generate end
-    
+
     private
-      def generate_role_functions
+      def generate_user_role_functions
         # TODO: Test. Then combine with per-table methods
-        signature = "public.current_is_role(_case_id integer, _roles text[])"
+        signature = "#{acl_schema}.user_is_role(_user_id integer, _domain_id integer, _roles text[])"
         puts %(
+          -- Return true if the user possess one or more of the given roles on the
+          -- domain record (cases, events, visits) with the given ID
+          --
           drop function if exists #{signature} cascade;
           create function #{signature} returns boolean as $$
-            select exists(
+            select exists (
               select
               from #{app_schema}.case_roles cr
               join #{app_schema}.case_role_users cru on cru.case_role_id = cr.id
-              where cr.case_id = _case_id
-                and cru.user_id = public.current_user_id()
+              where cr.case_id = _domain_id
+                and cru.user_id = _user_id
+                and cr.kind = any(_roles)
+
+              union
+
+              select
+              from #{app_schema}.event_roles cr
+              join #{app_schema}.event_role_users cru on cru.event_role_id = cr.id
+              where cr.event_id = _domain_id
+                and cru.user_id = _user_id
                 and cr.kind = any(_roles)
+
+              union
+
+              select
+              from #{app_schema}.visit_roles cr
+              join #{app_schema}.visit_role_users cru on cru.visit_role_id = cr.id
+              where cr.visit_id = _domain_id
+                and cru.user_id = _user_id
+                and cr.kind = any(_roles)
+
             );
           $$ language sql
             security definer;
         ).align
         puts
 
-        signature = "public.current_is_role(_case_id integer, role text)"
+        signature = "#{acl_schema}.user_is_role(_user_id integer, _domain_id integer, role text)"
+        puts %(
+          -- Return true if the user has the given role on the domain record
+          -- (cases, events, visits). Note that this function overloads the multi-role
+          -- version
+          --
+          drop function if exists #{signature} cascade;
+          create function #{signature} returns boolean as $$
+            select #{acl_schema}.user_is_role(_user_id, _domain_id, array[role]);
+          $$ language sql
+            security definer;
+        ).align
+        puts
+
+        for domain, roles in DOMAINS.zip([CASE_ROLES, EVENT_ROLES, VISIT_ROLES])
+          for role in roles
+            signature = "#{acl_schema}.user_is_#{role.downcase}(_user_id integer, _domain_id integer)"
+            puts %(
+              -- Return true if the user possess the '#{role}' role
+              --
+              drop function if exists #{signature} cascade;
+              create function #{signature} returns boolean as $$
+                select #{acl_schema}.user_is_role(_user_id, _domain_id, '#{role}');
+              $$ language sql
+                security definer;
+            ).align
+            puts
+          end
+        end
+      end
+
+      def generate_current_role_functions
+        # TODO: Test. Then combine with per-table methods
+        signature = "public.current_is_role(_domain_id integer, _roles text[])"
+        puts %(
+          -- Return true if the current user possess one or more of the given roles on the
+          -- domain record (cases, events, visits) with the given ID
+          --
+          drop function if exists #{signature} cascade;
+          create function #{signature} returns boolean as $$
+            select #{acl_schema}.user_is_role(public.current_user_id(), _domain_id, _roles);
+          $$ language sql
+            security definer;
+        ).align
+        puts
+
+        signature = "public.current_is_role(_domain_id integer, _role text)"
         puts %(
+          -- Return true if the current user possess the given role on the domain record
+          -- (cases, events, visits). Note that this function overloads the multi-role
+          -- version
+          --
           drop function if exists #{signature} cascade;
           create function #{signature} returns boolean as $$
-            select public.current_is_role(_case_id, array[role]);
+            select #{acl_schema}.user_is_role(public.current_user_id(), _domain_id, array[_role]);
           $$ language sql
             security definer;
         ).align
         puts
 
-        for role in MkAcl::ROLES
-          name = role.downcase
-          signature = "public.current_is_#{name}(_case_id integer)"
-          puts %(
-            drop function if exists #{signature} cascade;
-            create function #{signature} returns boolean as $$
-              select exists(
-                select
-                from #{app_schema}.case_roles cr
-                join #{app_schema}.case_role_users cru on cru.case_role_id = cr.id
-                where cr.case_id = _case_id
-                  and cru.user_id = public.current_user_id()
-                  and cr.kind = '#{role}'
-              );
-            $$ language sql
-              security definer;
-          ).align
-          puts
+        for domain, roles in DOMAINS.zip([CASE_ROLES, EVENT_ROLES, VISIT_ROLES])
+          for role in roles
+            signature = "public.current_is_#{role.downcase}(_domain_id integer)"
+            puts %(
+              -- Return true if the current user possess the '#{role}' role
+              --
+              drop function if exists #{signature} cascade;
+              create function #{signature} returns boolean as $$
+                select #{acl_schema}.user_is_role(public.current_user_id(), _domain_id, '#{role}');
+              $$ language sql
+                security definer;
+            ).align
+            puts
+          end
         end
       end
     end

data/lib/mikras_utils/mkacl/generators/rules.rb

@@ -6,7 +6,7 @@ module MkAcl
     # problem is that a record that fails the rule check is silently ignored
     # which is probably not what you want
     #
-    # The roles matches a acl_* array against a role action entry in the spec
+    # The roles matches an acl_* array against a role action entry in the spec
     # file. The acl_* arrays are themselves array of role ids. Each subarray is
     # indexed using the order in the acl.spec file
     #

data/lib/mikras_utils/mkacl/parser.rb

@@ -14,7 +14,7 @@ module MkAcl
     def parse_spec
       hash = YAML.load(IO.read(file), symbolize_names: true)
 
-      schema = hash.delete(:schema) or raise ArgumentError, "Can't find 'schema' declaration"
+      schema = hash.delete(:schema) or raise ArgumentError, "Can't find 'schema' declaration in #{file}"
       app_schema = schema[:app] or raise ArgumentError, "Can't find 'schema.app' attribute"
       acl_schema = schema[:acl] or raise ArgumentError, "Can't find 'schema.acl' attribute"
       spec = Spec.new(file, app_schema, acl_schema)

data/lib/mikras_utils/mkacl.rb

@@ -9,7 +9,14 @@ require 'prick-inflector'
 module MkAcl
   class ParseError < RuntimeError; end
 
-  ROLES = %w(RLA LA TA KON AKK CLA CTA ELA ETA)
+  DOMAINS = %w(case event visit)
+  DOMAIN_TABLES = DOMAINS.map { "#{_1}s" }
+
+  CASE_ROLES = %w(LA TA KON AKK RLA CLA CTA)
+  EVENT_ROLES = %w(ELA ETA)
+  VISIT_ROLES = %w(VLA VTA)
+
+  ROLES = CASE_ROLES + EVENT_ROLES + VISIT_ROLES
 end
 
 require_relative 'mkacl/spec.rb'

data/lib/mikras_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mikras_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_conn