ros-apartment 2.3.0 → 2.11.0

data/README.md

@@ -1,8 +1,8 @@
 # Apartment
 
-[![Gem Version](https://badge.fury.io/rb/apartment.svg)](https://badge.fury.io/rb/apartment)
-[![Code Climate](https://codeclimate.com/github/influitive/apartment/badges/gpa.svg)](https://codeclimate.com/github/influitive/apartment)
-[![Build Status](https://travis-ci.org/influitive/apartment.svg?branch=development)](https://travis-ci.org/influitive/apartment)
+[![Gem Version](https://badge.fury.io/rb/ros-apartment.svg)](https://badge.fury.io/rb/apartment)
+[![Code Climate](https://api.codeclimate.com/v1/badges/b0dc327380bb8438f991/maintainability)](https://codeclimate.com/github/rails-on-services/apartment/maintainability)
+[![Build Status](https://travis-ci.org/rails-on-services/apartment.svg?branch=development)](https://travis-ci.org/rails-on-services/apartment)
 
 *Multitenancy for Rails and ActiveRecord*
 
@@ -33,7 +33,7 @@ may find or proposing improvements to the gem itself. Feel free to reach out.
 Add the following to your Gemfile:
 
 ```ruby
-gem 'ros-apartment'
+gem 'ros-apartment', require: 'apartment'
 ```
 
 Then generate your `Apartment` config file using
@@ -101,6 +101,16 @@ switched back at the end of the block to what it was before.
 There is also `switch!` which doesn't take a block, but it's recommended to use `switch`.
 To return to the default tenant, you can call `switch` with no arguments.
 
+#### Multiple Tenants
+
+When using schemas, you can also pass in a list of schemas if desired. Any tables defined in a schema earlier in the chain will be referenced first, so this is only useful if you have a schema with only some of the tables defined:
+
+```ruby
+Apartment::Tenant.switch(['tenant_1', 'tenant_2']) do
+  # ...
+end
+```
+
 ### Switching Tenants per request
 
 You can have Apartment route to the appropriate tenant by adding some Rack middleware.
@@ -229,7 +239,7 @@ A Generic Elevator exists that allows you to pass a `Proc` (or anything that res
 module MyApplication
   class Application < Rails::Application
     # Obviously not a contrived example
-    config.middleware.use Apartment::Elevators::Generic, Proc.new { |request| request.host.reverse }
+    config.middleware.use Apartment::Elevators::Generic, proc { |request| request.host.reverse }
   end
 end
 ```
@@ -289,6 +299,27 @@ Apartment::Tenant.drop('tenant_name')
 
 When method is called, the schema is dropped and all data from itself will be lost. Be careful with this method.
 
+### Custom Prompt
+
+#### Console methods
+
+`ros-apartment` console configures two helper methods:
+1. `tenant_list` - list available tenants while using the console
+2. `st(tenant_name:String)` - Switches the context to the tenant name passed, if
+it exists.
+
+#### Custom printed prompt
+
+`ros-apartment` also has a custom prompt that gives a bit more information about
+the context in which you're running. It shows the environment as well as the tenant
+that is currently switched to. In order for you to enable this, you need to require
+the custom console in your application.
+
+In `application.rb` add `require 'apartment/custom_console'`.
+Please note that we rely on `pry-rails` to edit the prompt, thus your project needs
+to install it as well. In order to do so, you need to add `gem 'pry-rails'` to your
+project's gemfile.
+
 ## Config
 
 The following config options should be set up in a Rails initializer such as:
@@ -303,6 +334,37 @@ Apartment.configure do |config|
 end
 ```
 
+### Skip tenant schema check
+
+This is configurable by setting: `tenant_presence_check`. It defaults to true
+in order to maintain the original gem behavior. This is only checked when using one of the PostgreSQL adapters.
+The original gem behavior, when running `switch` would look for the existence of the schema before switching. This adds an extra query on every context switch. While in the default simple scenarios this is a valid check, in high volume platforms this adds some unnecessary overhead which can be detected in some other ways on the application level.
+
+Setting this configuration value to `false` will disable the schema presence check before trying to switch the context.
+
+```ruby
+Apartment.configure do |config|
+  config.tenant_presence_check = false
+end
+```
+
+### Additional logging information
+
+Enabling this configuration will output the database that the process is currently connected to as well as which
+schemas are in the search path. This can be enabled by setting to true the `active_record_log` configuration.
+
+Please note that our custom logger inherits from `ActiveRecord::LogSubscriber` so this will be required for the configuration to work.
+
+**Example log output:**
+
+<img src="documentation/images/log_example.png">
+
+```ruby
+Apartment.configure do |config|
+  config.active_record_log = true
+end
+```
+
 ### Excluding models
 
 If you have some models that should always access the 'public' tenant, you can specify this by configuring Apartment using `Apartment.configure`. This will yield a config object for you. You can set excluded models like so:
@@ -320,17 +382,30 @@ Rails will always access the 'public' tenant when accessing these models, but no
 
 ### Postgresql Schemas
 
-## Providing a Different default_schema
+#### Alternative: Creating new schemas by using raw SQL dumps
+
+Apartment can be forced to use raw SQL dumps insted of `schema.rb` for creating new schemas. Use this when you are using some extra features in postgres that can't be represented in `schema.rb`, like materialized views etc.
+
+This only applies while using postgres adapter and `config.use_schemas` is set to `true`.
+(Note: this option doesn't use `db/structure.sql`, it creates SQL dump by executing `pg_dump`)
+
+Enable this option with:
+
+```ruby
+config.use_sql = true
+```
+
+### 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.
 
-## Persistent Schemas
+### Persistent Schemas
 
 Apartment will normally just switch the `schema_search_path` whole hog to the one passed in. This can lead to problems if you want other schemas to always be searched as well. Enter `persistent_schemas`. You can configure a list of other schemas that will always remain in the search path, while the default gets swapped out:
 
@@ -398,7 +473,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
@@ -436,18 +511,6 @@ schema in the `search_path` at all times. We won't be able to do this though unt
 also contain the tenanted tables, which is an open issue with no real milestone to be completed.
 Happy to accept PR's on the matter.
 
-#### Alternative: Creating new schemas by using raw SQL dumps
-
-Apartment can be forced to use raw SQL dumps insted of `schema.rb` for creating new schemas. Use this when you are using some extra features in postgres that can't be represented in `schema.rb`, like materialized views etc.
-
-This only applies while using postgres adapter and `config.use_schemas` is set to `true`.
-(Note: this option doesn't use `db/structure.sql`, it creates SQL dump by executing `pg_dump`)
-
-Enable this option with:
-```ruby
-config.use_sql = true
-```
-
 ### Managing Migrations
 
 In order to migrate all of your tenants (or postgresql schemas) you need to provide a list
@@ -558,6 +621,16 @@ module Apartment
 end
 ```
 
+## Running rails console without a connection to the database
+
+By default, once apartment starts, it establishes a connection to the database. It is possible to
+disable this initial connection, by running with `APARTMENT_DISABLE_INIT` set to something:
+
+```shell
+$ APARTMENT_DISABLE_INIT=true DATABASE_URL=postgresql://localhost:1234/buk_development bin/rails runner 'puts 1'
+# 1
+```
+
 ## Contributing
 
 * In both `spec/dummy/config` and `spec/config`, you will see `database.yml.sample` files
@@ -569,6 +642,13 @@ end
 
 * If you're looking to help, check out the TODO file for some upcoming changes I'd like to implement in Apartment.
 
+### Running bundle install
+
+mysql2 gem in some cases fails to install.
+If you face problems running bundle install in OSX, try installing the gem running:
+
+`gem install mysql2 -v '0.5.3' -- --with-ldflags=-L/usr/local/opt/openssl/lib --with-cppflags=-I/usr/local/opt/openssl/include`
+
 ## License
 
 Apartment is released under the [MIT License](http://www.opensource.org/licenses/MIT).

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,36 @@ 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)
+    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
 
 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 +83,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 +97,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/gemfiles/rails_5_2.gemfile

@@ -4,11 +4,6 @@ source "http://rubygems.org"
 
 gem "rails", "~> 5.2.0"
 
-group :local do
-  gem "pry"
-  gem "guard-rspec", "~> 4.2"
-end
-
 platforms :jruby do
   gem "activerecord-jdbc-adapter", "~> 52.0"
   gem "activerecord-jdbcpostgresql-adapter", "~> 52.0"

data/gemfiles/rails_6_0.gemfile

@@ -2,21 +2,16 @@
 
 source "http://rubygems.org"
 
-gem "rails", "~> 6.0.0.rc1"
-
-group :local do
-  gem "pry"
-  gem "guard-rspec", "~> 4.2"
-end
+gem "rails", "~> 6.0.0"
 
 platforms :ruby do
   gem "sqlite3", "~> 1.4"
 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_6_1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+
+platforms :ruby do
+  gem "sqlite3", "~> 1.4"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 61.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 61.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 61.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_7_0.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+
+platforms :ruby do
+  gem "sqlite3", "~> 1.4"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 61.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 61.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 61.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_master.gemfile

@@ -4,19 +4,14 @@ source "http://rubygems.org"
 
 gem "rails", git: "https://github.com/rails/rails.git"
 
-group :local do
-  gem "pry"
-  gem "guard-rspec", "~> 4.2"
-end
-
 platforms :ruby do
   gem "sqlite3", "~> 1.4"
 end
 
 platforms :jruby do
-  gem "activerecord-jdbc-adapter", "~> 52.0"
-  gem "activerecord-jdbcpostgresql-adapter", "~> 52.0"
-  gem "activerecord-jdbcmysql-adapter", "~> 52.0"
+  gem "activerecord-jdbc-adapter", "~> 61.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 61.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 61.0"
 end
 
 gemspec path: "../"

data/lib/apartment/active_record/connection_handling.rb

@@ -0,0 +1,20 @@
+# 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
+
+      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,9 @@
+# frozen_string_literal: true
+
+class InternalMetadata < ActiveRecord::Base # :nodoc:
+  class << self
+    def table_exists?
+      connection.table_exists?(table_name)
+    end
+  end
+end

data/lib/apartment/active_record/postgresql_adapter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/ClassAndModuleChildren
+
+# NOTE: This patch is meant to remove any schema_prefix appart from the ones for
+# excluded models. The schema_prefix would be resolved by apartment's setting
+# of search path
+module Apartment::PostgreSqlAdapterPatch
+  def default_sequence_name(table, _column)
+    res = super
+    schema_prefix = "#{Apartment::Tenant.current}."
+    default_tenant_prefix = "#{Apartment::Tenant.default_tenant}."
+
+    # NOTE: Excluded models should always access the sequence from the default
+    # tenant schema
+    if excluded_model?(table)
+      res.sub!(schema_prefix, default_tenant_prefix) if schema_prefix != default_tenant_prefix
+      return res
+    end
+
+    res.delete_prefix!(schema_prefix) if res&.starts_with?(schema_prefix)
+
+    res
+  end
+
+  private
+
+  def excluded_model?(table)
+    Apartment.excluded_models.any? { |m| m.constantize.table_name == table }
+  end
+end
+
+require 'active_record/connection_adapters/postgresql_adapter'
+
+# NOTE: inject this into postgresql adapters
+class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+  include Apartment::PostgreSqlAdapterPatch
+end
+# rubocop:enable Style/ClassAndModuleChildren

data/lib/apartment/active_record/schema_migration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  class SchemaMigration < ActiveRecord::Base # :nodoc:
+    class << self
+      def table_exists?
+        connection.table_exists?(table_name)
+      end
+    end
+  end
+end