ros-apartment 2.3.0 → 2.4.0

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/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/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
@@ -28,14 +29,18 @@ module Apartment
     #
     config.to_prepare do
       next if ARGV.any? { |arg| arg =~ /\Aassets:(?:precompile|clean)\z/ }
+      next if ARGV.any? { |arg| arg == 'webpacker:compile' }
 
       begin
         Apartment.connection_class.connection_pool.with_connection do
           Apartment::Tenant.init
         end
-      rescue ::ActiveRecord::NoDatabaseError
+      rescue ::ActiveRecord::NoDatabaseError, PG::ConnectionBad
         # 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
 
@@ -48,8 +53,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 +65,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: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/tenant.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Apartment
   #   The main entry point to Apartment functions
   #
   module Tenant
-
     extend self
     extend Forwardable
 
@@ -40,9 +41,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

data/lib/apartment/version.rb

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

data/lib/apartment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'apartment/railtie' if defined?(Rails)
 require 'active_support/core_ext/object/blank'
 require 'forwardable'
@@ -5,13 +7,16 @@ require 'active_record'
 require 'apartment/tenant'
 
 module Apartment
-
   class << self
-
     extend Forwardable
 
-    ACCESSOR_METHODS  = [:use_schemas, :use_sql, :seed_after_create, :prepend_environment, :append_environment, :with_multi_server_setup]
-    WRITER_METHODS    = [:tenant_names, :database_schema_file, :excluded_models, :default_schema, :persistent_schemas, :connection_class, :tld_length, :db_migrate_tenants, :seed_data_file, :parallel_migration_threads, :pg_excluded_names]
+    ACCESSOR_METHODS = %i[use_schemas use_sql seed_after_create prepend_environment
+                          append_environment with_multi_server_setup].freeze
+
+    WRITER_METHODS = %i[tenant_names database_schema_file excluded_models
+                        default_schema persistent_schemas connection_class
+                        tld_length db_migrate_tenants seed_data_file
+                        parallel_migration_threads pg_excluded_names].freeze
 
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
@@ -49,14 +54,14 @@ module Apartment
     end
 
     def default_schema
-      @default_schema || "public" # TODO 'public' is postgres specific
+      @default_schema || 'public' # TODO: 'public' is postgres specific
     end
 
     def parallel_migration_threads
       @parallel_migration_threads || 0
     end
-    alias :default_tenant :default_schema
-    alias :default_tenant= :default_schema=
+    alias default_tenant default_schema
+    alias default_tenant= default_schema=
 
     def persistent_schemas
       @persistent_schemas || []
@@ -75,7 +80,7 @@ module Apartment
     def seed_data_file
       return @seed_data_file if defined?(@seed_data_file)
 
-      @seed_data_file = "#{Rails.root}/db/seeds.rb"
+      @seed_data_file = Rails.root.join('db', 'seeds.rb')
     end
 
     def pg_excluded_names
@@ -84,11 +89,12 @@ module Apartment
 
     # Reset all the config for Apartment
     def reset
-      (ACCESSOR_METHODS + WRITER_METHODS).each{|method| remove_instance_variable(:"@#{method}") if instance_variable_defined?(:"@#{method}") }
+      (ACCESSOR_METHODS + WRITER_METHODS).each { |method| remove_instance_variable(:"@#{method}") if instance_variable_defined?(:"@#{method}") }
     end
 
     def extract_tenant_config
       return {} unless @tenant_names
+
       values = @tenant_names.respond_to?(:call) ? @tenant_names.call : @tenant_names
       unless values.is_a? Hash
         values = values.each_with_object({}) do |tenant, hash|

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.

data/lib/tasks/apartment.rake

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'apartment/migrator'
 require 'parallel'
 
 apartment_namespace = namespace :apartment do
-
-  desc "Create all tenants"
+  desc 'Create all tenants'
   task :create do
     tenants.each do |tenant|
       begin
@@ -15,19 +16,19 @@ apartment_namespace = namespace :apartment do
     end
   end
 
-  desc "Drop all tenants"
+  desc 'Drop all tenants'
   task :drop do
     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|
@@ -40,7 +41,7 @@ apartment_namespace = namespace :apartment do
     end
   end
 
-  desc "Seed all tenants"
+  desc 'Seed all tenants'
   task :seed do
     warn_if_tenants_empty
 
@@ -56,7 +57,7 @@ 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
 
@@ -107,7 +108,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
@@ -126,20 +127,20 @@ apartment_namespace = namespace :apartment do
   end
 
   def tenants
-    ENV['DB'] ? ENV['DB'].split(',').map { |s| s.strip } : Apartment.tenant_names || []
+    ENV['DB'] ? ENV['DB'].split(',').map(&: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:
+    return unless tenants.empty? && ENV['IGNORE_EMPTY_TENANTS'] != 'true'
 
-          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`
+    puts <<-WARNING
+      [WARNING] - The list of tenants to migrate appears to be empty. This could mean a few things:
 
-        Note that your tenants currently haven't been migrated. You'll need to run `db:migrate` to rectify this.
-      WARNING
-    end
+        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/spec/adapters/jdbc_mysql_adapter_spec.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 if defined?(JRUBY_VERSION)
 
   require 'spec_helper'
   require 'apartment/adapters/jdbc_mysql_adapter'
 
   describe Apartment::Adapters::JDBCMysqlAdapter, database: :mysql do
-
     subject { Apartment::Tenant.jdbc_mysql_adapter config.symbolize_keys }
 
     def tenant_names
-      ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect { |row| row['schema_name'] }
+      ActiveRecord::Base.connection.execute('SELECT schema_name FROM information_schema.schemata').collect { |row| row['schema_name'] }
     end
 
     let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
 
-    it_should_behave_like "a generic apartment adapter"
-    it_should_behave_like "a connection based apartment adapter"
+    it_should_behave_like 'a generic apartment adapter'
+    it_should_behave_like 'a connection based apartment adapter'
   end
 end

data/spec/adapters/jdbc_postgresql_adapter_spec.rb

@@ -1,41 +1,39 @@
+# frozen_string_literal: true
+
 if defined?(JRUBY_VERSION)
 
   require 'spec_helper'
   require 'apartment/adapters/jdbc_postgresql_adapter'
 
   describe Apartment::Adapters::JDBCPostgresqlAdapter, database: :postgresql do
-
     subject { Apartment::Tenant.jdbc_postgresql_adapter config.symbolize_keys }
 
-    context "using schemas" do
-
+    context 'using schemas' do
       before { Apartment.use_schemas = true }
 
       # Not sure why, but somehow using let(:tenant_names) memoizes for the whole example group, not just each test
       def tenant_names
-        ActiveRecord::Base.connection.execute("SELECT nspname FROM pg_namespace;").collect { |row| row['nspname'] }
+        ActiveRecord::Base.connection.execute('SELECT nspname FROM pg_namespace;').collect { |row| row['nspname'] }
       end
 
       let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.schema_search_path.gsub('"', '') } }
 
-      it_should_behave_like "a generic apartment adapter"
-      it_should_behave_like "a schema based apartment adapter"
+      it_should_behave_like 'a generic apartment adapter'
+      it_should_behave_like 'a schema based apartment adapter'
     end
 
-    context "using databases" do
-
+    context 'using databases' do
       before { Apartment.use_schemas = false }
 
       # Not sure why, but somehow using let(:tenant_names) memoizes for the whole example group, not just each test
       def tenant_names
-        connection.execute("select datname from pg_database;").collect { |row| row['datname'] }
+        connection.execute('select datname from pg_database;').collect { |row| row['datname'] }
       end
 
       let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
 
-      it_should_behave_like "a generic apartment adapter"
-      it_should_behave_like "a connection based apartment adapter"
-
+      it_should_behave_like 'a generic apartment adapter'
+      it_should_behave_like 'a connection based apartment adapter'
     end
   end
 end

data/spec/adapters/mysql2_adapter_spec.rb

@@ -1,34 +1,36 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'apartment/adapters/mysql2_adapter'
 
 describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
   unless defined?(JRUBY_VERSION)
 
-    subject(:adapter){ Apartment::Tenant.mysql2_adapter config }
+    subject(:adapter) { Apartment::Tenant.mysql2_adapter config }
 
     def tenant_names
-      ActiveRecord::Base.connection.execute("SELECT schema_name FROM information_schema.schemata").collect { |row| row[0] }
+      ActiveRecord::Base.connection.execute('SELECT schema_name FROM information_schema.schemata').collect { |row| row[0] }
     end
 
     let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
 
-    context "using - the equivalent of - schemas" do
+    context 'using - the equivalent of - schemas' do
       before { Apartment.use_schemas = true }
 
-      it_should_behave_like "a generic apartment adapter"
+      it_should_behave_like 'a generic apartment adapter'
 
-      describe "#default_tenant" do
-        it "is set to the original db from config" do
+      describe '#default_tenant' do
+        it 'is set to the original db from config' do
           expect(subject.default_tenant).to eq(config[:database])
         end
       end
 
-      describe "#init" do
+      describe '#init' do
         include Apartment::Spec::AdapterRequirements
 
         before do
           Apartment.configure do |config|
-            config.excluded_models = ["Company"]
+            config.excluded_models = ['Company']
           end
         end
 
@@ -40,7 +42,7 @@ describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
           end
         end
 
-        it "should process model exclusions" do
+        it 'should process model exclusions' do
           Apartment::Tenant.init
 
           expect(Company.table_name).to eq("#{default_tenant}.companies")
@@ -48,12 +50,12 @@ describe Apartment::Adapters::Mysql2Adapter, database: :mysql do
       end
     end
 
-    context "using connections" do
+    context 'using connections' do
       before { Apartment.use_schemas = false }
 
-      it_should_behave_like "a generic apartment adapter"
-      it_should_behave_like "a generic apartment adapter able to handle custom configuration"
-      it_should_behave_like "a connection based apartment adapter"
+      it_should_behave_like 'a generic apartment adapter'
+      it_should_behave_like 'a generic apartment adapter able to handle custom configuration'
+      it_should_behave_like 'a connection based apartment adapter'
     end
   end
 end