ros-apartment 2.3.0 → 2.4.0

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
@@ -45,7 +48,7 @@ module Apartment
       def default_tenant
         @default_tenant || Apartment.default_tenant
       end
-      alias :default_schema :default_tenant # TODO deprecate default_schema
+      alias default_schema default_tenant # TODO: deprecate default_schema
 
       #   Drop the tenant
       #
@@ -55,9 +58,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
@@ -79,13 +81,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,7 +96,7 @@ module Apartment
       #
       def each(tenants = Apartment.tenant_names)
         tenants.each do |tenant|
-          switch(tenant){ yield tenant }
+          switch(tenant) { yield tenant }
         end
       end
 
@@ -116,9 +119,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,7 +129,7 @@ module Apartment
       #   @return {String} tenant name with Rails environment *optionally* prepended
       #
       def environmentify(tenant)
-        unless tenant.include?(Rails.env)
+        if !tenant.include?(Rails.env)
           if Apartment.prepend_environment
             "#{Rails.env}_#{tenant}"
           elsif Apartment.append_environment
@@ -139,7 +142,7 @@ module Apartment
         end
       end
 
-    protected
+      protected
 
       def process_excluded_model(excluded_model)
         excluded_model.constantize.establish_connection @config
@@ -158,8 +161,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)
@@ -174,18 +177,18 @@ module Apartment
         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 +199,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 +210,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
       #
@@ -234,7 +233,7 @@ module Apartment
         Apartment.db_config_for(tenant).clone
       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 +250,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,22 @@ 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?
+        # 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
+
         @current = 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 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
@@ -40,7 +42,7 @@ module Apartment
         Apartment.connection.execute "use `#{default_tenant}`"
       end
 
-    protected
+      protected
 
       #   Connect to new tenant
       #
@@ -48,10 +50,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,9 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
   module Tenant
-
     def self.postgresql_adapter(config)
       adapter = Adapters::PostgresqlAdapter
       adapter = Adapters::PostgresqlSchemaAdapter if Apartment.use_schemas
@@ -14,8 +15,7 @@ module Apartment
   module Adapters
     # Default adapter when not using Postgresql Schemas
     class PostgresqlAdapter < AbstractAdapter
-
-    private
+      private
 
       def rescue_from
         PG::Error
@@ -24,7 +24,6 @@ module Apartment
 
     # Separate Adapter for Postgresql when using schemas
     class PostgresqlSchemaAdapter < AbstractAdapter
-
       def initialize(config)
         super
 
@@ -44,7 +43,7 @@ module Apartment
         @current || default_tenant
       end
 
-    protected
+      protected
 
       def process_excluded_model(excluded_model)
         excluded_model.constantize.tap do |klass|
@@ -56,39 +55,39 @@ 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?
+        # rubocop:disable Style/RaiseArgs
         raise ActiveRecord::StatementInvalid.new("Could not find schema #{tenant}") unless Apartment.connection.schema_exists?(tenant.to_s)
 
+        # rubocop:enable Style/RaiseArgs
+
         @current = 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
-
+        Apartment.connection.clear_cache! if postgresql_version < 90_300
       rescue *rescuable_exceptions
         raise TenantNotFound, "One of the following schema(s) is invalid: \"#{tenant}\" #{full_search_path}"
       end
 
-    private
+      private
 
       def create_tenant_command(conn, tenant)
-        conn.execute(%{CREATE SCHEMA "#{tenant}"})
+        conn.execute(%(CREATE SCHEMA "#{tenant}"))
       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
@@ -104,16 +103,15 @@ module Apartment
 
     # 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
         /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 +120,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 +151,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)
@@ -176,7 +173,10 @@ module Apartment
       # 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']
+        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]
@@ -185,7 +185,10 @@ module Apartment
 
         block.call
       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 +200,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 +210,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 +218,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

data/lib/apartment/adapters/sqlite3_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
@@ -16,8 +18,10 @@ module Apartment
       end
 
       def drop(tenant)
-        raise TenantNotFound,
-          "The tenant #{environmentify(tenant)} cannot be found." unless File.exists?(database_file(tenant))
+        unless File.exist?(database_file(tenant))
+          raise TenantNotFound,
+                "The tenant #{environmentify(tenant)} cannot be found."
+        end
 
         File.delete(database_file(tenant))
       end
@@ -26,18 +30,22 @@ module Apartment
         File.basename(Apartment.connection.instance_variable_get(:@config)[:database], '.sqlite3')
       end
 
-    protected
+      protected
 
       def connect_to_new(tenant)
-        raise TenantNotFound,
-          "The tenant #{environmentify(tenant)} cannot be found." unless File.exists?(database_file(tenant))
+        unless File.exist?(database_file(tenant))
+          raise TenantNotFound,
+                "The tenant #{environmentify(tenant)} cannot be found."
+        end
 
         super database_file(tenant)
       end
 
       def create_tenant(tenant)
-        raise TenantExists,
-          "The tenant #{environmentify(tenant)} already exists." if File.exists?(database_file(tenant))
+        if File.exist?(database_file(tenant))
+          raise TenantExists,
+                "The tenant #{environmentify(tenant)} already exists."
+        end
 
         begin
           f = File.new(database_file(tenant), File::CREAT)
@@ -46,7 +54,7 @@ module Apartment
         end
       end
 
-    private
+      private
 
       def database_file(tenant)
         "#{@default_dir}/#{environmentify(tenant)}.sqlite3"

data/lib/apartment/console.rb

@@ -1,12 +1,37 @@
+# frozen_string_literal: true
+
 # A workaraound 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
-def reload!(print=true)
-  puts "Reloading..." if print
+def reload!(print = true)
+  # rubocop:disable Rails/Output
+  puts 'Reloading...' if print
+  # rubocop:enable Rails/Output
+
   # This triggers the to_prepare callbacks
-  ActionDispatch::Callbacks.new(Proc.new {}).call({})
+  ActionDispatch::Callbacks.new(proc {}).call({})
   # Manually init Apartment again once classes are reloaded
   Apartment::Tenant.init
   true
 end
+
+def st(schema_name = nil)
+  if schema_name.nil?
+    # rubocop:disable Rails/Output
+    tenant_list.each { |t| puts t }
+    # rubocop:enable Rails/Output
+  elsif tenant_list.include? schema_name
+    Apartment::Tenant.switch!(schema_name)
+  else
+    # rubocop:disable Rails/Output
+    puts "Tenant #{schema_name} is not part of the tenant list"
+    # rubocop:enable Rails/Output
+  end
+end
+
+def tenant_list
+  tenant_list = [Apartment.default_tenant]
+  tenant_list += Apartment.tenant_names
+  tenant_list.uniq
+end

data/lib/apartment/custom_console.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Apartment
+  module CustomConsole
+    begin
+      require 'pry-rails'
+    rescue LoadError
+      # rubocop:disable Rails/Output
+      puts '[Failed to load pry-rails] If you want to use Apartment custom prompt you need to add pry-rails to your gemfile'
+      # rubocop:enable Rails/Output
+    end
+
+    if Pry::Prompt.respond_to?(:add)
+      desc = "Includes the current Rails environment and project folder name.\n" \
+            '[1] [project_name][Rails.env][Apartment::Tenant.current] pry(main)>'
+
+      Pry::Prompt.add 'ros', desc, %w[> *] do |target_self, nest_level, pry, sep|
+        "[#{pry.input_ring.size}] [#{PryRails::Prompt.formatted_env}][#{Apartment::Tenant.current}] " \
+        "#{pry.config.prompt_name}(#{Pry.view_clip(target_self)})" \
+        "#{":#{nest_level}" unless nest_level.zero?}#{sep} "
+      end
+
+      Pry.config.prompt = Pry::Prompt[:ros][:value]
+    end
+  end
+end

data/lib/apartment/deprecation.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'active_support/deprecation'
 
 module Apartment
   module Deprecation
-
     def self.warn(message)
       ActiveSupport::Deprecation.warn message
     end