pg_rls 0.2.5 → 1.0.0

data/lib/pg_rls/railtie.rb

@@ -1,16 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../pg_rls'
-require 'rails'
-
 module PgRls
-  # Extend Rails Railties
-  class Railtie < Rails::Railtie
-    railtie_name :my_gem
-
-    rake_tasks do
-      path = File.dirname(__FILE__)
-      Dir.glob("#{path}/database/tasks/**/*.rake").each { |f| load f }
-    end
+  class Railtie < ::Rails::Railtie
   end
 end

data/lib/pg_rls/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :nocov:
 module PgRls
-  VERSION = '0.2.5'
+  VERSION = "1.0.0"
 end
+# :nocov:

data/lib/pg_rls.rb

@@ -1,191 +1,107 @@
 # frozen_string_literal: true
 
-require 'active_record'
-require 'forwardable'
-require_relative 'pg_rls/version'
-require_relative 'pg_rls/database/prepared'
-require_relative 'pg_rls/schema/statements'
-require_relative 'pg_rls/schema/dumper'
-require_relative 'pg_rls/database/configurations'
-require_relative 'pg_rls/database/admin_statements'
-require_relative 'pg_rls/tenant'
-require_relative 'pg_rls/multi_tenancy'
-require_relative 'pg_rls/railtie' if defined?(Rails)
-require_relative 'pg_rls/errors/index'
-require_relative 'pg_rls/current/context'
-require_relative 'pg_rls/logger'
-
-ActiveRecord::Migrator.prepend PgRls::Admin::ActiveRecord::Migrator
-ActiveRecord::Tasks::DatabaseTasks.prepend PgRls::Admin::ActiveRecord::Tasks::DatabaseTasks
-ActiveRecord::ConnectionAdapters::AbstractAdapter.include PgRls::Schema::Statements
-ActiveRecord::SchemaDumper.prepend PgRls::Schema::Dumper
-
-# PostgreSQL Row Level Security
+require "active_record"
+require "forwardable"
+
+require_relative "pg_rls/deprecation"
+require_relative "pg_rls/error"
+require_relative "pg_rls/active_record"
+require_relative "pg_rls/active_support"
+require_relative "pg_rls/version"
+require_relative "pg_rls/engine"
+require_relative "pg_rls/railtie"
+require_relative "pg_rls/connection_config"
+
+# Row Level Security for PostgreSQL
 module PgRls
-  class Error < StandardError; end
+  DEFAULT_CONFIG_MAP = {
+    "@@search_methods": %i[subdomain tenant_id id],
+    "@@table_name": :organizations,
+    "@@class_name": :Organization,
+    "@@username": :app_user,
+    "@@password": :password,
+    "@@schema": :public,
+    "@@rls_role_group": :rls_group,
+    "@@current_attributes": Array(nil),
+    "@@abstract_base_record_class": "ActiveRecord::Base"
+  }.freeze
+
   class << self
     extend Forwardable
 
-    WRITER_METHODS = %i[table_name class_name search_methods logger excluded_shards].freeze
-    READER_METHODS = %i[connection_class execute table_name class_name search_methods logger excluded_shards].freeze
-    DELEGATORS_METHODS = %i[connection_class execute table_name search_methods class_name main_model logger
-                            excluded_shards].freeze
-
-    attr_writer(*WRITER_METHODS)
-    attr_reader(*READER_METHODS)
-
-    def_delegators(*DELEGATORS_METHODS)
-
     def setup
-      ActiveRecord::Base.ignored_columns += %w[tenant_id]
-
-      yield self
-
+      PgRls.reset_config!
       Rails.application.config.to_prepare do
-        PgRls.main_model.ignored_columns = [] # rubocop:disable Rails/IgnoredColumnsAssignment
+        PgRls::Record.ignored_columns += %w[tenant_id]
       end
-    end
-
-    def connection_class
-      @connection_class ||= ActiveRecord::Base
-    end
-
-    def admin_execute(query = nil, &)
-      current_tenant, reset_rls_connection = establish_admin_connection
-      execute_query_or_block(query, &)
-    ensure
-      reset_connection_if_needed(current_tenant, reset_rls_connection)
-    end
 
-    def establish_new_connection!(admin: false)
-      self.as_db_admin = admin
+      yield self
 
-      execute_rls_in_shards do |connection_class, pool|
-        connection_class.connection_pool.disconnect!
-        connection_class.remove_connection
-        connection_class.establish_connection(pool.db_config)
-      end
+      connection_config = PgRls::ConnectionConfig.new
+      connection_config.look_up_connection_config unless connection_config.connection_config?
+      freeze_config! unless Rails.env.test?
     end
 
     def main_model
       class_name.to_s.camelize.constantize
     end
 
-    def on_each_tenant(ids: [], scope: nil, &)
-      logger.deprecation_warning(
-        'PgRls.on_each_tenant is deprecated and will be removed in future versions. ' \
-        'Please use PgRls::Tenant.on_find_each instead.'
-      )
-      Tenant.on_find_each(ids:, scope:, &)
-    end
-
-    rails_version = Gem.loaded_specs['rails'].version
-    if rails_version >= Gem::Version.new('7.2') && rails_version < Gem::Version.new('7.3')
-      def pool_connection(pool)
-        pool.lease_connection
-      end
-    else
-      PgRls::Logger.new.deprecation_warning('PgRls.pool_connection is deprecated and will be removed in future PgRls 0.2.0. Please use pool.lease_connection instead.')
-      def pool_connection(pool)
-        pool.connection
+    def reset_config!
+      PgRls.class_variables.each do |var|
+        PgRls.class_variable_set(var, DEFAULT_CONFIG_MAP[var])
       end
     end
 
-    def execute_rls_in_shards
-      connection_pool_list = PgRls.connection_class.connection_handler.connection_pool_list
-      result = []
-
-      connection_pool_list.each do |pool|
-        connection = pool_connection(pool)
-        next if excluded_shards.include?(connection.connection_class.connection_db_config.name)
+    # :nocov:
+    def freeze_config! # rubocop:disable Metrics/MethodLength
+      PgRls.singleton_class.class_eval do
+        PgRls.class_variables.each do |var_name|
+          method_name = var_name.to_s.delete_prefix("@@").to_sym
+          setter_method_name = :"#{method_name}="
+          const_name = "#{method_name.to_s.upcase}_FROZEN_CONFIGURATION"
 
-        connection.transaction do
-          Rails.logger.info("Executing in #{connection.connection_class}")
+          remove_method setter_method_name if method_defined?(setter_method_name)
 
-          result << yield(connection.connection_class, pool)
-        end
-      end
-
-      result
-    end
+          PgRls.const_set(const_name, PgRls.class_variable_get(var_name))
 
-    def current_db_username
-      ActiveRecord::Base.connection_db_config.configuration_hash[:username]
-    end
+          define_method(method_name) do
+            PgRls.const_get(const_name)
+          end
 
-    def as_db_admin?
-      @as_db_admin || false
-    end
-
-    def admin_connection?
-      current_db_username != username
-    end
-
-    private
-
-    attr_writer :as_db_admin
-
-    def with_rls_connection(&)
-      reset_connection = admin_connection?
-
-      establish_new_connection! if reset_connection
-      ensure_block_execution(&)
-    ensure
-      establish_new_connection!(admin: true) if reset_connection
-    end
-
-    def establish_admin_connection
-      reset_rls_connection = false
-      current_tenant = nil
-
-      unless admin_connection?
-        reset_rls_connection = true
-        current_tenant = PgRls::Tenant.fetch
-        establish_new_connection!(admin: true)
+          PgRls.remove_class_variable(var_name)
+        end
       end
-
-      [current_tenant, reset_rls_connection]
-    end
-
-    def ensure_block_execution(*, **)
-      yield(*, **).presence
-    end
-
-    def execute_query_or_block(query = nil, &)
-      return ensure_block_execution(&) if block_given?
-
-      execute(query)
-    end
-
-    def reset_connection_if_needed(current_tenant, reset_rls_connection)
-      return unless reset_rls_connection
-
-      establish_new_connection!
-      PgRls::Tenant.switch(current_tenant) if current_tenant.present?
     end
+    # :nocov:
   end
 
+  mattr_accessor :search_methods
+  @@search_methods = %i[subdomain tenant_id id]
+
   mattr_accessor :table_name
-  @@table_name = 'companies'
+  @@table_name = :organizations
 
   mattr_accessor :class_name
-  @@class_name = 'Company'
+  @@class_name = :Organization
 
   mattr_accessor :username
-  @@username = 'app_user'
+  @@username = ENV.fetch("POSTGRES_RLS_USERNAME", "app_user")
 
   mattr_accessor :password
-  @@password = 'password'
+  @@password = ENV.fetch("POSTGRES_RLS_PASSWORD", "password")
 
-  mattr_accessor :test_inline_tenant
-  @@test_inline_tenant = false
+  mattr_accessor :schema
+  @@schema = :public
 
-  mattr_accessor :search_methods
-  @@search_methods = %i[subdomain id tenant_id]
+  mattr_accessor :rls_role_group
+  @@rls_role_group = :rls_group
+
+  mattr_accessor :connects_to
+  @@connects_to = nil
 
-  mattr_accessor :logger
-  @@logger = PgRls::Logger.new
+  mattr_accessor :current_attributes
+  @@current_attributes = Array(nil)
 
-  mattr_accessor :excluded_shards
-  @@excluded_shards = []
+  mattr_accessor :abstract_base_record_class
+  @@abstract_base_record_class = "ActiveRecord::Base"
 end

data/rbs_collection.lock.yaml

@@ -0,0 +1,132 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: actionpack
+  version: '7.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionview
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activemodel
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c718a9d97695937f952c72aec0c09632e1342201
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activerecord
+  version: '7.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c718a9d97695937f952c72aec0c09632e1342201
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c718a9d97695937f952c72aec0c09632e1342201
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c718a9d97695937f952c72aec0c09632e1342201
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: io-console
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: nokogiri
+  version: '1.11'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rails-dom-testing
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rails-html-sanitizer
+  version: '1.6'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 4af987b9b70455bd4493ef5a10e885f36e6ca6f6
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: railties
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: thor
+  version: '1.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,127 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+gems:
+  - name: activemodel
+  - name: activerecord
+  - name: activesupport
+  - name: concurrent-ruby
+
+  - name: ffi
+    ignore: true
+
+  - name: ast
+    ignore: true
+
+  - name: base64
+    ignore: true
+
+  - name: bigdecimal
+    ignore: true
+
+  - name: cgi
+    ignore: true
+
+  - name: connection_pool
+    ignore: true
+
+  - name: csv
+    ignore: true
+
+  - name: date
+    ignore: true
+
+  - name: diff-lcs
+    ignore: true
+
+  - name: erb
+    ignore: true
+
+  - name: fileutils
+    ignore: true
+
+  - name: forwardable
+    ignore: true
+
+  - name: i18n
+    ignore: true
+
+  - name: json
+    ignore: true
+
+  - name: listen
+    ignore: true
+
+  - name: logger
+    ignore: true
+
+  - name: minitest
+    ignore: true
+
+  - name: monitor
+    ignore: true
+
+  - name: mutex_m
+    ignore: true
+
+  - name: optparse
+    ignore: true
+
+  - name: parser
+    ignore: true
+
+  - name: pathname
+    ignore: true
+
+  - name: rack
+    ignore: true
+
+  - name: rainbow
+    ignore: true
+
+  - name: rake
+    ignore: true
+
+  - name: rbs
+    ignore: true
+
+  - name: rdoc
+    ignore: true
+
+  - name: securerandom
+    ignore: true
+
+  - name: singleton
+    ignore: true
+
+  - name: strscan
+    ignore: true
+
+  - name: tempfile
+    ignore: true
+
+  - name: time
+    ignore: true
+
+  - name: timeout
+    ignore: true
+
+  - name: tsort
+    ignore: true
+
+  - name: tzinfo
+    ignore: true
+
+  - name: uri
+    ignore: true

data/review_code.sh

@@ -0,0 +1,33 @@
+#!/bin/sh
+
+GREEN='\033[0;32m'
+RED='\033[0;31m'
+YELLOW='\033[0;33m'
+NC='\033[0m' # No Color
+
+echo -e "${YELLOW}Running Rubocop...${NC}"
+bin/rubocop
+if [ $? -eq 0 ]; then
+  echo -e "${GREEN}Rubocop passed!${NC}"
+else
+  echo -e "${RED}Rubocop failed!${NC}"
+  exit 1
+fi
+
+echo -e "${YELLOW}Running Steep...${NC}"
+bin/steep
+if [ $? -eq 0 ]; then
+  echo -e "${GREEN}Steep passed!${NC}"
+else
+  echo -e "${RED}Steep failed!${NC}"
+  exit 1
+fi
+
+echo -e "${YELLOW}Running tests...${NC}"
+bin/test
+if [ $? -eq 0 ]; then
+  echo -e "${GREEN}Tests passed!${NC}"
+else
+  echo -e "${RED}Tests failed!${NC}"
+  exit 1
+fi

data/sig/generators/pg_rls/active_record/active_record_generator.rbs

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module PgRls
+  module Generators
+    class ActiveRecordGenerator < ::ActiveRecord::Generators::ModelGenerator
+      def check_class_collision: () -> void
+
+      def create_model_file: () -> void
+      
+      def upgrade_model_file: () -> void
+      
+      def create_migration_file: () -> void
+
+      def upgrade_migration_file: () -> void
+
+      def backport_migration_file: () -> void
+
+      def template: (String, String, **untyped) -> void
+
+      private
+
+      def installing?: () -> bool
+
+      def migration_template_prefix: () -> String
+
+      def generate_abstract_class: () -> void
+
+      def model_path: () -> String
+
+      def generate_abstract_class_path: () -> String
+
+      def class_coalescing?: () -> bool
+
+      def clean_indexes_attributes!: () -> void
+
+      def model_file_exists?: () -> bool
+
+      def parent_class_name: () -> String
+
+      def rls_parent: () -> String
+    end
+  end
+end

data/sig/generators/pg_rls/install/install_generator.rbs

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PgRls
+  # Generator to install the gem
+  class InstallGenerator < Rails::Generators::Base
+    attr_reader attributes: :untyped
+
+    def initialize: (untyped, *untyped) -> void
+
+    def create_install_config: () -> void
+
+    def show_readme: () -> void
+
+    private
+
+    def pg_rls_config: (String) -> void
+
+    def invoke?: () -> bool
+  end
+end

data/sig/generators/pg_rls/pg_rls_generator.rbs

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module PgRls
+  module Generators
+    # PgRls Generator
+    class PgRlsGenerator < ::Rails::Generators::NamedBase
+    end
+  end
+end