ros-apartment 2.3.0.alpha1 → 3.1.0

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,24 @@ 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))
+        return reset if tenant.nil?
+
+        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 +56,7 @@ module Apartment
         end
       end
 
-    private
+      private
 
       def database_file(tenant)
         "#{@default_dir}/#{environmentify(tenant)}.sqlite3"

data/lib/apartment/adapters/trilogy_adapter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'apartment/adapters/mysql2_adapter'
+
+module Apartment
+  # Helper module to decide wether to use trilogy adapter or trilogy adapter with schemas
+  module Tenant
+    def self.trilogy_adapter(config)
+      if Apartment.use_schemas
+        Adapters::TrilogySchemaAdapter.new(config)
+      else
+        Adapters::TrilogyAdapter.new(config)
+      end
+    end
+  end
+
+  module Adapters
+    class TrilogyAdapter < Mysql2Adapter
+      protected
+
+      def rescue_from
+        Trilogy::Error
+      end
+    end
+
+    class TrilogySchemaAdapter < Mysql2SchemaAdapter
+    end
+  end
+end

data/lib/apartment/console.rb

@@ -1,12 +1,24 @@
-# 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
-  # This triggers the to_prepare callbacks
-  ActionDispatch::Callbacks.new(Proc.new {}).call({})
-  # Manually init Apartment again once classes are reloaded
-  Apartment::Tenant.init
-  true
+# frozen_string_literal: true
+
+def st(schema_name = nil)
+  if schema_name.nil?
+    tenant_list.each { |t| puts t }
+
+  elsif tenant_list.include? schema_name
+    Apartment::Tenant.switch!(schema_name)
+  else
+    puts "Tenant #{schema_name} is not part of the tenant list"
+
+  end
+end
+
+def tenant_list
+  tenant_list = [Apartment.default_tenant]
+  tenant_list += Apartment.tenant_names
+  tenant_list.uniq
+end
+
+def tenant_info_msg
+  puts "Available Tenants: #{tenant_list}\n"
+  puts "Use `st 'tenant'` to switch tenants & `tenant_list` to see list\n"
 end

data/lib/apartment/custom_console.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'console'
+
+module Apartment
+  module CustomConsole
+    begin
+      require 'pry-rails'
+    rescue LoadError
+      # 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 Layout/LineLength
+    end
+
+    desc = "Includes the current Rails environment and project folder name.\n" \
+          '[1] [project_name][Rails.env][Apartment::Tenant.current] pry(main)>'
+
+    prompt_procs = [
+      proc { |target_self, nest_level, pry| prompt_contents(pry, target_self, nest_level, '>') },
+      proc { |target_self, nest_level, pry| prompt_contents(pry, target_self, nest_level, '*') }
+    ]
+
+    if Gem::Version.new(Pry::VERSION) >= Gem::Version.new('0.13')
+      Pry.config.prompt = Pry::Prompt.new 'ros', desc, prompt_procs
+    else
+      Pry::Prompt.add 'ros', desc, %w[> *] do |target_self, nest_level, pry, sep|
+        prompt_contents(pry, target_self, nest_level, sep)
+      end
+      Pry.config.prompt = Pry::Prompt[:ros][:value]
+    end
+
+    Pry.config.hooks.add_hook(:when_started, 'startup message') do
+      tenant_info_msg
+    end
+
+    def self.prompt_contents(pry, target_self, nest_level, 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
+  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

data/lib/apartment/elevators/domain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/elevators/generic'
 
 module Apartment
@@ -8,14 +10,13 @@ module Apartment
     #   eg. example.com       => example
     #       www.example.bc.ca => example
     #       a.example.bc.ca   => a
-    #       
+    #
     #
     class Domain < Generic
-
       def parse_tenant_name(request)
         return nil if request.host.blank?
 
-        request.host.match(/(www\.)?(?<sld>[^.]*)/)["sld"]
+        request.host.match(/(www\.)?(?<sld>[^.]*)/)['sld']
       end
     end
   end

data/lib/apartment/elevators/first_subdomain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/elevators/subdomain'
 
 module Apartment
@@ -8,10 +10,9 @@ module Apartment
     #     - example1.domain.com               => example1
     #     - example2.something.domain.com     => example2
     class FirstSubdomain < Subdomain
-
       def parse_tenant_name(request)
         super.split('.')[0] unless super.nil?
       end
     end
   end
-end
+end

data/lib/apartment/elevators/generic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/request'
 require 'apartment/tenant'
 
@@ -6,7 +8,6 @@ module Apartment
     #   Provides a rack based tenant switching solution based on request
     #
     class Generic
-
       def initialize(app, processor = nil)
         @app = app
         @processor = processor || method(:parse_tenant_name)
@@ -24,8 +25,8 @@ module Apartment
         end
       end
 
-      def parse_tenant_name(request)
-        raise "Override"
+      def parse_tenant_name(_request)
+        raise 'Override'
       end
     end
   end

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/log_subscriber.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'active_record/log_subscriber'
+
+module Apartment
+  # Custom Log subscriber to include database name and schema name in sql logs
+  class LogSubscriber < ActiveRecord::LogSubscriber
+    # NOTE: for some reason, if the method definition is not here, then the custom debug method is not called
+    # rubocop:disable Lint/UselessMethodDefinition
+    def sql(event)
+      super
+    end
+    # rubocop:enable Lint/UselessMethodDefinition
+
+    private
+
+    def debug(progname = nil, &blk)
+      progname = "  #{apartment_log}#{progname}" unless progname.nil?
+
+      super
+    end
+
+    def apartment_log
+      database = color("[#{database_name}] ", ActiveSupport::LogSubscriber::MAGENTA, bold: true)
+      schema = current_search_path
+      schema = color("[#{schema.tr('"', '')}] ", ActiveSupport::LogSubscriber::YELLOW, bold: true) unless schema.nil?
+      "#{database}#{schema}"
+    end
+
+    def current_search_path
+      if Apartment.connection.respond_to?(:schema_search_path)
+        Apartment.connection.schema_search_path
+      else
+        Apartment::Tenant.current # all others
+      end
+    end
+
+    def database_name
+      db_name = Apartment.connection.raw_connection.try(:db) # PostgreSQL, PostGIS
+      db_name ||= Apartment.connection.raw_connection.try(:query_options)&.dig(:database) # Mysql
+      db_name ||= Apartment.connection.current_database # Failover
+      db_name
+    end
+  end
+end

data/lib/apartment/migrator.rb

@@ -1,51 +1,34 @@
+# 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)
-        else
-          ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
-        end
+        ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
       end
     end
 
     # Migrate up/down to a specific version
     def run(direction, database, version)
       Tenant.switch(database) do
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_paths, version)
-        else
-          ActiveRecord::Base.connection.migration_context.run(direction, version)
-        end
+        ActiveRecord::Base.connection.migration_context.run(direction, version)
       end
     end
 
     # rollback latest migration `step` number of times
     def rollback(database, step = 1)
       Tenant.switch(database) do
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_paths, step)
-        else
-          ActiveRecord::Base.connection.migration_context.rollback(step)
-        end
+        ActiveRecord::Base.connection.migration_context.rollback(step)
       end
     end
-
-    private
-
-    def activerecord_below_5_2?
-      ActiveRecord.version.release < Gem::Version.new('5.2.0')
-    end
   end
 end

data/lib/apartment/model.rb

@@ -0,0 +1,29 @@
+# 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
+                      # NOTE: In Rails 6.0.4 we start receiving an ActiveRecord::Reflection::BelongsToReflection
+                      # as the key, which wouldn't work well with an array.
+                      [Apartment::Tenant.current] + Array.wrap(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,10 @@
+# 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,17 +17,22 @@ 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
+    #   Note that this doesn'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.
     #
     config.to_prepare do
       next if ARGV.any? { |arg| arg =~ /\Aassets:(?:precompile|clean)\z/ }
+      next if ARGV.any?('webpacker:compile')
+      next if ENV['APARTMENT_DISABLE_INIT']
 
       begin
         Apartment.connection_class.connection_pool.with_connection do
@@ -39,6 +44,19 @@ module Apartment
       end
     end
 
+    config.after_initialize do
+      # NOTE: Load the custom log subscriber if enabled
+      if Apartment.active_record_log
+        ActiveSupport::Notifications.notifier.listeners_for('sql.active_record').each do |listener|
+          next unless listener.instance_variable_get('@delegate').is_a?(ActiveRecord::LogSubscriber)
+
+          ActiveSupport::Notifications.unsubscribe listener
+        end
+
+        Apartment::LogSubscriber.attach_to :active_record
+      end
+    end
+
     #
     #   Ensure rake tasks are loaded
     #
@@ -46,22 +64,5 @@ module Apartment
       load 'tasks/apartment.rake'
       require 'apartment/tasks/enhancements' if Apartment.db_migrate_tenants
     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
-    #
-    if Rails.env.development?
-
-      # Apartment::Reloader is middleware to initialize things properly on each request to dev
-      initializer 'apartment.init' do |app|
-        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
-      console do
-        require 'apartment/console'
-      end
-    end
   end
 end

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: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,52 @@
+# 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
+
+    def self.migrate_tenant(tenant_name)
+      strategy = Apartment.db_migrate_tenant_missing_strategy
+      create_tenant(tenant_name) if strategy == :create_tenant
+
+      puts("Migrating #{tenant_name} tenant")
+      Apartment::Migrator.migrate tenant_name
+    rescue Apartment::TenantNotFound => e
+      raise e if strategy == :raise_exception
+
+      puts e.message
+    end
+  end
+end

data/lib/apartment/tenant.rb

@@ -1,23 +1,19 @@
+# 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, :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}
@@ -27,9 +23,10 @@ module Apartment
         adapter_method = "#{config[:adapter]}_adapter"
 
         if defined?(JRUBY_VERSION)
-          if config[:adapter] =~ /mysql/
+          case config[:adapter]
+          when /mysql/
             adapter_method = 'jdbc_mysql_adapter'
-          elsif config[:adapter] =~ /postgresql/
+          when /postgresql/
             adapter_method = 'jdbc_postgresql_adapter'
           end
         end

data/lib/apartment/version.rb

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