ros-apartment 2.4.0 → 2.7.1

data/TODO.md

@@ -46,6 +46,5 @@
 
 Quick TODOs
 
-1. `default_tenant` should be up to the adapter, not the Apartment class, deprecate `default_schema`
 2. deprecation.rb rescues everything, we have a hard dependency on ActiveSupport so this is unnecessary
 3.

data/gemfiles/rails_5_0.gemfile

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

data/gemfiles/rails_5_1.gemfile

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

data/gemfiles/rails_5_2.gemfile

@@ -1,20 +1,19 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
-source 'http://rubygems.org'
+source "http://rubygems.org"
 
-gem 'rails', '~> 5.2.0'
+gem "perx-rubocop", "~> 0.0.3"
+gem "rails", "~> 5.2.0"
 
 group :local do
-  gem 'guard-rspec', '~> 4.2'
-  gem 'pry'
+  gem "guard-rspec", "~> 4.2"
+  gem "pry"
 end
 
 platforms :jruby do
-  gem 'activerecord-jdbc-adapter', '~> 52.0'
-  gem 'activerecord-jdbcmysql-adapter', '~> 52.0'
-  gem 'activerecord-jdbcpostgresql-adapter', '~> 52.0'
+  gem "activerecord-jdbc-adapter", "~> 52.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 52.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 52.0"
 end
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -1,24 +1,23 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
-source 'http://rubygems.org'
+source "http://rubygems.org"
 
-gem 'rails', '~> 6.0.0.rc1'
+gem "perx-rubocop", "~> 0.0.3"
+gem "rails", "~> 6.0.0"
 
 group :local do
-  gem 'guard-rspec', '~> 4.2'
-  gem 'pry'
+  gem "guard-rspec", "~> 4.2"
+  gem "pry"
 end
 
 platforms :ruby do
-  gem 'sqlite3', '~> 1.4'
+  gem "sqlite3", "~> 1.4"
 end
 
 platforms :jruby do
-  gem 'activerecord-jdbc-adapter', '~> 60.0.rc1'
-  gem 'activerecord-jdbcmysql-adapter', '~> 60.0.rc1'
-  gem 'activerecord-jdbcpostgresql-adapter', '~> 60.0.rc1'
+  gem "activerecord-jdbc-adapter", "~> 60.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 60.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 60.0"
 end
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/rails_master.gemfile

@@ -1,24 +1,23 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
-source 'http://rubygems.org'
+source "http://rubygems.org"
 
-gem 'rails', git: 'https://github.com/rails/rails.git'
+gem "perx-rubocop", "~> 0.0.3"
+gem "rails", git: "https://github.com/rails/rails.git"
 
 group :local do
-  gem 'guard-rspec', '~> 4.2'
-  gem 'pry'
+  gem "guard-rspec", "~> 4.2"
+  gem "pry"
 end
 
 platforms :ruby do
-  gem 'sqlite3', '~> 1.4'
+  gem "sqlite3", "~> 1.4"
 end
 
 platforms :jruby do
-  gem 'activerecord-jdbc-adapter', '~> 52.0'
-  gem 'activerecord-jdbcmysql-adapter', '~> 52.0'
-  gem 'activerecord-jdbcpostgresql-adapter', '~> 52.0'
+  gem "activerecord-jdbc-adapter", "~> 52.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 52.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 52.0"
 end
 
-gemspec path: '../'
+gemspec path: "../"

data/lib/apartment.rb

@@ -6,22 +6,40 @@ require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
 
+# require_relative 'apartment/arel/visitors/postgresql'
+
+require_relative 'apartment/active_record/log_subscriber'
+require_relative 'apartment/active_record/connection_handling' if ActiveRecord.version.release >= Gem::Version.new('6.0')
+
+if ActiveRecord.version.release >= Gem::Version.new('6.1')
+  require_relative 'apartment/active_record/schema_migration'
+  require_relative 'apartment/active_record/internal_metadata'
+end
+
 module Apartment
   class << self
     extend Forwardable
 
-    ACCESSOR_METHODS = %i[use_schemas use_sql seed_after_create prepend_environment
-                          append_environment with_multi_server_setup].freeze
+    ACCESSOR_METHODS = %i[use_schemas use_sql seed_after_create prepend_environment default_tenant
+                          append_environment with_multi_server_setup tenant_presence_check active_record_log].freeze
 
     WRITER_METHODS = %i[tenant_names database_schema_file excluded_models
-                        default_schema persistent_schemas connection_class
-                        tld_length db_migrate_tenants seed_data_file
+                        persistent_schemas connection_class
+                        db_migrate_tenants seed_data_file
                         parallel_migration_threads pg_excluded_names].freeze
 
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
 
-    def_delegators :connection_class, :connection, :connection_config, :establish_connection
+    if ActiveRecord.version.release >= Gem::Version.new('6.1')
+      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
+    end
 
     # configure apartment with available options
     def configure
@@ -36,8 +54,12 @@ module Apartment
       extract_tenant_config
     end
 
+    def tld_length=(_)
+      Apartment::Deprecation.warn('`config.tld_length` have no effect because it was removed in https://github.com/influitive/apartment/pull/309')
+    end
+
     def db_config_for(tenant)
-      (tenants_with_config[tenant] || connection_config).with_indifferent_access
+      (tenants_with_config[tenant] || connection_config)
     end
 
     # Whether or not db:migrate should also migrate tenants
@@ -53,15 +75,9 @@ module Apartment
       @excluded_models || []
     end
 
-    def default_schema
-      @default_schema || 'public' # TODO: 'public' is postgres specific
-    end
-
     def parallel_migration_threads
       @parallel_migration_threads || 0
     end
-    alias default_tenant default_schema
-    alias default_tenant= default_schema=
 
     def persistent_schemas
       @persistent_schemas || []
@@ -89,7 +105,9 @@ module Apartment
 
     # Reset all the config for Apartment
     def reset
-      (ACCESSOR_METHODS + WRITER_METHODS).each { |method| remove_instance_variable(:"@#{method}") if instance_variable_defined?(:"@#{method}") }
+      (ACCESSOR_METHODS + WRITER_METHODS).each do |method|
+        remove_instance_variable(:"@#{method}") if instance_variable_defined?(:"@#{method}")
+      end
     end
 
     def extract_tenant_config

data/lib/apartment/active_record/connection_handling.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionHandling
+    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)
+      end
+    end
+
+    alias connected_to_without_tenant connected_to
+    alias connected_to connected_to_with_tenant
+  end
+end

data/lib/apartment/active_record/internal_metadata.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# rubocop:disable Rails/ApplicationRecord
+class InternalMetadata < ActiveRecord::Base # :nodoc:
+  class << self
+    def table_exists?
+      connection.table_exists?(table_name)
+    end
+  end
+end
+# rubocop:enable Rails/ApplicationRecord

data/lib/apartment/active_record/log_subscriber.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  class LogSubscriber
+    def apartment_log
+      return unless Apartment.active_record_log
+
+      database = color("[#{Apartment.connection.current_database}] ", ActiveSupport::LogSubscriber::MAGENTA, true)
+      schema = nil
+      schema = color("[#{Apartment.connection.schema_search_path.tr('"', '')}] ", ActiveSupport::LogSubscriber::YELLOW, true) unless Apartment.connection.schema_search_path.nil?
+      "#{database}#{schema}"
+    end
+
+    def payload_binds(binds, type_casted_binds)
+      return unless (binds || []).empty?
+
+      casted_params = type_casted_binds(type_casted_binds)
+      binds = '  ' + binds.zip(casted_params).map { |attr, value| render_bind(attr, value) }.inspect
+      binds
+    end
+
+    def sql(event)
+      self.class.runtime += event.duration
+      return unless logger.debug?
+
+      payload = event.payload
+
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+      name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+      name  = "CACHE #{name}" if payload[:cached]
+      sql = payload[:sql]
+      binds = payload_binds(payload[:binds], payload[:type_casted_binds])
+
+      name = colorize_payload_name(name, payload[:name])
+      sql  = color(sql, sql_color(sql), true) if colorize_logging
+
+      debug "    #{apartment_log}#{name} #{sql}#{binds}"
+    end
+  end
+end

data/lib/apartment/active_record/schema_migration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  # rubocop:disable Rails/ApplicationRecord
+  class SchemaMigration < ActiveRecord::Base # :nodoc:
+    class << self
+      def table_exists?
+        connection.table_exists?(table_name)
+      end
+    end
+  end
+  # rubocop:enable Rails/ApplicationRecord
+end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -35,6 +35,12 @@ module Apartment
         end
       end
 
+      #   Initialize Apartment config options such as excluded_models
+      #
+      def init
+        process_excluded_models
+      end
+
       #   Note alias_method here doesn't work with inheritence apparently ??
       #
       def current
@@ -48,7 +54,6 @@ module Apartment
       def default_tenant
         @default_tenant || Apartment.default_tenant
       end
-      alias default_schema default_tenant # TODO: deprecate default_schema
 
       #   Drop the tenant
       #
@@ -68,8 +73,6 @@ module Apartment
       #
       def switch!(tenant = nil)
         run_callbacks :switch do
-          return reset if tenant.nil?
-
           connect_to_new(tenant).tap do
             Apartment.connection.clear_query_cache
           end
@@ -103,7 +106,8 @@ module Apartment
       #   Establish a new connection for each specific excluded model
       #
       def process_excluded_models
-        # All other models will shared a connection (at Apartment.connection_class) and we can modify at will
+        # All other models will shared a connection (at Apartment.connection_class)
+        # and we can modify at will
         Apartment.excluded_models.each do |excluded_model|
           process_excluded_model(excluded_model)
         end
@@ -129,14 +133,12 @@ module Apartment
       #   @return {String} tenant name with Rails environment *optionally* prepended
       #
       def environmentify(tenant)
-        if !tenant.include?(Rails.env)
-          if Apartment.prepend_environment
-            "#{Rails.env}_#{tenant}"
-          elsif Apartment.append_environment
-            "#{tenant}_#{Rails.env}"
-          else
-            tenant
-          end
+        return tenant if tenant.nil? || tenant.include?(Rails.env)
+
+        if Apartment.prepend_environment
+          "#{Rails.env}_#{tenant}"
+        elsif Apartment.append_environment
+          "#{tenant}_#{Rails.env}"
         else
           tenant
         end
@@ -174,6 +176,8 @@ module Apartment
       #   @param {String} tenant Database name
       #
       def connect_to_new(tenant)
+        return reset if tenant.nil?
+
         query_cache_enabled = ActiveRecord::Base.connection.query_cache_enabled
 
         Apartment.establish_connection multi_tenantify(tenant)
@@ -230,7 +234,7 @@ module Apartment
       end
 
       def db_connection_config(tenant)
-        Apartment.db_config_for(tenant).clone
+        Apartment.db_config_for(tenant).dup
       end
 
       def with_neutral_connection(tenant, &_block)

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -37,12 +37,11 @@ module Apartment
       #
       def connect_to_new(tenant = nil)
         return reset if tenant.nil?
-        # rubocop:disable Style/RaiseArgs
-        raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.all_schemas.include? tenant.to_s
 
-        # rubocop:enable Style/RaiseArgs
+        tenant = tenant.to_s
+        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless tenant_exists?(tenant)
 
-        @current = tenant.to_s
+        @current = tenant
         Apartment.connection.schema_search_path = full_search_path
       rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
         raise TenantNotFound, "One of the following schema(s) is invalid: #{full_search_path}"
@@ -50,6 +49,12 @@ module Apartment
 
       private
 
+      def tenant_exists?(tenant)
+        return true unless Apartment.tenant_presence_check
+
+        Apartment.connection.all_schemas.include? tenant
+      end
+
       def rescue_from
         ActiveRecord::JDBCError
       end