ros-apartment 2.3.0 → 2.7.0

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

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Apartment
   module Adapters
+    # rubocop:disable Metrics/ClassLength
     class AbstractAdapter
       include ActiveSupport::Callbacks
       define_callbacks :create, :switch
@@ -32,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
@@ -45,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
       #
@@ -55,9 +63,8 @@ module Apartment
         with_neutral_connection(tenant) do |conn|
           drop_command(conn, tenant)
         end
-
-      rescue *rescuable_exceptions => exception
-        raise_drop_tenant_error!(tenant, exception)
+      rescue *rescuable_exceptions => e
+        raise_drop_tenant_error!(tenant, e)
       end
 
       #   Switch to a new tenant
@@ -66,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
@@ -79,13 +84,14 @@ module Apartment
       #   @param {String?} tenant to connect to
       #
       def switch(tenant = nil)
+        previous_tenant = current
+        switch!(tenant)
+        yield
+      ensure
         begin
-          previous_tenant = current
-          switch!(tenant)
-          yield
-
-        ensure
-          switch!(previous_tenant) rescue reset
+          switch!(previous_tenant)
+        rescue StandardError => _e
+          reset
         end
       end
 
@@ -93,14 +99,15 @@ module Apartment
       #
       def each(tenants = Apartment.tenant_names)
         tenants.each do |tenant|
-          switch(tenant){ yield tenant }
+          switch(tenant) { yield tenant }
         end
       end
 
       #   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
@@ -116,9 +123,9 @@ module Apartment
       #
       def seed_data
         # Don't log the output of seeding the db
-        silence_warnings{ load_or_raise(Apartment.seed_data_file) } if Apartment.seed_data_file
+        silence_warnings { load_or_raise(Apartment.seed_data_file) } if Apartment.seed_data_file
       end
-      alias_method :seed, :seed_data
+      alias seed seed_data
 
       #   Prepend the environment if configured and the environment isn't already there
       #
@@ -126,20 +133,18 @@ module Apartment
       #   @return {String} tenant name with Rails environment *optionally* prepended
       #
       def environmentify(tenant)
-        unless 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
       end
 
-    protected
+      protected
 
       def process_excluded_model(excluded_model)
         excluded_model.constantize.establish_connection @config
@@ -158,8 +163,8 @@ module Apartment
         with_neutral_connection(tenant) do |conn|
           create_tenant_command(conn, tenant)
         end
-      rescue *rescuable_exceptions => exception
-        raise_create_tenant_error!(tenant, exception)
+      rescue *rescuable_exceptions => e
+        raise_create_tenant_error!(tenant, e)
       end
 
       def create_tenant_command(conn, tenant)
@@ -171,21 +176,23 @@ 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)
-        Apartment.connection.active?   # call active? to manually check if this connection is valid
+        Apartment.connection.active? # call active? to manually check if this connection is valid
 
         Apartment.connection.enable_query_cache! if query_cache_enabled
-      rescue *rescuable_exceptions => exception
+      rescue *rescuable_exceptions => e
         Apartment::Tenant.reset if reset_on_connection_exception?
-        raise_connect_error!(tenant, exception)
+        raise_connect_error!(tenant, e)
       end
 
       #   Import the database schema
       #
       def import_database_schema
-        ActiveRecord::Schema.verbose = false    # do not log schema load output.
+        ActiveRecord::Schema.verbose = false # do not log schema load output.
 
         load_or_raise(Apartment.database_schema_file) if Apartment.database_schema_file
       end
@@ -196,9 +203,7 @@ module Apartment
       #                                   if false, use the default db name from the db
       def multi_tenantify(tenant, with_database = true)
         db_connection_config(tenant).tap do |config|
-          if with_database
-            multi_tenantify_with_tenant_db_name(config, tenant)
-          end
+          multi_tenantify_with_tenant_db_name(config, tenant) if with_database
         end
       end
 
@@ -209,14 +214,12 @@ module Apartment
       #   Load a file or raise error if it doesn't exists
       #
       def load_or_raise(file)
-        if File.exists?(file)
-          load(file)
-        else
-          raise FileNotFound, "#{file} doesn't exist yet"
-        end
+        raise FileNotFound, "#{file} doesn't exist yet" unless File.exist?(file)
+
+        load(file)
       end
       # Backward compatibility
-      alias_method :load_or_abort, :load_or_raise
+      alias load_or_abort load_or_raise
 
       #   Exceptions to rescue from on db operations
       #
@@ -231,10 +234,10 @@ 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)
+      def with_neutral_connection(tenant, &_block)
         if Apartment.with_multi_server_setup
           # neutral connection is necessary whenever you need to create/remove a database from a server.
           # example: when you use postgresql, you need to connect to the default postgresql database before you create your own.
@@ -251,19 +254,20 @@ module Apartment
       end
 
       def raise_drop_tenant_error!(tenant, exception)
-        raise TenantNotFound, "Error while dropping tenant #{environmentify(tenant)}: #{ exception.message }"
+        raise TenantNotFound, "Error while dropping tenant #{environmentify(tenant)}: #{exception.message}"
       end
 
       def raise_create_tenant_error!(tenant, exception)
-        raise TenantExists, "Error while creating tenant #{environmentify(tenant)}: #{ exception.message }"
+        raise TenantExists, "Error while creating tenant #{environmentify(tenant)}: #{exception.message}"
       end
 
       def raise_connect_error!(tenant, exception)
-        raise TenantNotFound, "Error while connecting to tenant #{environmentify(tenant)}: #{ exception.message }"
+        raise TenantNotFound, "Error while connecting to tenant #{environmentify(tenant)}: #{exception.message}"
       end
 
       class SeparateDbConnectionHandler < ::ActiveRecord::Base
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/apartment/adapters/abstract_jdbc_adapter.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
   module Adapters
     class AbstractJDBCAdapter < AbstractAdapter
-
-    private
+      private
 
       def multi_tenantify_with_tenant_db_name(config, tenant)
-        config[:url] = "#{config[:url].gsub(/(\S+)\/.+$/, '\1')}/#{environmentify(tenant)}"
+        config[:url] = "#{config[:url].gsub(%r{(\S+)\/.+$}, '\1')}/#{environmentify(tenant)}"
       end
 
       def rescue_from

data/lib/apartment/adapters/jdbc_mysql_adapter.rb

@@ -1,7 +1,8 @@
-require "apartment/adapters/abstract_jdbc_adapter"
+# frozen_string_literal: true
 
-module Apartment
+require 'apartment/adapters/abstract_jdbc_adapter'
 
+module Apartment
   module Tenant
     def self.jdbc_mysql_adapter(config)
       Adapters::JDBCMysqlAdapter.new config
@@ -10,7 +11,6 @@ module Apartment
 
   module Adapters
     class JDBCMysqlAdapter < AbstractJDBCAdapter
-
       def reset_on_connection_exception?
         true
       end

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -1,28 +1,29 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/postgresql_adapter'
 
 module Apartment
   module Tenant
-
     def self.jdbc_postgresql_adapter(config)
-      Apartment.use_schemas ?
-        Adapters::JDBCPostgresqlSchemaAdapter.new(config) :
+      if Apartment.use_schemas
+        Adapters::JDBCPostgresqlSchemaAdapter.new(config)
+      else
         Adapters::JDBCPostgresqlAdapter.new(config)
+      end
     end
   end
 
   module Adapters
-
     # Default adapter when not using Postgresql Schemas
     class JDBCPostgresqlAdapter < PostgresqlAdapter
-
-    private
+      private
 
       def multi_tenantify_with_tenant_db_name(config, tenant)
-        config[:url] = "#{config[:url].gsub(/(\S+)\/.+$/, '\1')}/#{environmentify(tenant)}"
+        config[:url] = "#{config[:url].gsub(%r{(\S+)\/.+$}, '\1')}/#{environmentify(tenant)}"
       end
 
       def create_tenant_command(conn, tenant)
-        conn.create_database(environmentify(tenant), { :thisisahack => '' })
+        conn.create_database(environmentify(tenant), thisisahack: '')
       end
 
       def rescue_from
@@ -32,21 +33,27 @@ module Apartment
 
     # Separate Adapter for Postgresql when using schemas
     class JDBCPostgresqlSchemaAdapter < PostgresqlSchemaAdapter
-
       #   Set schema search path to new schema
       #
       def connect_to_new(tenant = nil)
         return reset if tenant.nil?
-        raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.all_schemas.include? tenant.to_s
 
-        @current = tenant.to_s
-        Apartment.connection.schema_search_path = full_search_path
+        tenant = tenant.to_s
+        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless tenant_exists?(tenant)
 
+        @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}"
       end
 
-    private
+      private
+
+      def tenant_exists?(tenant)
+        return true unless Apartment.tenant_presence_check
+
+        Apartment.connection.all_schemas.include? tenant
+      end
 
       def rescue_from
         ActiveRecord::JDBCError

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
   module Tenant
-
     def self.mysql2_adapter(config)
-      Apartment.use_schemas ?
-        Adapters::Mysql2SchemaAdapter.new(config) :
+      if Apartment.use_schemas
+        Adapters::Mysql2SchemaAdapter.new(config)
+      else
         Adapters::Mysql2Adapter.new(config)
+      end
     end
   end
 
   module Adapters
     class Mysql2Adapter < AbstractAdapter
-
       def initialize(config)
         super
 
         @default_tenant = config[:database]
       end
 
-    protected
+      protected
 
       def rescue_from
         Mysql2::Error
@@ -37,10 +39,12 @@ module Apartment
       #   Reset current tenant to the default_tenant
       #
       def reset
+        return unless default_tenant
+
         Apartment.connection.execute "use `#{default_tenant}`"
       end
 
-    protected
+      protected
 
       #   Connect to new tenant
       #
@@ -48,10 +52,9 @@ module Apartment
         return reset if tenant.nil?
 
         Apartment.connection.execute "use `#{environmentify(tenant)}`"
-
-      rescue ActiveRecord::StatementInvalid => exception
+      rescue ActiveRecord::StatementInvalid => e
         Apartment::Tenant.reset
-        raise_connect_error!(tenant, exception)
+        raise_connect_error!(tenant, e)
       end
 
       def process_excluded_model(model)