ros-apartment 2.3.0 → 2.7.0

data/lib/apartment/elevators/host.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/elevators/generic'
 
 module Apartment
@@ -16,15 +18,18 @@ module Apartment
         @ignored_first_subdomains ||= []
       end
 
+      # rubocop:disable Style/TrivialAccessors
       def self.ignored_first_subdomains=(arg)
         @ignored_first_subdomains = arg
       end
+      # rubocop:enable Style/TrivialAccessors
 
       def parse_tenant_name(request)
         return nil if request.host.blank?
+
         parts = request.host.split('.')
         self.class.ignored_first_subdomains.include?(parts[0]) ? parts.drop(1).join('.') : request.host
       end
     end
   end
-end
+end

data/lib/apartment/elevators/host_hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/elevators/generic'
 
 module Apartment
@@ -12,8 +14,10 @@ module Apartment
       end
 
       def parse_tenant_name(request)
-        raise TenantNotFound,
-          "Cannot find tenant for host #{request.host}" unless @hash.has_key?(request.host)
+        unless @hash.key?(request.host)
+          raise TenantNotFound,
+                "Cannot find tenant for host #{request.host}"
+        end
 
         @hash[request.host]
       end

data/lib/apartment/elevators/subdomain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/elevators/generic'
 require 'public_suffix'
 
@@ -11,9 +13,11 @@ module Apartment
         @excluded_subdomains ||= []
       end
 
+      # rubocop:disable Style/TrivialAccessors
       def self.excluded_subdomains=(arg)
         @excluded_subdomains = arg
       end
+      # rubocop:enable Style/TrivialAccessors
 
       def parse_tenant_name(request)
         request_subdomain = subdomain(request.host)
@@ -21,15 +25,15 @@ module Apartment
         # If the domain acquired is set to be excluded, set the tenant to whatever is currently
         # next in line in the schema search path.
         tenant = if self.class.excluded_subdomains.include?(request_subdomain)
-          nil
-        else
-          request_subdomain
-        end
+                   nil
+                 else
+                   request_subdomain
+                 end
 
         tenant.presence
       end
 
-    protected
+      protected
 
       # *Almost* a direct ripoff of ActionDispatch::Request subdomain methods
 

data/lib/apartment/migrator.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 require 'apartment/tenant'
 
 module Apartment
   module Migrator
-
     extend self
 
     # Migrate to latest
     def migrate(database)
       Tenant.switch(database) do
-        version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+        version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
 
-        migration_scope_block = -> (migration) { ENV["SCOPE"].blank? || (ENV["SCOPE"] == migration.scope) }
+        migration_scope_block = ->(migration) { ENV['SCOPE'].blank? || (ENV['SCOPE'] == migration.scope) }
 
         if activerecord_below_5_2?
           ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, version, &migration_scope_block)

data/lib/apartment/model.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Apartment
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # NOTE: key can either be an array of symbols or a single value.
+      # E.g. If we run the following query:
+      # `Setting.find_by(key: 'something', value: 'amazing')` key will have an array of symbols: `[:key, :something]`
+      # while if we run:
+      # `Setting.find(10)` key will have the value 'id'
+      def cached_find_by_statement(key, &block)
+        # Modifying the cache key to have a reference to the current tenant,
+        # so the cached statement is referring only to the tenant in which we've
+        # executed this
+        cache_key = if key.is_a? String
+                      "#{Apartment::Tenant.current}_#{key}"
+                    else
+                      [Apartment::Tenant.current] + key
+                    end
+        cache = @find_by_statement_cache[connection.prepared_statements]
+        cache.compute_if_absent(cache_key) { ActiveRecord::StatementCache.create(connection, &block) }
+      end
+    end
+  end
+end

data/lib/apartment/railtie.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'apartment/tenant'
 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
@@ -17,27 +18,35 @@ module Apartment
         config.seed_after_create = false
         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
     end
 
-    #   Hook into ActionDispatch::Reloader to ensure Apartment is properly initialized
-    #   Note that this doens't entirely work as expected in Development, because this is called before classes are reloaded
-    #   See the middleware/console declarations below to help with this. Hope to fix that soon.
-    #
+    # Make sure Apartment is reconfigured when the code is reloaded
     config.to_prepare do
-      next if ARGV.any? { |arg| arg =~ /\Aassets:(?:precompile|clean)\z/ }
+      Apartment::Tenant.reinitialize
+    end
 
-      begin
-        Apartment.connection_class.connection_pool.with_connection do
-          Apartment::Tenant.init
+    #
+    # Ensure that Apartment::Tenant.init is called when
+    # a new connection is requested.
+    #
+    module ApartmentInitializer
+      def connection
+        super.tap do
+          Apartment::Tenant.init_once
         end
-      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.
+      end
+
+      def arel_table
+        Apartment::Tenant.init_once
+        super
       end
     end
+    ActiveRecord::Base.singleton_class.prepend ApartmentInitializer
 
     #
     #   Ensure rake tasks are loaded
@@ -48,8 +57,10 @@ 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?
 
@@ -58,7 +69,8 @@ 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/reloader.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Apartment
   class Reloader
-
     #   Middleware used in development to init Apartment for each request
     #   Necessary due to code reload (annoying).  When models are reloaded, they no longer have the proper table_name
     #   That is prepended with the schema (if using postgresql schemas)

data/lib/apartment/tasks/enhancements.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 # Require this file to append Apartment rake tasks to ActiveRecord db rake tasks
 # Enabled by default in the initializer
 
 module Apartment
   class RakeTaskEnhancer
-
     module TASKS
-      ENHANCE_BEFORE = %w(db:drop)
-      ENHANCE_AFTER  = %w(db:migrate db:rollback db:migrate:up db:migrate:down db:migrate:redo db:seed)
+      ENHANCE_BEFORE = %w[db:drop].freeze
+      ENHANCE_AFTER  = %w[db:create db:migrate db:rollback db:migrate:up db:migrate:down db:migrate:redo db:seed].freeze
       freeze
     end
 
@@ -28,7 +29,6 @@ module Apartment
           task = Rake::Task[name]
           enhance_after_task(task)
         end
-
       end
 
       def should_enhance?
@@ -48,9 +48,7 @@ module Apartment
       def inserted_task_name(task)
         task.name.sub(/db:/, 'apartment:')
       end
-
     end
-
   end
 end
 

data/lib/apartment/tasks/task_helper.rb

@@ -0,0 +1,35 @@
+# 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'
+
+      # rubocop:disable Rails/Output
+      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
+      # rubocop:enable Rails/Output
+    end
+  end
+end

data/lib/apartment/tenant.rb

@@ -1,21 +1,32 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Apartment
   #   The main entry point to Apartment functions
   #
   module Tenant
-
     extend self
     extend Forwardable
 
-    def_delegators :adapter, :create, :drop, :switch, :switch!, :current, :each, :reset, :set_callback, :seed, :current_tenant, :default_tenant, :environmentify
+    def_delegators :adapter, :create, :drop, :switch, :switch!, :current, :each,
+                   :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
+    def init_once
+      return if @already_initialized
+
+      # To avoid infinite loops in work init is doing,
+      # we need to set @already_initialized to true
+      # before init is called
+      @already_initialized = true
+      init
+    end
+
+    def reinitialize
+      @already_initialized = false
     end
 
     #   Fetch the proper multi-tenant adapter based on Rails config
@@ -40,9 +51,7 @@ module Apartment
           raise "The adapter `#{adapter_method}` is not yet supported"
         end
 
-        unless respond_to?(adapter_method)
-          raise AdapterNotFound, "database configuration specifies nonexistent #{config[:adapter]} adapter"
-        end
+        raise AdapterNotFound, "database configuration specifies nonexistent #{config[:adapter]} adapter" unless respond_to?(adapter_method)
 
         send(adapter_method, config)
       end
@@ -52,6 +61,7 @@ module Apartment
     #
     def reload!(config = nil)
       Thread.current[:apartment_adapter] = nil
+      reinitialize
       @config = config
     end
 

data/lib/apartment/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Apartment
-  VERSION = "2.3.0"
+  VERSION = '2.7.0'
 end

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

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Apartment
   class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     def copy_files
-      template "apartment.rb", File.join("config", "initializers", "apartment.rb")
+      template 'apartment.rb', File.join('config', 'initializers', 'apartment.rb')
     end
-
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # You can have Apartment route to the appropriate Tenant by adding some Rack middleware.
 # Apartment can support many different "Elevators" that can take care of this routing to your data.
 # Require whichever Elevator you're using below or none if you have a custom one.
@@ -12,7 +14,6 @@ require 'apartment/elevators/subdomain'
 # Apartment Configuration
 #
 Apartment.configure do |config|
-
   # Add any models that you do not want to be multi-tenanted, but remain in the global (public) namespace.
   # A typical example would be a Customer or Tenant model that stores each Tenant's information.
   #
@@ -48,7 +49,7 @@ Apartment.configure do |config|
   #   end
   # end
   #
-  config.tenant_names = lambda { ToDo_Tenant_Or_User_Model.pluck :database }
+  config.tenant_names = -> { ToDo_Tenant_Or_User_Model.pluck :database }
 
   # PostgreSQL:
   #   Specifies whether to use PostgreSQL schemas or create a new database per Tenant.
@@ -95,6 +96,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,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'apartment/migrator'
+require 'apartment/tasks/task_helper'
 require 'parallel'
 
 apartment_namespace = namespace :apartment do
-
-  desc "Create all tenants"
+  desc 'Create all tenants'
   task :create do
-    tenants.each do |tenant|
+    Apartment::TaskHelper.tenants.each do |tenant|
       begin
         puts("Creating #{tenant} tenant")
         Apartment::Tenant.create(tenant)
@@ -15,22 +17,22 @@ apartment_namespace = namespace :apartment do
     end
   end
 
-  desc "Drop all tenants"
+  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)
-      rescue Apartment::TenantNotFound => e
+      rescue Apartment::TenantNotFound, ActiveRecord::NoDatabaseError => e
         puts e.message
       end
     end
   end
 
-  desc "Migrate all tenants"
+  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
         puts("Migrating #{tenant} tenant")
         Apartment::Migrator.migrate tenant
@@ -40,11 +42,11 @@ apartment_namespace = namespace :apartment do
     end
   end
 
-  desc "Seed all tenants"
+  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
         puts("Seeding #{tenant} tenant")
         Apartment::Tenant.switch(tenant) do
@@ -56,13 +58,13 @@ apartment_namespace = namespace :apartment do
     end
   end
 
-  desc "Rolls the migration back to the previous version (specify steps w/ STEP=n) across all tenants."
+  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
@@ -75,12 +77,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
@@ -92,12 +94,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
@@ -107,7 +109,7 @@ apartment_namespace = namespace :apartment do
       end
     end
 
-    desc  'Rolls back the tenant one migration and re migrate up (options: STEP=x, VERSION=x).'
+    desc 'Rolls back the tenant one migration and re migrate up (options: STEP=x, VERSION=x).'
     task :redo do
       if ENV['VERSION']
         apartment_namespace['migrate:down'].invoke
@@ -118,28 +120,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 { |s| s.strip } : Apartment.tenant_names || []
-  end
-
-  def warn_if_tenants_empty
-    if 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
 end