ros-apartment 2.3.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea7b5564bca9125cfb7b8a7863793c69a3462dabd8211d274891b79a948c28f5
-  data.tar.gz: c502a0c3dccdd4edca005b68b6e945d82a6943716d917ef2df2e6fa91d2a2204
+  metadata.gz: 7c5ea61531091303bdf3ab60326eadb7ffda6ea92b03079fd8a93583067037c7
+  data.tar.gz: 95c482e8304a914d6098f1f4ea498f93e1a4827d851e4ea4a283f18ca51079ae
 SHA512:
-  metadata.gz: c1babac9d50b907b36337157870ab606291a91cb022a80b11a1e3f008301f2a1b019137fb8ea03119e2a054b97041d4e532191142fff97eee3ad27cc30b10a0c
-  data.tar.gz: 7cee77bbe095d7f2d8b3a64468b5730d719152d5ec904ab15261b49366bc113dbb97f7b4a1297535c4c294d8b8099090f542ae315a2744fe55d1fb19895b4615
+  metadata.gz: '09f36cbd0d164f3f692aaf9b2a60b55aa5289537b07c299e49d651a1f1fe6aba6a8d67578076ccad94c2ad62bcaf46e74900c532664f696d1dd4ae673fb49d1d'
+  data.tar.gz: b38b9708487fa0e64c93d8349f922dafe2678b09020f5c5a5e77aca5acff4510254737094636d3c25a03e57e76280a20c403fe4021b6e64bcb3e9956b4a77acb

data/.pryrc

@@ -1,3 +1,5 @@
-if defined?(Rails) && Rails.env
-  extend Rails::ConsoleMethods
-end
+# frozen_string_literal: true
+
+# rubocop:disable Style/MixinUsage
+extend Rails::ConsoleMethods if defined?(Rails) && Rails.env
+# rubocop:enable Style/MixinUsage

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  perx-rubocop:
+    - default.yml
+
+AllCops:
+  Exclude:
+    - 'gemfiles/**/*.gemfile'
+    - 'gemfiles/vendor/**/*'
+
+Style/WordArray:
+  Exclude:
+    - spec/schemas/**/*.rb
+
+Style/NumericLiterals:
+  Exclude:
+    - spec/schemas/**/*.rb
+
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - spec/schemas/**/*.rb

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-02-16 15:36:55 +0800 using RuboCop version 0.77.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 33
+
+# Offense count: 11
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 176
+
+# Offense count: 18
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 200
+
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 24

data/.story_branch.yml

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

data/.travis.yml

@@ -4,62 +4,46 @@ language: ruby
 services:
   - docker
 rvm:
-  - jruby-9.1.17.0
-  - 2.1.9
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - 2.6.2
+  - jruby-9.2.11.0
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+  - jruby-head
   - ruby-head
+
+branches:
+  only:
+    - master
+    - development
+
 gemfile:
-  - gemfiles/rails_4_2.gemfile
   - gemfiles/rails_5_0.gemfile
   - gemfiles/rails_5_1.gemfile
   - gemfiles/rails_5_2.gemfile
   - gemfiles/rails_6_0.gemfile
   - gemfiles/rails_master.gemfile
+
 bundler_args: --without local
 before_install:
   - sudo /etc/init.d/mysql stop
   - sudo /etc/init.d/postgresql stop
   - docker-compose up -d
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem uninstall bundler -v '>= 2' -x || true
-  - gem install bundler -v '< 2'
+
 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
     - gemfile: gemfiles/rails_master.gemfile
-    - rvm: jruby-9.1.17.0
-      gemfile: gemfiles/rails_5_0.gemfile
   exclude:
-    - rvm: 2.1.9
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 2.1.9
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.1.9
-      gemfile: gemfiles/rails_5_2.gemfile
-    - rvm: 2.1.9
-      gemfile: gemfiles/rails_6_0.gemfile
-    - rvm: 2.1.9
-      gemfile: gemfiles/rails_master.gemfile
-    - rvm: 2.2.9
-      gemfile: gemfiles/rails_6_0.gemfile
-    - rvm: 2.3.6
-      gemfile: gemfiles/rails_6_0.gemfile
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails_6_0.gemfile
-    - rvm: jruby-9.1.17.0
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: jruby-9.1.17.0
-      gemfile: gemfiles/rails_5_2.gemfile
-    - rvm: jruby-9.1.17.0
+    - rvm: 2.4.10
       gemfile: gemfiles/rails_6_0.gemfile
-    - rvm: jruby-9.1.17.0
-      gemfile: gemfiles/rails_master.gemfile
   fast_finish: true
 cache: bundler

data/Appraisals

@@ -1,20 +1,9 @@
-appraise "rails-4-2" do
-  gem "rails", "~> 4.2.0"
-  platforms :ruby do
-    gem "pg", "< 1.0.0"
-    gem "mysql2", "~> 0.4.0"
-  end
-  platforms :jruby do
-    gem 'activerecord-jdbc-adapter', '~> 1.3'
-    gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3'
-    gem 'activerecord-jdbcmysql-adapter', '~> 1.3'
-  end
-end
+# frozen_string_literal: true
 
-appraise "rails-5-0" do
-  gem "rails", "~> 5.0.0"
+appraise 'rails-5-0' do
+  gem 'rails', '~> 5.0.0'
   platforms :ruby do
-    gem "pg", "< 1.0.0"
+    gem 'pg', '< 1.0.0'
   end
   platforms :jruby do
     gem 'activerecord-jdbc-adapter', '~> 50.0'
@@ -23,10 +12,10 @@ appraise "rails-5-0" do
   end
 end
 
-appraise "rails-5-1" do
-  gem "rails", "~> 5.1.0"
+appraise 'rails-5-1' do
+  gem 'rails', '~> 5.1.0'
   platforms :ruby do
-    gem "pg", "< 1.0.0"
+    gem 'pg', '< 1.0.0'
   end
   platforms :jruby do
     gem 'activerecord-jdbc-adapter', '~> 51.0'
@@ -35,8 +24,8 @@ appraise "rails-5-1" do
   end
 end
 
-appraise "rails-5-2" do
-  gem "rails", "~> 5.2.0"
+appraise 'rails-5-2' do
+  gem 'rails', '~> 5.2.0'
   platforms :jruby do
     gem 'activerecord-jdbc-adapter', '~> 52.0'
     gem 'activerecord-jdbcpostgresql-adapter', '~> 52.0'
@@ -44,22 +33,20 @@ appraise "rails-5-2" do
   end
 end
 
-
-appraise "rails-6-0" do
-  gem "rails", "~> 6.0.0.rc1"
+appraise 'rails-6-0' do
+  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
 end
 
-
-appraise "rails-master" do
-  gem "rails", git: 'https://github.com/rails/rails.git'
+appraise 'rails-master' do
+  gem 'rails', git: 'https://github.com/rails/rails.git'
   platforms :ruby do
     gem 'sqlite3', '~> 1.4'
   end

data/Gemfile

@@ -1,10 +1,13 @@
-source 'http://rubygems.org'
+# frozen_string_literal: true
+
+source 'https://my.diffend.io/protect/gems'
 
 gemspec
 
+gem 'perx-rubocop', '~> 0.0.3'
 gem 'rails', '>= 3.1.2'
 
 group :local do
-  gem 'pry'
   gem 'guard-rspec', '~> 4.2'
+  gem 'pry'
 end

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
@@ -5,7 +7,7 @@ guard :rspec do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/apartment/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
   watch(%r{^lib/apartment/(.+)\.rb$})     { |m| "spec/integration/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb') { 'spec' }
 
   # # Rails example
   # watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }

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

@@ -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
@@ -229,7 +229,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 +289,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 +324,20 @@ 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|
+  tenant_presence_check = false
+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 +355,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 +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
@@ -436,18 +484,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
@@ -569,6 +605,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).