ros-apartment 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9729bd0cd46375da3b48c1aad59bd2de396f90e9a7cd92d24dafee964988cbc4
-  data.tar.gz: 1e0b6a955a15691edcbbb680657d1a65c75c7b49cd93e342d4df7212d29313c5
+  metadata.gz: 6182f5dcd4e369e6f497295705079b3d0b20d644d8006c5a256d8618eff1a2c3
+  data.tar.gz: 351be335f73230dd83df3020ba77b33f8e33e297f67c5256210f3e0c0c12e749
 SHA512:
-  metadata.gz: 9f12f51635a20b87a5a8bddcd00eceac5ccd355699e2932947689a929695b1ad4337528da976a7905c31ed91413ee41eddc6f2ce7aed1d79f7643073b50053fa
-  data.tar.gz: 617c702d5f698a3a8b81649f10bb91373ff9fabab4755270ffc2289a44ea7b48b814f939c4363bb23d45a378f1f444963188980ea0acc1e5b76cd7d28207e3f3
+  metadata.gz: 7714a5182a47cefc6a95d85118278263bf4d326c5441184005a3ef48cf10368cd123602a0e5635547233c12ecb587e107dc72c0a117423dd774054f19767e3ce
+  data.tar.gz: 6b4247215b4754d031ce248f6e457d1c509157d310964e74cc72f05e8f896215b29341cd892515c9e9803a2f0db6528f180474b0c14cf03384ee1ac4f9693164

data/.circleci/config.yml

@@ -70,7 +70,9 @@ workflows:
           matrix:
             parameters:
               ruby_version: ["ruby:2.6-buster", "ruby:2.7-buster", "ruby:3.0-buster"]
-              gemfile: ["gemfiles/rails_5_2.gemfile", "gemfiles/rails_6_0.gemfile", "gemfiles/rails_6_1.gemfile"]
+              gemfile: ["gemfiles/rails_5_2.gemfile", "gemfiles/rails_6_0.gemfile", "gemfiles/rails_6_1.gemfile", "gemfiles/rails_7_0.gemfile"]
             exclude:
               - ruby_version: "ruby:3.0-buster"
                 gemfile: "gemfiles/rails_5_2.gemfile"
+              - ruby_version: "ruby:2.6-buster"
+                gemfile: "gemfiles/rails_7_0.gemfile"

data/.rubocop_todo.yml

@@ -77,7 +77,6 @@ RSpec/DescribedClass:
     - 'spec/tenant_spec.rb'
     - 'spec/unit/elevators/host_hash_spec.rb'
     - 'spec/unit/migrator_spec.rb'
-    - 'spec/unit/reloader_spec.rb'
 
 # Offense count: 5
 # Cop supports --auto-correct.
@@ -128,7 +127,6 @@ RSpec/FilePath:
     - 'spec/unit/elevators/host_spec.rb'
     - 'spec/unit/elevators/subdomain_spec.rb'
     - 'spec/unit/migrator_spec.rb'
-    - 'spec/unit/reloader_spec.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -159,7 +157,6 @@ RSpec/InstanceVariable:
 # Cop supports --auto-correct.
 RSpec/LeadingSubject:
   Exclude:
-    - 'spec/unit/reloader_spec.rb'
 
 # Offense count: 2
 RSpec/LeakyConstantDeclaration:
@@ -196,7 +193,6 @@ RSpec/NamedSubject:
     - 'spec/support/contexts.rb'
     - 'spec/support/requirements.rb'
     - 'spec/tenant_spec.rb'
-    - 'spec/unit/reloader_spec.rb'
 
 # Offense count: 24
 RSpec/NestedGroups:
@@ -217,7 +213,6 @@ RSpec/VerifiedDoubles:
   Exclude:
     - 'spec/integration/apartment_rake_integration_spec.rb'
     - 'spec/unit/elevators/first_subdomain_spec.rb'
-    - 'spec/unit/reloader_spec.rb'
 
 # Offense count: 17
 Style/Documentation:
@@ -233,7 +228,6 @@ Style/Documentation:
     - '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/generators/apartment/install/install_generator.rb'

data/.ruby-version

@@ -1 +1 @@
-2.7.3
+2.7.5

data/Appraisals

@@ -1,29 +1,5 @@
 # frozen_string_literal: true
 
-appraise 'rails-5-0' do
-  gem 'rails', '~> 5.0.0'
-  platforms :ruby do
-    gem 'pg', '< 1.0.0'
-  end
-  platforms :jruby do
-    gem 'activerecord-jdbc-adapter', '~> 50.0'
-    gem 'activerecord-jdbcpostgresql-adapter', '~> 50.0'
-    gem 'activerecord-jdbcmysql-adapter', '~> 50.0'
-  end
-end
-
-appraise 'rails-5-1' do
-  gem 'rails', '~> 5.1.0'
-  platforms :ruby do
-    gem 'pg', '< 1.0.0'
-  end
-  platforms :jruby do
-    gem 'activerecord-jdbc-adapter', '~> 51.0'
-    gem 'activerecord-jdbcpostgresql-adapter', '~> 51.0'
-    gem 'activerecord-jdbcmysql-adapter', '~> 51.0'
-  end
-end
-
 appraise 'rails-5-2' do
   gem 'rails', '~> 5.2.0'
   platforms :jruby do
@@ -57,6 +33,18 @@ appraise 'rails-6-1' do
   end
 end
 
+appraise 'rails-7-0' do
+  gem 'rails', '~> 7.0.0'
+  platforms :ruby do
+    gem 'sqlite3', '~> 1.4'
+  end
+  platforms :jruby do
+    gem 'activerecord-jdbc-adapter', '~> 61.0'
+    gem 'activerecord-jdbcpostgresql-adapter', '~> 61.0'
+    gem 'activerecord-jdbcmysql-adapter', '~> 61.0'
+  end
+end
+
 appraise 'rails-master' do
   gem 'rails', git: 'https://github.com/rails/rails.git'
   platforms :ruby do

data/README.md

@@ -344,7 +344,7 @@ Setting this configuration value to `false` will disable the schema presence che
 
 ```ruby
 Apartment.configure do |config|
-  tenant_presence_check = false
+  config.tenant_presence_check = false
 end
 ```
 

data/gemfiles/rails_5_2.gemfile

@@ -3,12 +3,6 @@
 source "http://rubygems.org"
 
 gem "rails", "~> 5.2.0"
-gem "rubocop"
-
-group :local do
-  gem "guard-rspec", "~> 4.2"
-  gem "pry"
-end
 
 platforms :jruby do
   gem "activerecord-jdbc-adapter", "~> 52.0"

data/gemfiles/rails_6_0.gemfile

@@ -3,12 +3,6 @@
 source "http://rubygems.org"
 
 gem "rails", "~> 6.0.0"
-gem "rubocop"
-
-group :local do
-  gem "guard-rspec", "~> 4.2"
-  gem "pry"
-end
 
 platforms :ruby do
   gem "sqlite3", "~> 1.4"

data/gemfiles/rails_6_1.gemfile

@@ -3,12 +3,6 @@
 source "http://rubygems.org"
 
 gem "rails", "~> 6.1.0"
-gem "rubocop"
-
-group :local do
-  gem "guard-rspec", "~> 4.2"
-  gem "pry"
-end
 
 platforms :ruby do
   gem "sqlite3", "~> 1.4"

data/gemfiles/rails_7_0.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+
+platforms :ruby do
+  gem "sqlite3", "~> 1.4"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 61.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 61.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 61.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_master.gemfile

@@ -3,21 +3,15 @@
 source "http://rubygems.org"
 
 gem "rails", git: "https://github.com/rails/rails.git"
-gem "rubocop"
-
-group :local do
-  gem "guard-rspec", "~> 4.2"
-  gem "pry"
-end
 
 platforms :ruby do
   gem "sqlite3", "~> 1.4"
 end
 
 platforms :jruby do
-  gem "activerecord-jdbc-adapter", "~> 52.0"
-  gem "activerecord-jdbcpostgresql-adapter", "~> 52.0"
-  gem "activerecord-jdbcmysql-adapter", "~> 52.0"
+  gem "activerecord-jdbc-adapter", "~> 61.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 61.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 61.0"
 end
 
 gemspec path: "../"

data/lib/apartment/active_record/postgresql_adapter.rb

@@ -0,0 +1,39 @@
+# 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
+    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/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/railtie.rb

@@ -2,7 +2,6 @@
 
 require 'rails'
 require 'apartment/tenant'
-require 'apartment/reloader'
 
 module Apartment
   class Railtie < Rails::Railtie
@@ -60,23 +59,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 = '2.11.0'
 end

data/ros-apartment.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/rails-on-services/apartment'
   s.licenses = ['MIT']
 
-  s.add_dependency 'activerecord', '>= 5.0.0', '< 6.2'
+  s.add_dependency 'activerecord', '>= 5.0.0', '< 7.1'
   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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ros-apartment
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 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: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -21,7 +21,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -332,16 +332,15 @@ files:
 - 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_7_0.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 +363,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

data/gemfiles/rails_4_2.gemfile

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# This file was generated by Appraisal
-
-source 'http://rubygems.org'
-
-gem 'rails', '~> 4.2.0'
-
-group :local do
-  gem 'guard-rspec', '~> 4.2'
-  gem 'pry'
-end
-
-platforms :ruby do
-  gem 'mysql2', '~> 0.4.0'
-  gem 'pg', '< 1.0.0'
-end
-
-platforms :jruby do
-  gem 'activerecord-jdbc-adapter', '~> 1.3'
-  gem 'activerecord-jdbcmysql-adapter', '~> 1.3'
-  gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3'
-end
-
-gemspec path: '../'

data/gemfiles/rails_5_0.gemfile

@@ -1,23 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", "~> 5.0.0"
-gem "rubocop"
-
-group :local do
-  gem "guard-rspec", "~> 4.2"
-  gem "pry"
-end
-
-platforms :ruby do
-  gem "pg", "< 1.0.0"
-end
-
-platforms :jruby do
-  gem "activerecord-jdbc-adapter", "~> 50.0"
-  gem "activerecord-jdbcpostgresql-adapter", "~> 50.0"
-  gem "activerecord-jdbcmysql-adapter", "~> 50.0"
-end
-
-gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -1,23 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", "~> 5.1.0"
-gem "rubocop"
-
-group :local do
-  gem "guard-rspec", "~> 4.2"
-  gem "pry"
-end
-
-platforms :ruby do
-  gem "pg", "< 1.0.0"
-end
-
-platforms :jruby do
-  gem "activerecord-jdbc-adapter", "~> 51.0"
-  gem "activerecord-jdbcpostgresql-adapter", "~> 51.0"
-  gem "activerecord-jdbcmysql-adapter", "~> 51.0"
-end
-
-gemspec path: "../"

data/lib/apartment/reloader.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Apartment
-  class Reloader
-    #   Middleware used in development to init Apartment for each request
-    #   Necessary due to code reload (annoying).  When models are reloaded, they no longer have the proper table_name
-    #   That is prepended with the schema (if using postgresql schemas)
-    #   I couldn't figure out how to properly hook into the Rails reload process *after* files are reloaded
-    #   so I've used this in the meantime.
-    #
-    #   Also see apartment/console for the re-definition of reload! that re-init's Apartment
-    #
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      Tenant.init
-      @app.call(env)
-    end
-  end
-end