ros-apartment 2.6.0 → 2.8.0

data/lib/apartment/custom_console.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
+require_relative 'console'
+
 module Apartment
   module CustomConsole
     begin
       require 'pry-rails'
     rescue LoadError
-      # rubocop:disable Rails/Output
+      # rubocop:disable Layout/LineLength
       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
+      # rubocop:enable Layout/LineLength
     end
 
     desc = "Includes the current Rails environment and project folder name.\n" \

data/lib/apartment/log_subscriber.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Apartment
+  class LogSubscriber < ActiveRecord::LogSubscriber
+    def sql(event)
+      super(event)
+    end
+
+    private
+
+    def debug(progname = nil, &block)
+      progname = "  #{apartment_log}#{progname}" unless progname.nil?
+
+      super(progname, &block)
+    end
+
+    def apartment_log
+      database = color("[#{Apartment.connection.current_database}] ", ActiveSupport::LogSubscriber::MAGENTA, true)
+      schema = nil
+      unless Apartment.connection.schema_search_path.nil?
+        schema = color("[#{Apartment.connection.schema_search_path.tr('"', '')}] ",
+                       ActiveSupport::LogSubscriber::YELLOW, true)
+      end
+      "#{database}#{schema}"
+    end
+  end
+end

data/lib/apartment/railtie.rb

@@ -6,6 +6,7 @@ require 'apartment/reloader'
 
 module Apartment
   class Railtie < Rails::Railtie
+
     #
     #   Set up our default config options
     #   Do this before the app initializers run so we don't override custom settings
@@ -19,6 +20,7 @@ module Apartment
         config.prepend_environment = false
         config.append_environment = false
         config.tenant_presence_check = true
+        config.active_record_log = false
       end
 
       ActiveRecord::Migrator.migrations_paths = Rails.application.paths['db/migrate'].to_a
@@ -31,17 +33,23 @@ module Apartment
     config.to_prepare do
       next if ARGV.any? { |arg| arg =~ /\Aassets:(?:precompile|clean)\z/ }
       next if ARGV.any? { |arg| arg == 'webpacker:compile' }
+      next if ENV["APARTMENT_DISABLE_INIT"]
 
       begin
         Apartment.connection_class.connection_pool.with_connection do
           Apartment::Tenant.init
         end
-      rescue ::ActiveRecord::NoDatabaseError, PG::ConnectionBad
+      rescue ::ActiveRecord::NoDatabaseError
         # Since `db:create` and other tasks invoke this block from Rails 5.2.0,
         # we need to swallow the error to execute `db:create` properly.
-        Rails.logger.warn do
-          'Failed to initialize Apartment because a database connection could not be established.'
-        end
+      end
+    end
+
+    config.after_initialize do |app|
+      # NOTE: Load the custom log subscriber if enabled
+      if Apartment.active_record_log
+        ActiveSupport::Notifications.unsubscribe 'sql.active_record'
+        Apartment::LogSubscriber.attach_to :active_record
       end
     end
 
@@ -54,10 +62,8 @@ module Apartment
     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
+    #   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?
 
@@ -66,8 +72,7 @@ module Apartment
         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
+      # 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

data/lib/apartment/tasks/task_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Apartment
+  module TaskHelper
+    def self.each_tenant(&block)
+      Parallel.each(tenants_without_default, in_threads: Apartment.parallel_migration_threads) do |tenant|
+        block.call(tenant)
+      end
+    end
+
+    def self.tenants_without_default
+      tenants - [Apartment.default_tenant]
+    end
+
+    def self.tenants
+      ENV['DB'] ? ENV['DB'].split(',').map(&:strip) : Apartment.tenant_names || []
+    end
+
+    def self.warn_if_tenants_empty
+      return unless tenants.empty? && ENV['IGNORE_EMPTY_TENANTS'] != 'true'
+
+      puts <<-WARNING
+        [WARNING] - The list of tenants to migrate appears to be empty. This could mean a few things:
+
+          1. You may not have created any, in which case you can ignore this message
+          2. You've run `apartment:migrate` directly without loading the Rails environment
+            * `apartment:migrate` is now deprecated. Tenants will automatically be migrated with `db:migrate`
+
+        Note that your tenants currently haven't been migrated. You'll need to run `db:migrate` to rectify this.
+      WARNING
+    end
+
+    def self.create_tenant(tenant_name)
+      puts("Creating #{tenant_name} tenant")
+      Apartment::Tenant.create(tenant_name)
+    rescue Apartment::TenantExists => e
+      puts "Tried to create already existing tenant: #{e}"
+    end
+  end
+end

data/lib/apartment/tenant.rb

@@ -10,17 +10,11 @@ module Apartment
     extend Forwardable
 
     def_delegators :adapter, :create, :drop, :switch, :switch!, :current, :each,
-                   :reset, :set_callback, :seed, :current_tenant,
+                   :reset, :init, :set_callback, :seed, :current_tenant,
                    :default_tenant, :environmentify
 
     attr_writer :config
 
-    #   Initialize Apartment config options such as excluded_models
-    #
-    def init
-      adapter.process_excluded_models
-    end
-
     #   Fetch the proper multi-tenant adapter based on Rails config
     #
     #   @return {subclass of Apartment::AbstractAdapter}
@@ -43,7 +37,9 @@ module Apartment
           raise "The adapter `#{adapter_method}` is not yet supported"
         end
 
-        raise AdapterNotFound, "database configuration specifies nonexistent #{config[:adapter]} adapter" unless respond_to?(adapter_method)
+        unless respond_to?(adapter_method)
+          raise AdapterNotFound, "database configuration specifies nonexistent #{config[:adapter]} adapter"
+        end
 
         send(adapter_method, config)
       end

data/lib/apartment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apartment
-  VERSION = '2.6.0'
+  VERSION = '2.8.0'
 end

data/lib/generators/apartment/install/templates/apartment.rb

@@ -23,7 +23,8 @@ Apartment.configure do |config|
   # You can make this dynamic by providing a Proc object to be called on migrations.
   # This object should yield either:
   # - an array of strings representing each Tenant name.
-  # - a hash which keys are tenant names, and values custom db config (must contain all key/values required in database.yml)
+  # - a hash which keys are tenant names, and values custom db config
+  # (must contain all key/values required in database.yml)
   #
   # config.tenant_names = lambda{ Customer.pluck(:tenant_name) }
   # config.tenant_names = ['tenant1', 'tenant2']
@@ -96,6 +97,11 @@ Apartment.configure do |config|
   # the new tenant
   #
   # config.pg_excluded_names = ["uuid_generate_v4"]
+
+  # Specifies whether the database and schema (when using PostgreSQL schemas) will prepend in ActiveRecord log.
+  # Uncomment the line below if you want to enable this behavior.
+  #
+  # config.active_record_log = true
 end
 
 # Setup a custom Tenant switching middleware. The Proc should return the name of the Tenant that

data/lib/tasks/apartment.rake

@@ -1,24 +1,22 @@
 # frozen_string_literal: true
 
 require 'apartment/migrator'
+require 'apartment/tasks/task_helper'
 require 'parallel'
 
 apartment_namespace = namespace :apartment do
   desc 'Create all tenants'
   task :create do
-    tenants.each do |tenant|
-      begin
-        puts("Creating #{tenant} tenant")
-        Apartment::Tenant.create(tenant)
-      rescue Apartment::TenantExists => e
-        puts e.message
-      end
+    Apartment::TaskHelper.warn_if_tenants_empty
+
+    Apartment::TaskHelper.tenants.each do |tenant|
+      Apartment::TaskHelper.create_tenant(tenant)
     end
   end
 
   desc 'Drop all tenants'
   task :drop do
-    tenants.each do |tenant|
+    Apartment::TaskHelper.tenants.each do |tenant|
       begin
         puts("Dropping #{tenant} tenant")
         Apartment::Tenant.drop(tenant)
@@ -30,9 +28,10 @@ apartment_namespace = namespace :apartment do
 
   desc 'Migrate all tenants'
   task :migrate do
-    warn_if_tenants_empty
-    each_tenant do |tenant|
+    Apartment::TaskHelper.warn_if_tenants_empty
+    Apartment::TaskHelper.each_tenant do |tenant|
       begin
+        Apartment::TaskHelper.create_tenant(tenant)
         puts("Migrating #{tenant} tenant")
         Apartment::Migrator.migrate tenant
       rescue Apartment::TenantNotFound => e
@@ -43,10 +42,11 @@ apartment_namespace = namespace :apartment do
 
   desc 'Seed all tenants'
   task :seed do
-    warn_if_tenants_empty
+    Apartment::TaskHelper.warn_if_tenants_empty
 
-    each_tenant do |tenant|
+    Apartment::TaskHelper.each_tenant do |tenant|
       begin
+        Apartment::TaskHelper.create_tenant(tenant)
         puts("Seeding #{tenant} tenant")
         Apartment::Tenant.switch(tenant) do
           Apartment::Tenant.seed
@@ -59,11 +59,11 @@ apartment_namespace = namespace :apartment do
 
   desc 'Rolls the migration back to the previous version (specify steps w/ STEP=n) across all tenants.'
   task :rollback do
-    warn_if_tenants_empty
+    Apartment::TaskHelper.warn_if_tenants_empty
 
     step = ENV['STEP'] ? ENV['STEP'].to_i : 1
 
-    each_tenant do |tenant|
+    Apartment::TaskHelper.each_tenant do |tenant|
       begin
         puts("Rolling back #{tenant} tenant")
         Apartment::Migrator.rollback tenant, step
@@ -76,12 +76,12 @@ apartment_namespace = namespace :apartment do
   namespace :migrate do
     desc 'Runs the "up" for a given migration VERSION across all tenants.'
     task :up do
-      warn_if_tenants_empty
+      Apartment::TaskHelper.warn_if_tenants_empty
 
       version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
       raise 'VERSION is required' unless version
 
-      each_tenant do |tenant|
+      Apartment::TaskHelper.each_tenant do |tenant|
         begin
           puts("Migrating #{tenant} tenant up")
           Apartment::Migrator.run :up, tenant, version
@@ -93,12 +93,12 @@ apartment_namespace = namespace :apartment do
 
     desc 'Runs the "down" for a given migration VERSION across all tenants.'
     task :down do
-      warn_if_tenants_empty
+      Apartment::TaskHelper.warn_if_tenants_empty
 
       version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
       raise 'VERSION is required' unless version
 
-      each_tenant do |tenant|
+      Apartment::TaskHelper.each_tenant do |tenant|
         begin
           puts("Migrating #{tenant} tenant down")
           Apartment::Migrator.run :down, tenant, version
@@ -119,28 +119,4 @@ apartment_namespace = namespace :apartment do
       end
     end
   end
-
-  def each_tenant(&block)
-    Parallel.each(tenants, in_threads: Apartment.parallel_migration_threads) do |tenant|
-      block.call(tenant)
-    end
-  end
-
-  def tenants
-    ENV['DB'] ? ENV['DB'].split(',').map(&:strip) : Apartment.tenant_names || []
-  end
-
-  def warn_if_tenants_empty
-    return unless tenants.empty? && ENV['IGNORE_EMPTY_TENANTS'] != 'true'
-
-    puts <<-WARNING
-      [WARNING] - The list of tenants to migrate appears to be empty. This could mean a few things:
-
-        1. You may not have created any, in which case you can ignore this message
-        2. You've run `apartment:migrate` directly without loading the Rails environment
-          * `apartment:migrate` is now deprecated. Tenants will automatically be migrated with `db:migrate`
-
-      Note that your tenants currently haven't been migrated. You'll need to run `db:migrate` to rectify this.
-    WARNING
-  end
 end

data/{apartment.gemspec → ros-apartment.gemspec}

@@ -27,8 +27,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/rails-on-services/apartment'
   s.licenses = ['MIT']
 
-  # must be >= 3.1.2 due to bug in prepared_statements
-  s.add_dependency 'activerecord',    '>= 5.0.0', '< 6.1'
+  s.add_dependency 'activerecord',    '>= 5.0.0', '< 6.2'
   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'
@@ -36,7 +35,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'appraisal',    '~> 2.2'
   s.add_development_dependency 'bundler',      '>= 1.3', '< 3.0'
   s.add_development_dependency 'capybara',     '~> 2.0'
-  s.add_development_dependency 'rake',         '~> 0.9'
+  s.add_development_dependency 'rake',         '~> 13.0'
   s.add_development_dependency 'rspec',        '~> 3.4'
   s.add_development_dependency 'rspec-rails',  '~> 3.4'
 
@@ -46,7 +45,6 @@ Gem::Specification.new do |s|
     s.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
     s.add_development_dependency 'jdbc-mysql'
     s.add_development_dependency 'jdbc-postgres'
-    s.add_development_dependency 'jruby-openssl'
   else
     s.add_development_dependency 'mysql2',  '~> 0.5'
     s.add_development_dependency 'pg',      '~> 1.2'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ros-apartment
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Ryan Brunner
 - Brad Robertson
 - Rui Baltazar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-12-16 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.1'
+        version: '6.2'
   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.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +140,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -229,7 +229,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE.md"
-- ".github/workflows/.rubocop-linter.yml"
+- ".github/workflows/changelog.yml"
 - ".gitignore"
 - ".pryrc"
 - ".rspec"
@@ -238,13 +238,13 @@ files:
 - ".story_branch.yml"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - HISTORY.md
 - README.md
 - Rakefile
 - TODO.md
-- apartment.gemspec
 - docker-compose.yml
 - gemfiles/rails_4_2.gemfile
 - gemfiles/rails_5_0.gemfile
@@ -273,22 +273,25 @@ files:
 - lib/apartment/elevators/host.rb
 - lib/apartment/elevators/host_hash.rb
 - lib/apartment/elevators/subdomain.rb
+- lib/apartment/log_subscriber.rb
 - 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
 - lib/apartment/version.rb
 - lib/generators/apartment/install/USAGE
 - lib/generators/apartment/install/install_generator.rb
 - lib/generators/apartment/install/templates/apartment.rb
 - lib/tasks/apartment.rake
+- ros-apartment.gemspec
 homepage: https://github.com/rails-on-services/apartment
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -303,8 +306,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A Ruby gem for managing database multitenancy. Apartment Gem drop in replacement
 test_files: []