ros-apartment 2.10.0 → 3.0.1

data/lib/apartment/active_record/connection_handling.rb

@@ -1,16 +1,27 @@
 # frozen_string_literal: true
 
-module ActiveRecord
-  # This is monkeypatching activerecord to ensure that whenever a new connection is established it
+module ActiveRecord # :nodoc:
+  # This is monkeypatching Active Record to ensure that whenever a new connection is established it
   # switches to the same tenant as before the connection switching. This problem is more evident when
   # using read replica in Rails 6
   module ConnectionHandling
-    def connected_to_with_tenant(database: nil, role: nil, prevent_writes: false, &blk)
-      current_tenant = Apartment::Tenant.current
+    if ActiveRecord.version.release <= Gem::Version.new('6.2')
+      def connected_to_with_tenant(database: nil, role: nil, prevent_writes: false, &blk)
+        current_tenant = Apartment::Tenant.current
 
-      connected_to_without_tenant(database: database, role: role, prevent_writes: prevent_writes) do
-        Apartment::Tenant.switch!(current_tenant)
-        yield(blk)
+        connected_to_without_tenant(database: database, role: role, prevent_writes: prevent_writes) do
+          Apartment::Tenant.switch!(current_tenant)
+          yield(blk)
+        end
+      end
+    else
+      def connected_to_with_tenant(role: nil, prevent_writes: false, &blk)
+        current_tenant = Apartment::Tenant.current
+
+        connected_to_without_tenant(role: role, prevent_writes: prevent_writes) do
+          Apartment::Tenant.switch!(current_tenant)
+          yield(blk)
+        end
       end
     end
 

data/lib/apartment/active_record/postgresql_adapter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/ClassAndModuleChildren
+
+# NOTE: This patch is meant to remove any schema_prefix appart from the ones for
+# excluded models. The schema_prefix would be resolved by apartment's setting
+# of search path
+module Apartment::PostgreSqlAdapterPatch
+  def default_sequence_name(table, _column)
+    res = super
+
+    # for JDBC driver, if rescued in super_method, trim leading and trailing quotes
+    res.delete!('"') if defined?(JRUBY_VERSION)
+
+    schema_prefix = "#{Apartment::Tenant.current}."
+    default_tenant_prefix = "#{Apartment::Tenant.default_tenant}."
+
+    # NOTE: Excluded models should always access the sequence from the default
+    # tenant schema
+    if excluded_model?(table)
+      res.sub!(schema_prefix, default_tenant_prefix) if schema_prefix != default_tenant_prefix
+      return res
+    end
+
+    res.delete_prefix!(schema_prefix) if res&.starts_with?(schema_prefix)
+
+    res
+  end
+
+  private
+
+  def excluded_model?(table)
+    Apartment.excluded_models.any? { |m| m.constantize.table_name == table }
+  end
+end
+
+require 'active_record/connection_adapters/postgresql_adapter'
+
+# NOTE: inject this into postgresql adapters
+class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+  include Apartment::PostgreSqlAdapterPatch
+end
+# rubocop:enable Style/ClassAndModuleChildren

data/lib/apartment/active_record/schema_migration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  class SchemaMigration < ActiveRecord::Base # :nodoc:
+  class SchemaMigration # :nodoc:
     class << self
       def table_exists?
         connection.table_exists?(table_name)

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'apartment/adapters/abstract_adapter'
+require 'apartment/active_record/postgresql_adapter'
 
 module Apartment
   module Tenant
@@ -41,7 +42,6 @@ module Apartment
       def reset
         @current = default_tenant
         Apartment.connection.schema_search_path = full_search_path
-        reset_sequence_names
       end
 
       def init
@@ -81,9 +81,8 @@ module Apartment
         # there is a issue for prepared statement with changing search_path.
         # https://www.postgresql.org/docs/9.3/static/sql-prepare.html
         Apartment.connection.clear_cache! if postgresql_version < 90_300
-        reset_sequence_names
-      rescue *rescuable_exceptions
-        raise TenantNotFound, "One of the following schema(s) is invalid: \"#{tenant}\" #{full_search_path}"
+      rescue *rescuable_exceptions => e
+        raise_schema_connect_to_new(tenant, e)
       end
 
       private
@@ -130,29 +129,18 @@ module Apartment
         Apartment.connection.send(:postgresql_version)
       end
 
-      def reset_sequence_names
-        # sequence_name contains the schema, so it must be reset after switch
-        # There is `reset_sequence_name`, but that method actually goes to the database
-        # to find out the new name. Therefore, we do this hack to only unset the name,
-        # and it will be dynamically found the next time it is needed
-        descendants_to_unset = ActiveRecord::Base.descendants
-                                                 .select { |c| c.instance_variable_defined?(:@sequence_name) }
-                                                 .reject do |c|
-                                                   c.instance_variable_defined?(:@explicit_sequence_name) &&
-                                                     c.instance_variable_get(:@explicit_sequence_name)
-                                                 end
-        descendants_to_unset.each do |c|
-          # NOTE: due to this https://github.com/rails-on-services/apartment/issues/81
-          # unreproduceable error we're checking before trying to remove it
-          c.remove_instance_variable :@sequence_name if c.instance_variable_defined?(:@sequence_name)
-        end
-      end
-
       def schema_exists?(schemas)
         return true unless Apartment.tenant_presence_check
 
         Array(schemas).all? { |schema| Apartment.connection.schema_exists?(schema.to_s) }
       end
+
+      def raise_schema_connect_to_new(tenant, exception)
+        raise TenantNotFound, <<~EXCEPTION_MESSAGE
+          Could not set search path to schemas, they may be invalid: "#{tenant}" #{full_search_path}.
+          Original error: #{exception.class}: #{exception}
+        EXCEPTION_MESSAGE
+      end
     end
 
     # Another Adapter for Postgresql when using schemas and SQL

data/lib/apartment/console.rb

@@ -1,21 +1,5 @@
 # frozen_string_literal: true
 
-# A workaround to get `reload!` to also call Apartment::Tenant.init
-# This is unfortunate, but I haven't figured out how to hook into the reload process *after* files are reloaded
-
-# reloads the environment
-# rubocop:disable Style/OptionalBooleanParameter
-def reload!(print = true)
-  puts 'Reloading...' if print
-
-  # This triggers the to_prepare callbacks
-  ActionDispatch::Callbacks.new(proc {}).call({})
-  # Manually init Apartment again once classes are reloaded
-  Apartment::Tenant.init
-  true
-end
-# rubocop:enable Style/OptionalBooleanParameter
-
 def st(schema_name = nil)
   if schema_name.nil?
     tenant_list.each { |t| puts t }

data/lib/apartment/log_subscriber.rb

@@ -8,26 +8,38 @@ module Apartment
     # NOTE: for some reason, if the method definition is not here, then the custom debug method is not called
     # rubocop:disable Lint/UselessMethodDefinition
     def sql(event)
-      super(event)
+      super
     end
     # rubocop:enable Lint/UselessMethodDefinition
 
     private
 
-    def debug(progname = nil, &block)
+    def debug(progname = nil, &)
       progname = "  #{apartment_log}#{progname}" unless progname.nil?
 
-      super(progname, &block)
+      super
     end
 
     def apartment_log
-      database = color("[#{Apartment.connection.raw_connection.db}] ", ActiveSupport::LogSubscriber::MAGENTA, true)
-      schema = nil
-      unless Apartment.connection.schema_search_path.nil?
-        schema = color("[#{Apartment.connection.schema_search_path.tr('"', '')}] ",
-                       ActiveSupport::LogSubscriber::YELLOW, true)
-      end
+      database = color("[#{database_name}] ", ActiveSupport::LogSubscriber::MAGENTA, bold: true)
+      schema = current_search_path
+      schema = color("[#{schema.tr('"', '')}] ", ActiveSupport::LogSubscriber::YELLOW, bold: true) unless schema.nil?
       "#{database}#{schema}"
     end
+
+    def current_search_path
+      if Apartment.connection.respond_to?(:schema_search_path)
+        Apartment.connection.schema_search_path
+      else
+        Apartment::Tenant.current # all others
+      end
+    end
+
+    def database_name
+      db_name = Apartment.connection.raw_connection.try(:db) # PostgreSQL, PostGIS
+      db_name ||= Apartment.connection.raw_connection.try(:query_options)&.dig(:database) # Mysql
+      db_name ||= Apartment.connection.current_database # Failover
+      db_name
+    end
   end
 end

data/lib/apartment/migrator.rb

@@ -13,40 +13,22 @@ module Apartment
 
         migration_scope_block = ->(migration) { ENV['SCOPE'].blank? || (ENV['SCOPE'] == migration.scope) }
 
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, version, &migration_scope_block)
-        else
-          ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
-        end
+        ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
       end
     end
 
     # Migrate up/down to a specific version
     def run(direction, database, version)
       Tenant.switch(database) do
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_paths, version)
-        else
-          ActiveRecord::Base.connection.migration_context.run(direction, version)
-        end
+        ActiveRecord::Base.connection.migration_context.run(direction, version)
       end
     end
 
     # rollback latest migration `step` number of times
     def rollback(database, step = 1)
       Tenant.switch(database) do
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_paths, step)
-        else
-          ActiveRecord::Base.connection.migration_context.rollback(step)
-        end
+        ActiveRecord::Base.connection.migration_context.rollback(step)
       end
     end
-
-    private
-
-    def activerecord_below_5_2?
-      ActiveRecord.version.release < Gem::Version.new('5.2.0')
-    end
   end
 end

data/lib/apartment/railtie.rb

@@ -2,7 +2,6 @@
 
 require 'rails'
 require 'apartment/tenant'
-require 'apartment/reloader'
 
 module Apartment
   class Railtie < Rails::Railtie
@@ -48,7 +47,12 @@ module Apartment
     config.after_initialize do
       # NOTE: Load the custom log subscriber if enabled
       if Apartment.active_record_log
-        ActiveSupport::Notifications.unsubscribe 'sql.active_record'
+        ActiveSupport::Notifications.notifier.listeners_for('sql.active_record').each do |listener|
+          next unless listener.instance_variable_get('@delegate').is_a?(ActiveRecord::LogSubscriber)
+
+          ActiveSupport::Notifications.unsubscribe listener
+        end
+
         Apartment::LogSubscriber.attach_to :active_record
       end
     end
@@ -60,23 +64,5 @@ module Apartment
       load 'tasks/apartment.rake'
       require 'apartment/tasks/enhancements' if Apartment.db_migrate_tenants
     end
-
-    #
-    #   The following initializers are a workaround to the fact that I can't properly hook into the rails reloader
-    #   Note this is technically valid for any environment where cache_classes is false, for us, it's just development
-    #
-    if Rails.env.development?
-
-      # Apartment::Reloader is middleware to initialize things properly on each request to dev
-      initializer 'apartment.init' do |app|
-        app.config.middleware.use Apartment::Reloader
-      end
-
-      # Overrides reload! to also call Apartment::Tenant.init as well
-      # so that the reloaded classes have the proper table_names
-      console do
-        require 'apartment/console'
-      end
-    end
   end
 end

data/lib/apartment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apartment
-  VERSION = '2.10.0'
+  VERSION = '3.0.1'
 end

data/lib/apartment.rb

@@ -7,15 +7,9 @@ require 'active_record'
 require 'apartment/tenant'
 
 require_relative 'apartment/log_subscriber'
-
-if ActiveRecord.version.release >= Gem::Version.new('6.0')
-  require_relative 'apartment/active_record/connection_handling'
-end
-
-if ActiveRecord.version.release >= Gem::Version.new('6.1')
-  require_relative 'apartment/active_record/schema_migration'
-  require_relative 'apartment/active_record/internal_metadata'
-end
+require_relative 'apartment/active_record/connection_handling'
+require_relative 'apartment/active_record/schema_migration'
+require_relative 'apartment/active_record/internal_metadata'
 
 # Apartment main definitions
 module Apartment
@@ -33,14 +27,10 @@ module Apartment
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
 
-    if ActiveRecord.version.release >= Gem::Version.new('6.1')
-      def_delegators :connection_class, :connection, :connection_db_config, :establish_connection
+    def_delegators :connection_class, :connection, :connection_db_config, :establish_connection
 
-      def connection_config
-        connection_db_config.configuration_hash
-      end
-    else
-      def_delegators :connection_class, :connection, :connection_config, :establish_connection
+    def connection_config
+      connection_db_config.configuration_hash
     end
 
     # configure apartment with available options

data/ros-apartment.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       # NOTE: ignore all test related
-      f.match(%r{^(test|spec|features|documentation)/})
+      f.match(%r{^(test|spec|features|documentation|gemfiles|.github)/})
     end
   end
   s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
@@ -26,11 +26,14 @@ Gem::Specification.new do |s|
 
   s.homepage = 'https://github.com/rails-on-services/apartment'
   s.licenses = ['MIT']
+  s.metadata = {
+    'github_repo' => 'ssh://github.com/rails-on-services/apartment'
+  }
 
-  s.add_dependency 'activerecord', '>= 5.0.0', '< 6.2'
+  s.add_dependency 'activerecord', '>= 6.1.0', '< 7.2'
   s.add_dependency 'parallel', '< 2.0'
-  s.add_dependency 'public_suffix', '>= 2.0.5', '< 5.0'
-  s.add_dependency 'rack', '>= 1.3.6', '< 3.0'
+  s.add_dependency 'public_suffix', '>= 2.0.5', '< 6.0'
+  s.add_dependency 'rack', '>= 1.3.6', '< 4.0'
 
   s.add_development_dependency 'appraisal', '~> 2.2'
   s.add_development_dependency 'bundler', '>= 1.3', '< 3.0'
@@ -39,11 +42,11 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.4'
   s.add_development_dependency 'rspec_junit_formatter'
-  s.add_development_dependency 'rspec-rails', '~> 3.4'
-  s.add_development_dependency 'rubocop', '~> 0.93'
-  s.add_development_dependency 'rubocop-performance', '~> 1.10'
-  s.add_development_dependency 'rubocop-rails', '~> 2.1'
-  s.add_development_dependency 'rubocop-rspec', '~> 1.44'
+  s.add_development_dependency 'rspec-rails', '~> 6.1'
+  s.add_development_dependency 'rubocop', '~> 1.63'
+  s.add_development_dependency 'rubocop-performance', '~> 1.21'
+  s.add_development_dependency 'rubocop-rails', '~> 2.24'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.29'
 
   if defined?(JRUBY_VERSION)
     s.add_development_dependency 'activerecord-jdbc-adapter'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ros-apartment
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Ryan Brunner
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,20 +18,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +55,7 @@ dependencies:
         version: 2.0.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -65,7 +65,7 @@ dependencies:
         version: 2.0.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ dependencies:
         version: 1.3.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
         version: 1.3.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -196,70 +196,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.93'
+        version: '1.63'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.93'
+        version: '1.63'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.24'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.44'
+        version: '2.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.44'
+        version: '2.29'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -312,36 +312,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/workflows/changelog.yml"
-- ".github/workflows/reviewdog.yml"
 - ".gitignore"
 - ".pryrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
-- ".story_branch.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
 - Guardfile
-- HISTORY.md
 - README.md
 - Rakefile
-- TODO.md
-- docker-compose.yml
-- gemfiles/rails_4_2.gemfile
-- gemfiles/rails_5_0.gemfile
-- gemfiles/rails_5_1.gemfile
-- gemfiles/rails_5_2.gemfile
-- gemfiles/rails_6_0.gemfile
-- gemfiles/rails_6_1.gemfile
-- gemfiles/rails_master.gemfile
 - lib/apartment.rb
 - lib/apartment/active_record/connection_handling.rb
 - lib/apartment/active_record/internal_metadata.rb
+- lib/apartment/active_record/postgresql_adapter.rb
 - lib/apartment/active_record/schema_migration.rb
 - lib/apartment/adapters/abstract_adapter.rb
 - lib/apartment/adapters/abstract_jdbc_adapter.rb
@@ -364,7 +350,6 @@ files:
 - lib/apartment/migrator.rb
 - lib/apartment/model.rb
 - lib/apartment/railtie.rb
-- lib/apartment/reloader.rb
 - lib/apartment/tasks/enhancements.rb
 - lib/apartment/tasks/task_helper.rb
 - lib/apartment/tenant.rb
@@ -377,7 +362,8 @@ files:
 homepage: https://github.com/rails-on-services/apartment
 licenses:
 - MIT
-metadata: {}
+metadata:
+  github_repo: ssh://github.com/rails-on-services/apartment
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -393,7 +379,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for managing database multitenancy. Apartment Gem drop in replacement