pg_rls 0.2.4 → 1.0.0

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/check_rls_user_privileges.rbs

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        module CheckRlsUserPrivileges
+          include SqlHelperMethod
+
+          def check_rls_user_privileges!: ((String | Symbol), ?(String | Symbol), ?(String | Symbol)) -> bool
+
+          def check_table_privileges!: ((String | Symbol), (String | Symbol), (String | Symbol)) -> bool
+
+          def check_sequence_privileges!: ((String | Symbol), (String | Symbol), (String | Symbol)) -> bool
+
+          def check_table_rls_enabled!: ((String | Symbol), ?(String | Symbol)) -> bool
+
+          def check_table_user_policy_exists!: ((String | Symbol), (String | Symbol), ?(String | Symbol)) -> bool
+
+          private
+
+          def check_user_exists!: ((String | Symbol)) -> bool
+
+          def check_user_in_rls_group!: ((String | Symbol)) -> bool
+
+          def check_schema_usage_privilege!: ((String | Symbol), (String | Symbol)) -> bool
+
+          def check_default_table_privileges!: ((String | Symbol), (String | Symbol)) -> bool
+
+          def check_default_sequence_privileges!: ((String | Symbol), (String | Symbol)) -> bool
+
+          def check_user_exists_sql: ((String | Symbol)) -> String
+
+          def check_user_in_rls_group_sql: ((String | Symbol)) -> String
+
+          def check_schema_usage_privilege_sql: ((String | Symbol), (String | Symbol)) -> String
+
+          def check_default_table_privileges_sql: ((String | Symbol), (String | Symbol)) -> String
+
+          def check_table_privileges_sql: ((String | Symbol), (String | Symbol), (String | Symbol)) -> String
+
+          def check_default_sequence_privileges_sql: ((String | Symbol), (String | Symbol)) -> String
+
+          def check_sequence_privileges_sql: ((String | Symbol), (String | Symbol), (String | Symbol)) -> String
+
+          def check_table_rls_enabled_sql: ((String | Symbol), (String | Symbol)) -> String
+
+          def check_table_user_policy_exists_sql: ((String | Symbol), (String | Symbol), (String | Symbol)) -> String
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/errors.rbs

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        class UserDoesNotExistError < PgRls::Error
+        end
+        class UserNotInPgRlsGroupError < PgRls::Error
+        end
+        class UserMissingSchemaUsagePrivilegeError < PgRls::Error
+        end
+        class UserMissingTablePrivilegesError < PgRls::Error
+        end
+        class UserMissingSequencePrivilegesError < PgRls::Error
+        end
+        class TableRlsNotEnabledError < PgRls::Error
+        end
+        class TableUserPolicyDoesNotExistError < PgRls::Error
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/grant_rls_user_privileges.rbs

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        module GrantRlsUserPrivileges
+          include SqlHelperMethod
+
+          def grant_rls_user_privileges: (?(String | Symbol), ?(String | Symbol)) -> void
+
+          def revoke_rls_user_privileges: (?(String | Symbol), ?(String | Symbol)) -> void
+
+          private
+
+          def revoke_schema_usage: ((String | Symbol), (String | Symbol)) -> void
+
+          def revoke_schema_migration_table_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def revoke_default_sequence_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def revoke_default_table_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def revoke_existing_table_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def revoke_existing_sequence_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def grant_schema_usage: ((String | Symbol), (String | Symbol)) -> void
+
+          def grant_schema_migration_table_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def grant_default_sequence_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def grant_default_table_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def grant_existing_table_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def grant_existing_sequence_privileges: ((String | Symbol), (String | Symbol)) -> void
+
+          def revoke_schema_usage_sql: ((String | Symbol), (String | Symbol)) -> String
+
+          def revoke_default_sequence_privileges_sql: ((String | Symbol), (String | Symbol)) -> String
+
+          def revoke_default_table_privileges_sql: ((String | Symbol), (String | Symbol)) -> String
+
+          def revoke_existing_table_privileges_sql: ((String | Symbol), (String | Symbol)) -> String
+
+          def revoke_existing_sequence_privileges_sql: ((String | Symbol), (String | Symbol)) -> String
+  
+          def role_applicable_sql_statement: ((String | Symbol), (String | Symbol)) -> String
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/rls_functions.rbs

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        module RlsFunctions
+          include SqlHelperMethod
+
+          def function_exists?: (String) -> bool
+                                                   
+          def create_rls_functions: () -> void
+          
+          def drop_rls_functions: () -> void
+                                  
+          private
+
+          def create_function: (String, String) -> Array[PG::Result]
+                             
+          def drop_function: (String) -> Array[PG::Result]
+
+          def create_tenant_id_setter_function: () -> void
+                                              
+          def create_tenant_id_update_blocker_function: () -> void
+                                                      
+          def create_rls_exception: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/rls_policies.rbs

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        # This module contains the logic to grant user privileges
+        module RlsPolicies
+          include SqlHelperMethod
+
+          def enable_table_rls: (String, ?(String | Symbol), ?(String | Symbol)) -> void
+
+          def disable_table_rls: (String, ?(String | Symbol), ?(String | Symbol)) -> void
+
+          private
+
+          def drop_rls_policy_sql: ((String | Symbol), String, (String | Symbol)) -> String
+
+          def disable_row_level_security_sql: ((String | Symbol), String) -> String
+
+          def create_rls_policy_sql: ((String | Symbol), String, (String | Symbol)) -> String
+
+          def enable_row_level_security_sql: ((String | Symbol), String) -> String
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/rls_triggers.rbs

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        module RlsTriggers
+          include SqlHelperMethod
+
+          def trigger_exists?: (String, String, ?(String | Symbol)) -> bool
+                             
+          def append_tenant_table_triggers: (String, ?(String | Symbol)) -> void
+
+          def append_rls_table_triggers: (String, ?(String | Symbol)) -> void
+
+          def drop_tenant_table_triggers: (String, ?(String | Symbol)) -> void
+
+          def drop_rls_table_triggers: (String, ?(String | Symbol)) -> void
+
+          private
+
+          def drop_trigger: ((String | Symbol), String, String) -> void
+
+          def create_trigger: ((String | Symbol), String, String, String, String, String) -> void
+
+          def create_rls_exception_trigger: ((String | Symbol), String) -> void
+
+          def create_tenant_id_setter_trigger: ((String | Symbol), String) -> void
+
+          def create_tenant_id_update_blocker_trigger: ((String | Symbol), String) -> void
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/rls_user_statements.rbs

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        # This module contains the logic to grant user privileges
+        module RlsUserStatements
+          include SqlHelperMethod
+
+          def create_rls_role: (String, String) -> void
+                             
+          def drop_rls_role: (String) -> void
+                           
+          def user_exists?: (String) -> bool
+                          
+          def drop_rls_user: (String) -> void
+                           
+          def create_rls_user: (String, String) -> void
+                             
+          def create_rls_group: (?(String | Symbol)) -> void
+                              
+          def drop_rls_group: (?(String | Symbol)) -> void
+                            
+          def assign_user_to_group: (String) -> void
+                                  
+          def remove_user_from_group: (String) -> void
+                                    
+          private
+
+          def user_exists_sql: (String) -> String
+                             
+          def drop_rls_user_sql: (String) -> String
+                               
+          def create_rls_user_sql: (String, String) -> String
+                                 
+          def create_rls_group_sql: ((String | Symbol)) -> String
+                                  
+          def drop_rls_group_sql: ((String | Symbol)) -> String
+                                
+          def assign_user_to_group_sql: (String) -> String
+                                      
+          def remove_user_from_group_sql: (String) -> String
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/schema_dumper.rbs

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        # Require to fix configuration super method invocation
+        module DummySchemaDumper
+          def tables: (StringIO) -> void
+        end
+
+        module SchemaDumper
+          include DummySchemaDumper
+
+          @rls_table_array: Array[String]
+          @rls_tenant_table: String
+          @connection: ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+
+          def tables: (StringIO) -> void
+
+          def table: (String, StringIO) -> void
+
+          private
+
+          def dump_table_to_string: (untyped, String) -> String
+
+          def rls_table?: (String) -> bool
+
+          def rls_tenant_table?: (String) -> bool
+
+          def rls_table_array: -> Array[String]
+
+          def fetch_rls_tables: -> Array[String]
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/schema_statements.rbs

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+# 
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        # This module contains the logic to create rls policies tables and functions
+        module SchemaStatements
+          def table_exists?: (String | Symbol) -> bool
+          def create_table: (String | Symbol, *untyped args) -> void
+          def drop_table: (String | Symbol, *untyped args) -> void
+          def add_column: (String | Symbol, String | Symbol, String | Symbol, *untyped args) -> void
+          def remove_column: (String | Symbol, String | Symbol, *untyped args) -> void
+
+          def create_rls_tenant_table: (String | Symbol, *untyped args) -> void
+          def convert_to_rls_tenant_table: (String | Symbol) -> void
+          def create_rls_table: (String | Symbol, *untyped args) -> void
+          def convert_to_rls_table: (String | Symbol) -> void
+          def drop_rls_tenant_table: (String | Symbol, *untyped args) -> void
+          def revert_from_rls_tenant_table: (String | Symbol) -> void
+          def drop_rls_table: (String | Symbol, *untyped args) -> void
+          def revert_from_rls_table: (String | Symbol) -> void
+
+          # Dynamically Generate the Inversion Methods
+          def invert_create_rls_tenant_table: (String | Symbol, *untyped args) -> void
+          def invert_convert_to_rls_tenant_table: (String | Symbol) -> void
+          def invert_create_rls_table: (String | Symbol, *untyped args) -> void
+          def invert_convert_to_rls_table: (String | Symbol) -> void
+
+          # Inherited Methods
+          
+          def check_rls_user_privileges!: (String | Symbol, String | Symbol) -> bool
+          def enable_table_rls: (String | Symbol, String | Symbol) -> void
+          def append_rls_table_triggers: (String | Symbol) -> void
+          def add_index: (String | Symbol, Array[String | Symbol] | String | Symbol, *untyped args) -> void
+          def remove_index: (String | Symbol, Array[String | Symbol] | String | Symbol, *untyped args) -> void
+          def append_tenant_table_triggers: (String | Symbol) -> void
+          def create_rls_group: () -> void
+          def create_rls_role: (String | Symbol, String | Symbol) -> void
+          def create_rls_functions: () -> void
+          def drop_tenant_table_triggers: (String | Symbol) -> void
+          def disable_table_rls: (String | Symbol, String | Symbol) -> void
+          def drop_rls_functions: () -> void
+          def drop_rls_role: (String | Symbol) -> void
+          def drop_rls_group: () -> void
+          def drop_rls_table_triggers: (String | Symbol) -> void
+          def grant_rls_user_privileges: (String | Symbol) -> void
+          def revoke_rls_user_privileges: (String | Symbol) -> void
+          def index_exists?: (String | Symbol, String | Symbol, *untyped args) -> bool
+          def column_exists?: (String | Symbol, String | Symbol) -> bool
+          def create_rls_index: (String | Symbol, Array[String | Symbol], **untyped args) -> void
+          def drop_rls_index: (String | Symbol, Array[String | Symbol], **untyped args) -> void
+
+          private
+
+          def create_rls_table_setup: (String | Symbol) -> void
+          def create_rls_tenant_table_setup: (String | Symbol) -> void
+          def create_rls_initialize_setup: () -> void
+          def drop_rls_table_setup: (String | Symbol) -> void
+          def drop_rls_initialize_setup: (String | Symbol) -> void
+          def rls_index_columns: (Array[String | Symbol]) -> Array[Symbol]
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgre_sql/sql_helper_method.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        module SqlHelperMethod
+          private
+
+          def execute: (String) -> Array[PG::Result]
+
+          def transaction: (*untyped args, **untyped attr) { () ->  Array[PG::Result] } -> Array[PG::Result]
+
+          def execute_sql!: (String) -> Array[PG::Result]
+
+          def rescue_sql_error?: (StandardError) -> bool
+        end
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters/postgresql.rbs

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/connection_adapters.rbs

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module ConnectionAdapters
+      module ConnectionPool
+        attr_reader checkout_timeout: untyped
+
+        def checkout: (?untyped checkout_timeout) -> untyped
+
+        def rls_connection?: () -> bool
+
+        def pool_config: () -> untyped
+
+        private def reset_rls_used_connections: (ActiveRecord::ConnectionAdapters::PostgreSQLAdapter conn) -> nil
+
+      end
+    end
+  end
+
+  class Tenant
+    def self.reset_rls_used_connections: (ActiveRecord::ConnectionAdapters::PostgreSQLAdapter conn) -> nil
+
+    def set_rls: (ActiveRecord::ConnectionAdapters::PostgreSQLAdapter conn) -> Tenant
+
+    def new_tenant?: () -> bool
+
+    def reused_connection?: (ActiveRecord::ConnectionAdapters::PostgreSQLAdapter conn) -> bool
+
+    def rls_connection_object_cache_by_thread=: (untyped value) -> untyped
+
+    def rls_connection_object_cache_by_thread: () -> untyped
+
+    def rls_used_connections: () -> untyped
+  end
+
+  module Current
+    def self.tenant: () -> Tenant
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    class ConnectionPool
+      attr_reader checkout_timeout: untyped
+    end
+  end
+end
+
+

data/sig/pg_rls/active_record/database_shards.rbs

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    # Require to fix configuration super method invocation
+    module DummyDatabaseShards
+      def configurations=: (Hash[String, untyped]) -> Hash[String, untyped]
+    end
+
+    module DatabaseShards
+      include DummyDatabaseShards
+
+      REQUIRED_CONFIGURATION_KEYS: Array[String]
+
+      def add_rls_configurations: (Hash[String, untyped], ?Hash[String, untyped]) -> Hash[String, untyped]
+      
+      def configurations=: (Hash[String, untyped]) -> Hash[String, untyped]
+
+      def configurations: () -> Hash[String, untyped]
+                        
+      def rls_shard_config?: (Hash[String, untyped]) -> bool
+                           
+      def adapter_configurations: (Hash[String, untyped], Hash[String, untyped], String) -> (::Hash[::String, untyped] | nil)
+
+      def rls_configuration: () -> Hash[String, untyped]
+
+      private
+
+      def add_primary_and_rls_config: (Hash[String, untyped], Hash[String, untyped], ?String) -> Hash[String, untyped]
+
+      def shard_config?: (Hash[String, untyped]) -> bool
+    end
+  end
+end

data/sig/pg_rls/active_record/migration/command_recorder.rbs

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module Migration
+      # ActiveRecord Migration Command Recorder Extension
+      module CommandRecorder
+        REVERSIBLE_AND_IRREVERSIBLE_METHODS: ::Array[Symbol]
+
+        def self.included: (Class) -> void
+      end
+    end
+  end
+end

data/sig/pg_rls/active_record/migration.rbs

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module PgRls
+  module ActiveRecord
+    module Migration
+    end
+  end
+end

data/sig/pg_rls/active_record.rbs

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PgRls
+  # ActiveRecord Connection Adapter Extension
+  module ActiveRecord
+  end
+end

data/sig/pg_rls/active_support/hash_ext.rbs

@@ -0,0 +1,11 @@
+module PgRls
+  module ActiveSupport
+    module Hash
+      def deep_transform_values: () { (untyped) -> untyped } -> untyped
+    end
+  end
+end
+
+class Hash[unchecked out K, unchecked out V]
+  include PgRls::ActiveSupport::Hash
+end

data/sig/pg_rls/active_support/string_ext.rbs

@@ -0,0 +1,27 @@
+module PgRls
+  module ActiveSupport
+    module StringExt
+      def sanitize_sql: -> String
+                      
+      def gsub!: (Regexp, String) -> String
+               
+      def strip!: -> String
+                
+      def camelize: -> String
+                  
+      def constantize: -> Class
+                     
+      def underscore: -> String
+
+      def pluralize: () -> String
+
+      def singularize: () -> String
+
+      def blank?: () -> bool
+    end
+  end
+end
+
+class String
+  include PgRls::ActiveSupport::StringExt
+end

data/sig/pg_rls/active_support.rbs

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PgRls
+  # ActiveSupport Connection Adapter Extension
+  module ActiveSupport
+  end
+end

data/sig/pg_rls/app/models/pg_rls/record.rbs

@@ -0,0 +1,4 @@
+module PgRls
+  class Record < ::ActiveRecord::Base
+  end
+end

data/sig/pg_rls/connection_config.rbs

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PgRls
+  class ConnectionConfig
+    @db_config: ActiveRecord::DatabaseConfigurations::HashConfig
+    @connection_name: String
+
+    def initialize: (?ActiveRecord::DatabaseConfigurations::HashConfig db_config) -> void
+    def look_up_connection_config: () -> (Hash[Symbol, Hash[Symbol, Symbol]] | nil)
+    def connection_config?: () -> bool
+    def invalid_connection_config: () -> nil
+    def build_config_hash: (ActiveRecord::DatabaseConfigurations::HashConfig db_config, String connection_name) -> (Hash[Symbol, Hash[Symbol, Hash[Symbol, String]]] | Hash[Symbol, Hash[Symbol, String]] | nil)
+    def build_dual_mode_config: (String connection_name) -> Hash[Symbol, Hash[Symbol, Hash[Symbol, String]]]
+    def build_single_mode_config: (String connection_name) -> Hash[Symbol, Hash[Symbol, String]]
+  end
+end

data/sig/pg_rls/deprecation.rbs

@@ -0,0 +1,9 @@
+module PgRls
+  module Deprecation
+    self.@logger: ::ActiveSupport::Deprecation
+
+    def self.warn: (String) -> void
+
+    def self.logger: () -> ::ActiveSupport::Deprecation
+  end
+end

data/sig/pg_rls/engine.rbs

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PgRls
+  # Engine
+  class Engine < ::Rails::Engine
+  end
+end

data/sig/pg_rls/errors.rbs

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PgRls
+  class Error < StandardError
+    class InvalidConnectionConfig < Error
+    end
+
+    class InvalidSearchInput < Error
+    end
+
+    class TenantNotFound < Error
+    end
+  end
+end

data/sig/pg_rls/railtie.rbs

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PgRls
+  class Railtie < ::Rails::Railtie
+  end
+end

data/sig/pg_rls/tenant_test_helper.rbs

@@ -0,0 +1,14 @@
+module PgRls::TenantTestHelper::TenantOverrides
+  @attributes: Hash[Symbol, untyped]
+  def tenant=: (untyped) -> void
+  def reset: () -> untyped
+  def initialize_tenant_history: () -> void
+  def store_current_tenant_in_history: () -> void
+  def assign_new_tenant: (untyped) -> void
+  def restore_tenant_history: (untyped) -> void
+  def restore_most_recent_tenant: () -> void
+end
+
+module PgRls::TenantTestHelper
+  include PgRls::TenantTestHelper::TenantOverrides
+end