ros-apartment 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e57016e050d57190e3baa0693ccd7e2e094db1cdb864f9c75e193ce06fcdddbb
-  data.tar.gz: 65b587e5c59e03e957e42c8ca0c0cf4d078859e078eebdcda4594e69284c3175
+  metadata.gz: 7c5ea61531091303bdf3ab60326eadb7ffda6ea92b03079fd8a93583067037c7
+  data.tar.gz: 95c482e8304a914d6098f1f4ea498f93e1a4827d851e4ea4a283f18ca51079ae
 SHA512:
-  metadata.gz: d1ebfaf0a5e4da01bceed2f3cec330aefec6bbfdb5e98dd706ec7b0305cb8bc820e58106ebb60854fc7f5d8735c02d426c87a17a9f16c4b12f34104059644419
-  data.tar.gz: 1a72b322cf5913313aedfb1f84d3117c5cbbd5ba36a7b62ab1cf10d2e3987d8eca8b465cfc38538b86482a08fd8412e43e1d39708d3a952e4fad8c946b0b0203
+  metadata.gz: '09f36cbd0d164f3f692aaf9b2a60b55aa5289537b07c299e49d651a1f1fe6aba6a8d67578076ccad94c2ad62bcaf46e74900c532664f696d1dd4ae673fb49d1d'
+  data.tar.gz: b38b9708487fa0e64c93d8349f922dafe2678b09020f5c5a5e77aca5acff4510254737094636d3c25a03e57e76280a20c403fe4021b6e64bcb3e9956b4a77acb

data/.rubocop.yml

@@ -7,6 +7,7 @@ inherit_gem:
 AllCops:
   Exclude:
     - 'gemfiles/**/*.gemfile'
+    - 'gemfiles/vendor/**/*'
 
 Style/WordArray:
   Exclude:

data/.story_branch.yml

@@ -1,4 +1,5 @@
 ---
 tracker: github
+issue_placement: beginning
 project_id:
 - rails-on-services/apartment

data/.travis.yml

@@ -29,10 +29,15 @@ before_install:
   - sudo /etc/init.d/mysql stop
   - sudo /etc/init.d/postgresql stop
   - docker-compose up -d
+
 env:
   RUBY_GC_MALLOC_LIMIT: 90000000
   RUBY_GC_HEAP_FREE_SLOTS: 200000
 jobs:
+  include:
+  - name: Rubocop Lint
+    script: gem install perx-rubocop && rubocop
+
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'http://rubygems.org'
+source 'https://my.diffend.io/protect/gems'
 
 gemspec
 

data/HISTORY.md

@@ -1,3 +1,60 @@
+# 2.6.1
+
+## Enhancements
+- N/a
+
+## Bugfixes
+- [Resolves influitive#607] Avoid early connection
+  - <https://github.com/rails-on-services/apartment/pull/39>
+  - <https://github.com/rails-on-services/apartment/pull/53>
+  - <https://github.com/rails-on-services/apartment/pull/51>
+- [Resolves #52] Rake db:setup tries to seed non existent tenant - <https://github.com/rails-on-services/apartment/pull/54>
+- [Resolves #56] DB rollback uses second last migration - <https://github.com/rails-on-services/apartment/pull/57>
+
+## Chores
+-   N/a
+
+# 2.6.0
+
+## Enhancements
+-   [Resolves #26] Support configuration for skip checking of schema existence before switching
+-   [Resolves #41] Add tenant info to console boot
+
+## Bugfixes
+-   [Resolves #37] Custom Console deprecation warning
+-   [Resolves #42] After switch callback not working with nil argument
+
+## Chores
+-   Updated github actions configuration to run on PRs as well
+
+# 2.5.0
+
+## Enhancements
+-   [Resolves #6] Adds support for rails 6.1
+-   [Resolves #27] Adds support to not rely on set search path, but instead prepends the schema name to the table name when using postgresql with schemas.
+-   [Resolves #35] Cache keys are now tenant dependent
+
+## Bugfixes
+-   [Resolves #27] Manually switching connection between read and write forgets the schema
+
+## Chores
+-   [Resolves #31] Add latest ruby versions to test matrix
+
+# 2.4.0
+
+## Enhancements
+-   [Resolves #14] Add console info about tenants and fast switches #17
+-   Skip init if we're running webpacker:compile #18
+
+## Bugfixes
+-   Don't crash when no database connection is present #16
+-   Rescuing ActiveRecord::NoDatabaseError when dropping tenants #19
+
+## Chores
+-   Rakefile should use mysql port from configuration #5
+-   [Resolves #9] Cleanup rubocop todo #8
+-   Cleanup travis matrix #23
+
 # 2.3.0
   * January 3, 2020
 

data/README.md

@@ -368,12 +368,12 @@ Enable this option with:
 config.use_sql = true
 ```
 
-### Providing a Different default_schema
+### Providing a Different default_tenant
 
 By default, ActiveRecord will use `"$user", public` as the default `schema_search_path`. This can be modified if you wish to use a different default schema be setting:
 
 ```ruby
-config.default_schema = "some_other_schema"
+config.default_tenant = "some_other_schema"
 ```
 
 With that set, all excluded models will use this schema as the table name prefix instead of `public` and `reset` on `Apartment::Tenant` will return to this schema as well.
@@ -446,7 +446,7 @@ schema_search_path: "public,shared_extensions"
 ...
 ```
 
-This would be for a config with `default_schema` set to `public` and `persistent_schemas` set to `['shared_extensions']`. **Note**: This only works on Heroku with [Rails 4.1+](https://devcenter.heroku.com/changelog-items/426). For apps that use older Rails versions hosted on Heroku, the only way to properly setup is to start with a fresh PostgreSQL instance:
+This would be for a config with `default_tenant` set to `public` and `persistent_schemas` set to `['shared_extensions']`. **Note**: This only works on Heroku with [Rails 4.1+](https://devcenter.heroku.com/changelog-items/426). For apps that use older Rails versions hosted on Heroku, the only way to properly setup is to start with a fresh PostgreSQL instance:
 
 1. Append `?schema_search_path=public,hstore` to your `DATABASE_URL` environment variable, by this you don't have to revise the `database.yml` file (which is impossible since Heroku regenerates a completely different and immutable `database.yml` of its own on each deploy)
 2. Run `heroku pg:psql` from your command line

data/TODO.md

@@ -46,6 +46,5 @@
 
 Quick TODOs
 
-1. `default_tenant` should be up to the adapter, not the Apartment class, deprecate `default_schema`
 2. deprecation.rb rescues everything, we have a hard dependency on ActiveSupport so this is unnecessary
 3.

data/lib/apartment.rb

@@ -8,6 +8,7 @@ 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.1')
@@ -19,12 +20,12 @@ module Apartment
   class << self
     extend Forwardable
 
-    ACCESSOR_METHODS = %i[use_schemas use_sql seed_after_create prepend_environment
-                          append_environment with_multi_server_setup tenant_presence_check].freeze
+    ACCESSOR_METHODS = %i[use_schemas use_sql seed_after_create prepend_environment default_tenant
+                          append_environment with_multi_server_setup tenant_presence_check active_record_log].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
+                        persistent_schemas connection_class
+                        db_migrate_tenants seed_data_file
                         parallel_migration_threads pg_excluded_names].freeze
 
     attr_accessor(*ACCESSOR_METHODS)
@@ -53,6 +54,10 @@ module Apartment
       extract_tenant_config
     end
 
+    def tld_length=(_)
+      Apartment::Deprecation.warn('`config.tld_length` have no effect because it was removed in https://github.com/influitive/apartment/pull/309')
+    end
+
     def db_config_for(tenant)
       (tenants_with_config[tenant] || connection_config)
     end
@@ -70,15 +75,9 @@ module Apartment
       @excluded_models || []
     end
 
-    def default_schema
-      @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=
 
     def persistent_schemas
       @persistent_schemas || []

data/lib/apartment/active_record/log_subscriber.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  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?
+      "#{database}#{schema}"
+    end
+
+    def payload_binds(binds, type_casted_binds)
+      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
+    end
+
+    def sql(event)
+      self.class.runtime += event.duration
+      return unless logger.debug?
+
+      payload = event.payload
+
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+      name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+      name  = "CACHE #{name}" if payload[:cached]
+      sql = payload[:sql]
+      binds = payload_binds(payload[:binds], payload[:type_casted_binds])
+
+      name = colorize_payload_name(name, payload[:name])
+      sql  = color(sql, sql_color(sql), true) if colorize_logging
+
+      debug "    #{apartment_log}#{name} #{sql}#{binds}"
+    end
+  end
+end

data/lib/apartment/adapters/abstract_adapter.rb

@@ -54,7 +54,6 @@ module Apartment
       def default_tenant
         @default_tenant || Apartment.default_tenant
       end
-      alias default_schema default_tenant # TODO: deprecate default_schema
 
       #   Drop the tenant
       #

data/lib/apartment/adapters/mysql2_adapter.rb

@@ -39,6 +39,8 @@ module Apartment
       #   Reset current tenant to the default_tenant
       #
       def reset
+        return unless default_tenant
+
         Apartment.connection.execute "use `#{default_tenant}`"
       end
 

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -30,6 +30,10 @@ module Apartment
         reset
       end
 
+      def default_tenant
+        @default_tenant = Apartment.default_tenant || 'public'
+      end
+
       #   Reset schema search path to the default schema_search_path
       #
       #   @return {String} default schema search path

data/lib/apartment/railtie.rb

@@ -19,6 +19,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

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

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

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

@@ -96,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,12 +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'
   task :create do
-    tenants.each do |tenant|
+    Apartment::TaskHelper.tenants.each do |tenant|
       begin
         puts("Creating #{tenant} tenant")
         Apartment::Tenant.create(tenant)
@@ -18,7 +19,7 @@ apartment_namespace = namespace :apartment do
 
   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,8 +31,8 @@ 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
         puts("Migrating #{tenant} tenant")
         Apartment::Migrator.migrate tenant
@@ -43,9 +44,9 @@ 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
         puts("Seeding #{tenant} tenant")
         Apartment::Tenant.switch(tenant) do
@@ -59,11 +60,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 +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
@@ -93,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
@@ -119,32 +120,4 @@ apartment_namespace = namespace :apartment do
       end
     end
   end
-
-  def each_tenant(&block)
-    Parallel.each(tenants_without_default, in_threads: Apartment.parallel_migration_threads) do |tenant|
-      block.call(tenant)
-    end
-  end
-
-  def tenants_without_default
-    tenants - [Apartment.default_schema]
-  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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ros-apartment
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Ryan Brunner
 - Brad Robertson
 - Rui Baltazar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -229,7 +229,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE.md"
-- ".github/workflows/.rubocop-linter.yml"
 - ".gitignore"
 - ".pryrc"
 - ".rspec"
@@ -255,6 +254,7 @@ files:
 - lib/apartment.rb
 - lib/apartment/active_record/connection_handling.rb
 - lib/apartment/active_record/internal_metadata.rb
+- lib/apartment/active_record/log_subscriber.rb
 - lib/apartment/active_record/schema_migration.rb
 - lib/apartment/adapters/abstract_adapter.rb
 - lib/apartment/adapters/abstract_jdbc_adapter.rb
@@ -278,6 +278,7 @@ files:
 - 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
@@ -288,7 +289,7 @@ homepage: https://github.com/rails-on-services/apartment
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -304,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Ruby gem for managing database multitenancy. Apartment Gem drop in replacement
 test_files: []

data/.github/workflows/.rubocop-linter.yml

@@ -1,22 +0,0 @@
-name: Rubocop Lint
-
-on: [push, pull_request]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    container:
-      image: ruby:2.6.5
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Rubocop Linter
-      uses: andrewmcodes/rubocop-linter-action@v2.0.0
-      with:
-        additional_gems: 'perx-rubocop:0.0.3'
-        fail_level: 'warning'
-        version: '0.77.0'
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}