ros-apartment 2.3.0.alpha2 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34315580882fc1aba022c3e274f51e72c3cd5feef66f655dad4ce82cacec1aa3
-  data.tar.gz: 7e970b07d5467167efc9b49e6d7f8b69c0f28c2fbccff63f0137e5b7664b0b4f
+  metadata.gz: e57016e050d57190e3baa0693ccd7e2e094db1cdb864f9c75e193ce06fcdddbb
+  data.tar.gz: 65b587e5c59e03e957e42c8ca0c0cf4d078859e078eebdcda4594e69284c3175
 SHA512:
-  metadata.gz: 3b77d009ba12644e49099928f74811a5ca56d6142a08c35cbd21fc34d1aa0c6fc1e94a8165aae35593b235bffb81dccb9627f44bdc7944e6470e6c123db8c3b7
-  data.tar.gz: 1590e8e67d2af1651986c2ce19da2d3aaa474e30f37b1039b59ca1bb302c24124e4eacf320fb7c11b6a415957bb7130ed108959dc3deebc6663c8b78d8349262
+  metadata.gz: d1ebfaf0a5e4da01bceed2f3cec330aefec6bbfdb5e98dd706ec7b0305cb8bc820e58106ebb60854fc7f5d8735c02d426c87a17a9f16c4b12f34104059644419
+  data.tar.gz: 1a72b322cf5913313aedfb1f84d3117c5cbbd5ba36a7b62ab1cf10d2e3987d8eca8b465cfc38538b86482a08fd8412e43e1d39708d3a952e4fad8c946b0b0203

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

@@ -0,0 +1,22 @@
+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 }}

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,21 @@
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  perx-rubocop:
+    - default.yml
+
+AllCops:
+  Exclude:
+    - 'gemfiles/**/*.gemfile'
+
+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,4 @@
+---
+tracker: github
+project_id:
+- rails-on-services/apartment

data/.travis.yml

@@ -4,62 +4,41 @@ 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:
   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 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 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,10 @@
+# 2.3.0
+  * January 3, 2020
+
+## Added
+  - Basic support for rails 6
+  - Released different gem name, with same API as apartment
+
 # 2.2.1
   * June 19, 2019
 

data/README.md

@@ -1,10 +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)
-
-# NOT ACTIVELY MAINTAINED YET. SOLELY FOR TESTING PURPOSES ATM
+[![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*
 
@@ -12,26 +10,21 @@ Apartment provides tools to help you deal with multiple tenants in your Rails
 application. If you need to have certain data sequestered based on account or company,
 but still allow some data to exist in a common tenant, Apartment can help.
 
-## HELP!
-
-In order to help drive the direction of development and clean up the codebase, we'd like to take a poll
-on how people are currently using Apartment. If you can take 5 seconds (1 question) to answer
-this poll, we'd greatly appreciated it.
-
-[View Poll](http://www.poll-maker.com/poll391552x4Bfb41a9-15)
+## Apartment drop in replacement gem
 
-## Excessive Memory Issues on ActiveRecord 4.x
+After having reached out via github issues and email directly, no replies ever
+came. Since we wanted to upgrade our application to Rails 6 we decided to fork
+and start some development to support Rails 6. Because we don't have access
+to the apartment gem itself, the solution was to release it under a different
+name but providing the exact same API as it was before.
 
-> If you're noticing ever growing memory issues (ie growing with each tenant you add)
-> when using Apartment, that's because there's [an issue](https://github.com/rails/rails/issues/19578)
-> with how ActiveRecord maps Postgresql data types into AR data types.
-> This has been patched and will be released for AR 4.2.2. It's apparently hard
-> to backport to 4.1 unfortunately.
-> If you're noticing high memory usage from ActiveRecord with Apartment please upgrade.
+## Help wanted
 
-```ruby
-gem 'rails', '4.2.1', github: 'influitive/rails', tag: 'v4.2.1.memfix'
-```
+We were never involved with the development of Apartment gem in the first place
+and this project started out of our own needs. We will be more than happy
+to collaborate to maintain the gem alive and supporting the latest versions
+of ruby and rails, but your help is appreciated. Either by reporting bugs you
+may find or proposing improvements to the gem itself. Feel free to reach out.
 
 ## Installation
 
@@ -40,7 +33,7 @@ gem 'rails', '4.2.1', github: 'influitive/rails', tag: 'v4.2.1.memfix'
 Add the following to your Gemfile:
 
 ```ruby
-gem 'apartment'
+gem 'ros-apartment', require: 'apartment'
 ```
 
 Then generate your `Apartment` config file using
@@ -236,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
 ```
@@ -296,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:
@@ -310,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:
@@ -327,7 +355,20 @@ 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_schema
 
 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:
 
@@ -337,7 +378,7 @@ config.default_schema = "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:
 
@@ -443,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
@@ -533,7 +562,12 @@ end
 
 ## Background workers
 
-See [apartment-sidekiq](https://github.com/influitive/apartment-sidekiq) or [apartment-activejob](https://github.com/influitive/apartment-activejob).
+Both these gems have been forked as a side consequence of having a new gem name.
+You can use them exactly as you were using before. They are, just like this one
+a drop-in replacement.
+
+See [apartment-sidekiq](https://github.com/rails-on-services/apartment-sidekiq)
+or [apartment-activejob](https://github.com/rails-on-services/apartment-activejob).
 
 ## Callbacks
 
@@ -571,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).