ros-apartment 2.3.0 → 2.7.0

data/Rakefile

@@ -1,19 +1,25 @@
-require 'bundler' rescue 'You must `gem install bundler` and `bundle install` to run rake tasks'
+# frozen_string_literal: true
+
+begin
+  require 'bundler'
+rescue StandardError
+  'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 Bundler.setup
 Bundler::GemHelper.install_tasks
 
 require 'appraisal'
 
-require "rspec"
-require "rspec/core/rake_task"
+require 'rspec'
+require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec => %w{ db:copy_credentials db:test:prepare }) do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
+RSpec::Core::RakeTask.new(spec: %w[db:copy_credentials db:test:prepare]) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
   # spec.rspec_opts = '--order rand:47078'
 end
 
 namespace :spec do
-  [:tasks, :unit, :adapters, :integration].each do |type|
+  %i[tasks unit adapters integration].each do |type|
     RSpec::Core::RakeTask.new(type => :spec) do |spec|
       spec.pattern = "spec/#{type}/**/*_spec.rb"
     end
@@ -27,11 +33,11 @@ task :console do
   Pry.start
 end
 
-task :default => :spec
+task default: :spec
 
 namespace :db do
   namespace :test do
-    task :prepare => %w{postgres:drop_db postgres:build_db mysql:drop_db mysql:build_db}
+    task prepare: %w[postgres:drop_db postgres:build_db mysql:drop_db mysql:build_db]
   end
 
   desc "copy sample database credential files over if real files don't exist"
@@ -40,29 +46,33 @@ 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.exists?(apartment_db_file)
-    FileUtils.copy(rails_db_file + '.sample', rails_db_file, :verbose => true)         unless File.exists?(rails_db_file)
+    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)
   end
 end
 
 namespace :postgres do
   require 'active_record'
-  require "#{File.join(File.dirname(__FILE__), 'spec', 'support', 'config')}"
+  require File.join(File.dirname(__FILE__), 'spec', 'support', 'config').to_s
 
   desc 'Build the PostgreSQL test databases'
   task :build_db do
     params = []
-    params << "-E UTF8"
+    params << '-E UTF8'
     params << pg_config['database']
     params << "-U#{pg_config['username']}"
     params << "-h#{pg_config['host']}" if pg_config['host']
     params << "-p#{pg_config['port']}" if pg_config['port']
-    %x{ createdb #{params.join(' ')} } rescue "test db already exists"
+    begin
+      `createdb #{params.join(' ')}`
+    rescue StandardError
+      'test db already exists'
+    end
     ActiveRecord::Base.establish_connection pg_config
     migrate
   end
 
-  desc "drop the PostgreSQL test database"
+  desc 'drop the PostgreSQL test database'
   task :drop_db do
     puts "dropping database #{pg_config['database']}"
     params = []
@@ -70,14 +80,13 @@ namespace :postgres do
     params << "-U#{pg_config['username']}"
     params << "-h#{pg_config['host']}" if pg_config['host']
     params << "-p#{pg_config['port']}" if pg_config['port']
-    %x{ dropdb #{params.join(' ')} }
+    `dropdb #{params.join(' ')}`
   end
-
 end
 
 namespace :mysql do
   require 'active_record'
-  require "#{File.join(File.dirname(__FILE__), 'spec', 'support', 'config')}"
+  require File.join(File.dirname(__FILE__), 'spec', 'support', 'config').to_s
 
   desc 'Build the MySQL test databases'
   task :build_db do
@@ -85,24 +94,29 @@ namespace :mysql do
     params << "-h #{my_config['host']}" if my_config['host']
     params << "-u #{my_config['username']}" if my_config['username']
     params << "-p#{my_config['password']}" if my_config['password']
-    %x{ mysqladmin #{params.join(' ')} create #{my_config['database']} } rescue "test db already exists"
+    params << "--port #{my_config['port']}" if my_config['port']
+    begin
+      `mysqladmin #{params.join(' ')} create #{my_config['database']}`
+    rescue StandardError
+      'test db already exists'
+    end
     ActiveRecord::Base.establish_connection my_config
     migrate
   end
 
-  desc "drop the MySQL test database"
+  desc 'drop the MySQL test database'
   task :drop_db do
     puts "dropping database #{my_config['database']}"
     params = []
     params << "-h #{my_config['host']}" if my_config['host']
     params << "-u #{my_config['username']}" if my_config['username']
     params << "-p#{my_config['password']}" if my_config['password']
-    %x{ mysqladmin #{params.join(' ')} drop #{my_config['database']} --force}
+    params << "--port #{my_config['port']}" if my_config['port']
+    `mysqladmin #{params.join(' ')} drop #{my_config['database']} --force`
   end
-
 end
 
-# TODO clean this up
+# TODO: clean this up
 def config
   Apartment::Test.config['connections']
 end

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/apartment.gemspec

@@ -11,7 +11,15 @@ Gem::Specification.new do |s|
   s.summary       = 'A Ruby gem for managing database multitenancy. Apartment Gem drop in replacement'
   s.description   = 'Apartment allows Rack applications to deal with database multitenancy through ActiveRecord'
   s.email         = ['ryan@influitive.com', 'brad@influitive.com', 'rui.p.baltazar@gmail.com']
-  s.files         = `git ls-files`.split($/)
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been
+  # added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      # NOTE: ignore all test related
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
   s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
@@ -20,13 +28,13 @@ Gem::Specification.new do |s|
   s.licenses = ['MIT']
 
   # must be >= 3.1.2 due to bug in prepared_statements
-  s.add_dependency 'activerecord',    '>= 3.1.2', '< 6.1'
-  s.add_dependency 'parallel',        '>= 0.7.1'
-  s.add_dependency 'public_suffix',   '>= 2'
-  s.add_dependency 'rack',            '>= 1.3.6'
+  s.add_dependency 'activerecord',    '>= 5.0.0', '< 6.1'
+  s.add_dependency 'parallel',        '< 2.0'
+  s.add_dependency 'public_suffix',   '>= 2.0.5', '< 5.0'
+  s.add_dependency 'rack',            '>= 1.3.6', '< 3.0'
 
-  s.add_development_dependency 'appraisal'
-  s.add_development_dependency 'bundler',      '>= 1.3', '< 2.0'
+  s.add_development_dependency 'appraisal',    '~> 2.2'
+  s.add_development_dependency 'bundler',      '>= 1.3', '< 3.0'
   s.add_development_dependency 'capybara',     '~> 2.0'
   s.add_development_dependency 'rake',         '~> 0.9'
   s.add_development_dependency 'rspec',        '~> 3.4'
@@ -38,10 +46,9 @@ Gem::Specification.new do |s|
     s.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
     s.add_development_dependency 'jdbc-mysql'
     s.add_development_dependency 'jdbc-postgres'
-    s.add_development_dependency 'jruby-openssl'
   else
-    s.add_development_dependency 'mysql2'
-    s.add_development_dependency 'pg'
+    s.add_development_dependency 'mysql2',  '~> 0.5'
+    s.add_development_dependency 'pg',      '~> 1.2'
     s.add_development_dependency 'sqlite3', '~> 1.3.6'
   end
 end

data/gemfiles/rails_4_2.gemfile

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", "~> 4.2.0"
+gem 'rails', '~> 4.2.0'
 
 group :local do
-  gem "pry"
-  gem "guard-rspec", "~> 4.2"
+  gem 'guard-rspec', '~> 4.2'
+  gem 'pry'
 end
 
 platforms :ruby do
-  gem "pg", "< 1.0.0"
-  gem "mysql2", "~> 0.4.0"
+  gem 'mysql2', '~> 0.4.0'
+  gem 'pg', '< 1.0.0'
 end
 
 platforms :jruby do
-  gem "activerecord-jdbc-adapter", "~> 1.3"
-  gem "activerecord-jdbcpostgresql-adapter", "~> 1.3"
-  gem "activerecord-jdbcmysql-adapter", "~> 1.3"
+  gem 'activerecord-jdbc-adapter', '~> 1.3'
+  gem 'activerecord-jdbcmysql-adapter', '~> 1.3'
+  gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3'
 end
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_5_0.gemfile

@@ -2,11 +2,12 @@
 
 source "http://rubygems.org"
 
+gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.0.0"
 
 group :local do
-  gem "pry"
   gem "guard-rspec", "~> 4.2"
+  gem "pry"
 end
 
 platforms :ruby do

data/gemfiles/rails_5_1.gemfile

@@ -2,11 +2,12 @@
 
 source "http://rubygems.org"
 
+gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.1.0"
 
 group :local do
-  gem "pry"
   gem "guard-rspec", "~> 4.2"
+  gem "pry"
 end
 
 platforms :ruby do

data/gemfiles/rails_5_2.gemfile

@@ -2,11 +2,12 @@
 
 source "http://rubygems.org"
 
+gem "perx-rubocop", "~> 0.0.3"
 gem "rails", "~> 5.2.0"
 
 group :local do
-  gem "pry"
   gem "guard-rspec", "~> 4.2"
+  gem "pry"
 end
 
 platforms :jruby do

data/gemfiles/rails_6_0.gemfile

@@ -2,11 +2,12 @@
 
 source "http://rubygems.org"
 
-gem "rails", "~> 6.0.0.rc1"
+gem "perx-rubocop", "~> 0.0.3"
+gem "rails", "~> 6.0.0"
 
 group :local do
-  gem "pry"
   gem "guard-rspec", "~> 4.2"
+  gem "pry"
 end
 
 platforms :ruby do
@@ -14,9 +15,9 @@ platforms :ruby do
 end
 
 platforms :jruby do
-  gem "activerecord-jdbc-adapter", "~> 60.0.rc1"
-  gem "activerecord-jdbcpostgresql-adapter", "~> 60.0.rc1"
-  gem "activerecord-jdbcmysql-adapter", "~> 60.0.rc1"
+  gem "activerecord-jdbc-adapter", "~> 60.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 60.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 60.0"
 end
 
 gemspec path: "../"

data/gemfiles/rails_master.gemfile

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

data/lib/apartment.rb

@@ -1,22 +1,45 @@
+# frozen_string_literal: true
+
 require 'apartment/railtie' if defined?(Rails)
 require 'active_support/core_ext/object/blank'
 require 'forwardable'
 require 'active_record'
 require 'apartment/tenant'
 
-module Apartment
+# require_relative 'apartment/arel/visitors/postgresql'
 
-  class << self
+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')
+  require_relative 'apartment/active_record/schema_migration'
+  require_relative 'apartment/active_record/internal_metadata'
+end
 
+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 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
+                        persistent_schemas connection_class
+                        db_migrate_tenants seed_data_file
+                        parallel_migration_threads pg_excluded_names].freeze
 
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
 
-    def_delegators :connection_class, :connection, :connection_config, :establish_connection
+    if ActiveRecord.version.release >= Gem::Version.new('6.1')
+      def_delegators :connection_class, :connection, :connection_db_config, :establish_connection
+
+      def connection_config
+        connection_db_config.configuration_hash
+      end
+    else
+      def_delegators :connection_class, :connection, :connection_config, :establish_connection
+    end
 
     # configure apartment with available options
     def configure
@@ -31,8 +54,12 @@ 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).with_indifferent_access
+      (tenants_with_config[tenant] || connection_config)
     end
 
     # Whether or not db:migrate should also migrate tenants
@@ -48,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 || []
@@ -75,7 +96,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 +105,14 @@ 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 do |method|
+        remove_instance_variable(:"@#{method}") if instance_variable_defined?(:"@#{method}")
+      end
     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/apartment/active_record/connection_handling.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionHandling
+    def connected_to_with_tenant(database: nil, role: nil, prevent_writes: false, &blk)
+      current_tenant = Apartment::Tenant.current
+
+      connected_to_without_tenant(database: database, role: role, prevent_writes: prevent_writes) do
+        Apartment::Tenant.switch!(current_tenant)
+        yield(blk)
+      end
+    end
+
+    alias connected_to_without_tenant connected_to
+    alias connected_to connected_to_with_tenant
+  end
+end

data/lib/apartment/active_record/internal_metadata.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# rubocop:disable Rails/ApplicationRecord
+class InternalMetadata < ActiveRecord::Base # :nodoc:
+  class << self
+    def table_exists?
+      connection.table_exists?(table_name)
+    end
+  end
+end
+# rubocop:enable Rails/ApplicationRecord