ros-apartment 2.3.0 → 2.11.0

data/lib/apartment/adapters/abstract_adapter.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Apartment
   module Adapters
+    # Abstract adapter from which all the Apartment DB related adapters will inherit the base logic
     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
@@ -194,13 +201,13 @@ module Apartment
       #   @param {String}  tenant: Database name
       #   @param {Boolean} with_database: if true, use the actual tenant's db name
       #                                   if false, use the default db name from the db
+      # rubocop:disable Style/OptionalBooleanParameter
       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
+      # rubocop:enable Style/OptionalBooleanParameter
 
       def multi_tenantify_with_tenant_db_name(config, tenant)
         config[:database] = environmentify(tenant)
@@ -209,14 +216,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,13 +236,14 @@ 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.
+          # example: when you use postgresql, you need to connect to the default postgresql database before you create
+          # your own.
           SeparateDbConnectionHandler.establish_connection(multi_tenantify(tenant, false))
           yield(SeparateDbConnectionHandler.connection)
           SeparateDbConnectionHandler.connection.close
@@ -251,15 +257,15 @@ 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

data/lib/apartment/adapters/abstract_jdbc_adapter.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
   module Adapters
+    # JDBC Abstract adapter
     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,30 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/postgresql_adapter'
 
 module Apartment
+  # JDBC helper to decide wether to use JDBC Postgresql Adapter or JDBC Postgresql Adapter with Schemas
   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 +34,25 @@ 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
+        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless schema_exists?(tenant)
 
-        @current = tenant.to_s
+        @current = tenant.is_a?(Array) ? tenant.map(&:to_s) : tenant.to_s
         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,31 +1,36 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
+  # Helper module to decide wether to use mysql2 adapter or mysql2 adapter with schemas
   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
+    # Mysql2 Adapter
     class Mysql2Adapter < AbstractAdapter
-
       def initialize(config)
         super
 
         @default_tenant = config[:database]
       end
 
-    protected
+      protected
 
       def rescue_from
         Mysql2::Error
       end
     end
 
+    # Mysql2 Schemas Adapter
     class Mysql2SchemaAdapter < AbstractAdapter
       def initialize(config)
         super
@@ -37,10 +42,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 +55,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)

data/lib/apartment/adapters/postgis_adapter.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 # handle postgis adapter as if it were postgresql,
 # only override the adapter_method used for initialization
-require "apartment/adapters/postgresql_adapter"
+require 'apartment/adapters/postgresql_adapter'
 
 module Apartment
   module Tenant
-
     def self.postgis_adapter(config)
       postgresql_adapter(config)
     end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
+require 'apartment/active_record/postgresql_adapter'
 
 module Apartment
   module Tenant
-
     def self.postgresql_adapter(config)
       adapter = Adapters::PostgresqlAdapter
       adapter = Adapters::PostgresqlSchemaAdapter if Apartment.use_schemas
@@ -14,8 +16,7 @@ module Apartment
   module Adapters
     # Default adapter when not using Postgresql Schemas
     class PostgresqlAdapter < AbstractAdapter
-
-    private
+      private
 
       def rescue_from
         PG::Error
@@ -24,13 +25,16 @@ module Apartment
 
     # Separate Adapter for Postgresql when using schemas
     class PostgresqlSchemaAdapter < AbstractAdapter
-
       def initialize(config)
         super
 
         reset
       end
 
+      def default_tenant
+        @default_tenant = Apartment.default_tenant || 'public'
+      end
+
       #   Reset schema search path to the default schema_search_path
       #
       #   @return {String} default schema search path
@@ -40,11 +44,16 @@ module Apartment
         Apartment.connection.schema_search_path = full_search_path
       end
 
+      def init
+        super
+        Apartment.connection.schema_search_path = full_search_path
+      end
+
       def current
         @current || default_tenant
       end
 
-    protected
+      protected
 
       def process_excluded_model(excluded_model)
         excluded_model.constantize.tap do |klass|
@@ -56,39 +65,58 @@ module Apartment
       end
 
       def drop_command(conn, tenant)
-        conn.execute(%{DROP SCHEMA "#{tenant}" CASCADE})
+        conn.execute(%(DROP SCHEMA "#{tenant}" CASCADE))
       end
 
       #   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.schema_exists?(tenant.to_s)
+        raise ActiveRecord::StatementInvalid, "Could not find schema #{tenant}" unless schema_exists?(tenant)
 
-        @current = tenant.to_s
+        @current = tenant.is_a?(Array) ? tenant.map(&:to_s) : tenant.to_s
         Apartment.connection.schema_search_path = full_search_path
 
         # When the PostgreSQL version is < 9.3,
         # there is a issue for prepared statement with changing search_path.
         # https://www.postgresql.org/docs/9.3/static/sql-prepare.html
-        if postgresql_version < 90300
-          Apartment.connection.clear_cache!
-        end
-
-      rescue *rescuable_exceptions
-        raise TenantNotFound, "One of the following schema(s) is invalid: \"#{tenant}\" #{full_search_path}"
+        Apartment.connection.clear_cache! if postgresql_version < 90_300
+      rescue *rescuable_exceptions => e
+        raise_schema_connect_to_new(tenant, e)
       end
 
-    private
+      private
+
+      def tenant_exists?(tenant)
+        return true unless Apartment.tenant_presence_check
+
+        Apartment.connection.schema_exists?(tenant)
+      end
 
       def create_tenant_command(conn, tenant)
-        conn.execute(%{CREATE SCHEMA "#{tenant}"})
+        # NOTE: This was causing some tests to fail because of the database strategy for rspec
+        if ActiveRecord::Base.connection.open_transactions.positive?
+          conn.execute(%(CREATE SCHEMA "#{tenant}"))
+        else
+          schema = %(BEGIN;
+          CREATE SCHEMA "#{tenant}";
+          COMMIT;)
+
+          conn.execute(schema)
+        end
+      rescue *rescuable_exceptions => e
+        rollback_transaction(conn)
+        raise e
+      end
+
+      def rollback_transaction(conn)
+        conn.execute('ROLLBACK;')
       end
 
       #   Generate the final search path to set including persistent_schemas
       #
       def full_search_path
-        persistent_schemas.map(&:inspect).join(", ")
+        persistent_schemas.map(&:inspect).join(', ')
       end
 
       def persistent_schemas
@@ -100,20 +128,33 @@ module Apartment
         # public from Rails 5.0.
         Apartment.connection.send(:postgresql_version)
       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
     class PostgresqlSchemaFromSqlAdapter < PostgresqlSchemaAdapter
-
-      PSQL_DUMP_BLACKLISTED_STATEMENTS= [
+      PSQL_DUMP_BLACKLISTED_STATEMENTS = [
         /SET search_path/i,                           # overridden later
         /SET lock_timeout/i,                          # new in postgresql 9.3
         /SET row_security/i,                          # new in postgresql 9.5
         /SET idle_in_transaction_session_timeout/i,   # new in postgresql 9.6
+        /SET default_table_access_method/i,           # new in postgresql 12
         /CREATE SCHEMA public/i,
-        /COMMENT ON SCHEMA public/i,
+        /COMMENT ON SCHEMA public/i
 
-      ]
+      ].freeze
 
       def import_database_schema
         preserving_search_path do
@@ -122,14 +163,14 @@ module Apartment
         end
       end
 
-    private
+      private
 
       # Re-set search path after the schema is imported.
       # Postgres now sets search path to empty before dumping the schema
       # and it mut be reset
       #
       def preserving_search_path
-        search_path = Apartment.connection.execute("show search_path").first["search_path"]
+        search_path = Apartment.connection.execute('show search_path').first['search_path']
         yield
         Apartment.connection.execute("set search_path = #{search_path}")
       end
@@ -153,7 +194,6 @@ module Apartment
       #   @return {String} raw SQL contaning only postgres schema dump
       #
       def pg_dump_schema
-
         # Skip excluded tables? :/
         # excluded_tables =
         #   collect_table_names(Apartment.excluded_models)
@@ -169,23 +209,31 @@ module Apartment
       #
       #   @return {String} raw SQL contaning inserts with data from schema_migrations
       #
+      # rubocop:disable Layout/LineLength
       def pg_dump_schema_migrations_data
         with_pg_env { `pg_dump -a --inserts -t #{default_tenant}.schema_migrations -t #{default_tenant}.ar_internal_metadata #{dbname}` }
       end
+      # rubocop:enable Layout/LineLength
 
       # Temporary set Postgresql related environment variables if there are in @config
       #
-      def with_pg_env(&block)
-        pghost, pgport, pguser, pgpassword =  ENV['PGHOST'], ENV['PGPORT'], ENV['PGUSER'], ENV['PGPASSWORD']
+      def with_pg_env
+        pghost = ENV['PGHOST']
+        pgport = ENV['PGPORT']
+        pguser = ENV['PGUSER']
+        pgpassword = ENV['PGPASSWORD']
 
         ENV['PGHOST'] = @config[:host] if @config[:host]
         ENV['PGPORT'] = @config[:port].to_s if @config[:port]
         ENV['PGUSER'] = @config[:username].to_s if @config[:username]
         ENV['PGPASSWORD'] = @config[:password].to_s if @config[:password]
 
-        block.call
+        yield
       ensure
-        ENV['PGHOST'], ENV['PGPORT'], ENV['PGUSER'], ENV['PGPASSWORD'] = pghost, pgport, pguser, pgpassword
+        ENV['PGHOST'] = pghost
+        ENV['PGPORT'] = pgport
+        ENV['PGUSER'] = pguser
+        ENV['PGPASSWORD'] = pgpassword
       end
 
       #   Remove "SET search_path ..." line from SQL dump and prepend search_path set to current tenant
@@ -197,7 +245,7 @@ module Apartment
 
         swap_schema_qualifier(sql)
           .split("\n")
-          .select {|line| check_input_against_regexps(line, PSQL_DUMP_BLACKLISTED_STATEMENTS).empty?}
+          .select { |line| check_input_against_regexps(line, PSQL_DUMP_BLACKLISTED_STATEMENTS).empty? }
           .prepend(search_path)
           .join("\n")
       end
@@ -207,7 +255,7 @@ module Apartment
           if Apartment.pg_excluded_names.any? { |name| match.include? name }
             match
           else
-            match.gsub("#{default_tenant}.", %{"#{current}".})
+            match.gsub("#{default_tenant}.", %("#{current}".))
           end
         end
       end
@@ -215,7 +263,7 @@ module Apartment
       #   Checks if any of regexps matches against input
       #
       def check_input_against_regexps(input, regexps)
-        regexps.select {|c| input.match c}
+        regexps.select { |c| input.match c }
       end
 
       #   Collect table names from AR Models