ros-apartment 2.7.1 → 2.7.2

data/Rakefile

@@ -46,8 +46,10 @@ namespace :db do
     apartment_db_file = 'spec/config/database.yml'
     rails_db_file = 'spec/dummy/config/database.yml'
 
-    FileUtils.copy(apartment_db_file + '.sample', apartment_db_file, verbose: true) unless File.exist?(apartment_db_file)
-    FileUtils.copy(rails_db_file + '.sample', rails_db_file, verbose: true)         unless File.exist?(rails_db_file)
+    unless File.exist?(apartment_db_file)
+      FileUtils.copy(apartment_db_file + '.sample', apartment_db_file, verbose: true)
+    end
+    FileUtils.copy(rails_db_file + '.sample', rails_db_file, verbose: true) unless File.exist?(rails_db_file)
   end
 end
 

data/gemfiles/rails_5_0.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.0.0"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/gemfiles/rails_5_1.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.1.0"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/gemfiles/rails_5_2.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.2.0"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/gemfiles/rails_6_0.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 6.0.0"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/gemfiles/rails_master.gemfile

@@ -2,8 +2,8 @@
 
 source "http://rubygems.org"
 
-gem "perx-rubocop", "~> 0.0.3"
 gem "rails", git: "https://github.com/rails/rails.git"
+gem "rubocop"
 
 group :local do
   gem "guard-rspec", "~> 4.2"

data/lib/apartment.rb

@@ -6,16 +6,18 @@ require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
 
-# require_relative 'apartment/arel/visitors/postgresql'
-
 require_relative 'apartment/active_record/log_subscriber'
-require_relative 'apartment/active_record/connection_handling' if ActiveRecord.version.release >= Gem::Version.new('6.0')
+
+if ActiveRecord.version.release >= Gem::Version.new('6.0')
+  require_relative 'apartment/active_record/connection_handling'
+end
 
 if ActiveRecord.version.release >= Gem::Version.new('6.1')
   require_relative 'apartment/active_record/schema_migration'
   require_relative 'apartment/active_record/internal_metadata'
 end
 
+# Apartment main definitions
 module Apartment
   class << self
     extend Forwardable

data/lib/apartment/active_record/connection_handling.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module ActiveRecord
+  # This is monkeypatching activerecord to ensure that whenever a new connection is established it
+  # switches to the same tenant as before the connection switching. This problem is more evident when
+  # using read replica in Rails 6
   module ConnectionHandling
     def connected_to_with_tenant(database: nil, role: nil, prevent_writes: false, &blk)
       current_tenant = Apartment::Tenant.current

data/lib/apartment/active_record/internal_metadata.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Rails/ApplicationRecord
 class InternalMetadata < ActiveRecord::Base # :nodoc:
   class << self
     def table_exists?
@@ -8,4 +7,3 @@ class InternalMetadata < ActiveRecord::Base # :nodoc:
     end
   end
 end
-# rubocop:enable Rails/ApplicationRecord

data/lib/apartment/active_record/log_subscriber.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
 module ActiveRecord
+  # Supports the logging configuration to prepend the database and schema in the ActiveRecord log
   class LogSubscriber
     def apartment_log
       return unless Apartment.active_record_log
 
       database = color("[#{Apartment.connection.current_database}] ", ActiveSupport::LogSubscriber::MAGENTA, true)
       schema = nil
-      schema = color("[#{Apartment.connection.schema_search_path.tr('"', '')}] ", ActiveSupport::LogSubscriber::YELLOW, true) unless Apartment.connection.schema_search_path.nil?
+      unless Apartment.connection.schema_search_path.nil?
+        schema = color("[#{Apartment.connection.schema_search_path.tr('"', '')}] ",
+                       ActiveSupport::LogSubscriber::YELLOW, true)
+      end
       "#{database}#{schema}"
     end
 
@@ -15,8 +19,7 @@ module ActiveRecord
       return unless (binds || []).empty?
 
       casted_params = type_casted_binds(type_casted_binds)
-      binds = '  ' + binds.zip(casted_params).map { |attr, value| render_bind(attr, value) }.inspect
-      binds
+      '  ' + binds.zip(casted_params).map { |attr, value| render_bind(attr, value) }.inspect
     end
 
     def sql(event)

data/lib/apartment/active_record/schema_migration.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  # rubocop:disable Rails/ApplicationRecord
   class SchemaMigration < ActiveRecord::Base # :nodoc:
     class << self
       def table_exists?
@@ -9,5 +8,4 @@ module ActiveRecord
       end
     end
   end
-  # rubocop:enable Rails/ApplicationRecord
 end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -2,7 +2,7 @@
 
 module Apartment
   module Adapters
-    # rubocop:disable Metrics/ClassLength
+    # Abstract adapter from which all the Apartment DB related adapters will inherit the base logic
     class AbstractAdapter
       include ActiveSupport::Callbacks
       define_callbacks :create, :switch
@@ -240,7 +240,8 @@ module Apartment
       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.
+          # example: when you use postgresql, you need to connect to the default postgresql database before you create
+          # your own.
           SeparateDbConnectionHandler.establish_connection(multi_tenantify(tenant, false))
           yield(SeparateDbConnectionHandler.connection)
           SeparateDbConnectionHandler.connection.close
@@ -269,5 +270,4 @@ module Apartment
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/apartment/adapters/abstract_jdbc_adapter.rb

@@ -4,11 +4,12 @@ require 'apartment/adapters/abstract_adapter'
 
 module Apartment
   module Adapters
+    # JDBC Abstract adapter
     class AbstractJDBCAdapter < AbstractAdapter
       private
 
       def multi_tenantify_with_tenant_db_name(config, tenant)
-        config[:url] = "#{config[:url].gsub(%r{(\S+)\/.+$}, '\1')}/#{environmentify(tenant)}"
+        config[:url] = "#{config[:url].gsub(%r{(\S+)/.+$}, '\1')}/#{environmentify(tenant)}"
       end
 
       def rescue_from

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -3,6 +3,7 @@
 require 'apartment/adapters/postgresql_adapter'
 
 module Apartment
+  # JDBC helper to decide wether to use JDBC Postgresql Adapter or JDBC Postgresql Adapter with Schemas
   module Tenant
     def self.jdbc_postgresql_adapter(config)
       if Apartment.use_schemas
@@ -19,7 +20,7 @@ module Apartment
       private
 
       def multi_tenantify_with_tenant_db_name(config, tenant)
-        config[:url] = "#{config[:url].gsub(%r{(\S+)\/.+$}, '\1')}/#{environmentify(tenant)}"
+        config[:url] = "#{config[:url].gsub(%r{(\S+)/.+$}, '\1')}/#{environmentify(tenant)}"
       end
 
       def create_tenant_command(conn, tenant)

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -3,6 +3,7 @@
 require 'apartment/adapters/abstract_adapter'
 
 module Apartment
+  # Helper module to decide wether to use mysql2 adapter or mysql2 adapter with schemas
   module Tenant
     def self.mysql2_adapter(config)
       if Apartment.use_schemas
@@ -14,6 +15,7 @@ module Apartment
   end
 
   module Adapters
+    # Mysql2 Adapter
     class Mysql2Adapter < AbstractAdapter
       def initialize(config)
         super
@@ -28,6 +30,7 @@ module Apartment
       end
     end
 
+    # Mysql2 Schemas Adapter
     class Mysql2SchemaAdapter < AbstractAdapter
       def initialize(config)
         super

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -121,12 +121,17 @@ module Apartment
         # There is `reset_sequence_name`, but that method actually goes to the database
         # to find out the new name. Therefore, we do this hack to only unset the name,
         # and it will be dynamically found the next time it is needed
-        ActiveRecord::Base.descendants
-                          .select { |c| c.instance_variable_defined?(:@sequence_name) }
-                          .reject { |c| c.instance_variable_defined?(:@explicit_sequence_name) && c.instance_variable_get(:@explicit_sequence_name) }
-                          .each do |c|
-                            c.remove_instance_variable :@sequence_name
-                          end
+        descendants_to_unset = ActiveRecord::Base.descendants
+                                                 .select { |c| c.instance_variable_defined?(:@sequence_name) }
+                                                 .reject do |c|
+                                                   c.instance_variable_defined?(:@explicit_sequence_name) &&
+                                                     c.instance_variable_get(:@explicit_sequence_name)
+                                                 end
+        descendants_to_unset.each do |c|
+          # NOTE: due to this https://github.com/rails-on-services/apartment/issues/81
+          # unreproduceable error we're checking before trying to remove it
+          c.remove_instance_variable :@sequence_name if c.instance_variable_defined?(:@sequence_name)
+        end
       end
     end
 
@@ -195,9 +200,11 @@ module Apartment
       #
       #   @return {String} raw SQL contaning inserts with data from schema_migrations
       #
+      # rubocop:disable Layout/LineLength
       def pg_dump_schema_migrations_data
         with_pg_env { `pg_dump -a --inserts -t #{default_tenant}.schema_migrations -t #{default_tenant}.ar_internal_metadata #{dbname}` }
       end
+      # rubocop:enable Layout/LineLength
 
       # Temporary set Postgresql related environment variables if there are in @config
       #

data/lib/apartment/console.rb

@@ -5,9 +5,7 @@
 
 # reloads the environment
 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 {}).call({})
@@ -18,15 +16,13 @@ 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
 
@@ -37,8 +33,6 @@ def tenant_list
 end
 
 def tenant_info_msg
-  # rubocop:disable Rails/Output
   puts "Available Tenants: #{tenant_list}\n"
   puts "Use `st 'tenant'` to switch tenants & `tenant_list` to see list\n"
-  # rubocop:enable Rails/Output
 end

data/lib/apartment/custom_console.rb

@@ -7,9 +7,9 @@ module Apartment
     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/railtie.rb

@@ -27,7 +27,7 @@ module Apartment
 
     # Make sure Apartment is reconfigured when the code is reloaded
     config.to_prepare do
-      Apartment::Tenant.reinitialize
+      Apartment::Tenant.reload!
     end
 
     #

data/lib/apartment/tasks/task_helper.rb

@@ -19,7 +19,6 @@ module Apartment
     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:
 
@@ -29,7 +28,6 @@ module Apartment
 
         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

@@ -51,7 +51,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.7.1'
+  VERSION = '2.7.2'
 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']

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ros-apartment
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.7.2
 platform: ruby
 authors:
 - Ryan Brunner
 - Brad Robertson
 - Rui Baltazar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -229,6 +229,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE.md"
+- ".github/workflows/changelog.yml"
 - ".gitignore"
 - ".pryrc"
 - ".rspec"
@@ -237,6 +238,7 @@ files:
 - ".story_branch.yml"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - HISTORY.md
@@ -289,7 +291,7 @@ homepage: https://github.com/rails-on-services/apartment
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -304,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: []