ros-apartment 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea7b5564bca9125cfb7b8a7863793c69a3462dabd8211d274891b79a948c28f5
-  data.tar.gz: c502a0c3dccdd4edca005b68b6e945d82a6943716d917ef2df2e6fa91d2a2204
+  metadata.gz: 885fc6d80e82f41a7e4a0ab4c6aea81859c39ffbc35454394430168c3d82a378
+  data.tar.gz: 92df175aec9c46552f8d0d68d154fcc89adc3ae40512c3e2ce9ad1c7d891371e
 SHA512:
-  metadata.gz: c1babac9d50b907b36337157870ab606291a91cb022a80b11a1e3f008301f2a1b019137fb8ea03119e2a054b97041d4e532191142fff97eee3ad27cc30b10a0c
-  data.tar.gz: 7cee77bbe095d7f2d8b3a64468b5730d719152d5ec904ab15261b49366bc113dbb97f7b4a1297535c4c294d8b8099090f542ae315a2744fe55d1fb19895b4615
+  metadata.gz: 60a71a3fa90048da38722e43eb60a8345303aa3131127300a9cab4224f9aeaf6e655022b4fce3c1bb49a9f687b98e79949e29a562bac366bed477aae905d6df7
+  data.tar.gz: 54836f74344304e196678b1d23c07ad9e293f7630651418d9a792cc0d066c619b792e1226426314d8f4969c2e8902321f1f8d47616d0c813f3e09e67b522f99e

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

@@ -0,0 +1,22 @@
+name: Rubocop Lint
+
+on: [push]
+
+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,17 @@
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  perx-rubocop:
+    - default.yml
+
+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: 237
+
+# 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,7 +4,7 @@ language: ruby
 services:
   - docker
 rvm:
-  - jruby-9.1.17.0
+  - jruby-9.2.11.0
   - 2.1.9
   - 2.2.9
   - 2.3.6
@@ -12,6 +12,12 @@ rvm:
   - 2.5.0
   - 2.6.2
   - ruby-head
+
+branches:
+  only:
+    - master
+    - development
+
 gemfile:
   - gemfiles/rails_4_2.gemfile
   - gemfiles/rails_5_0.gemfile
@@ -34,8 +40,11 @@ jobs:
   allow_failures:
     - rvm: ruby-head
     - gemfile: gemfiles/rails_master.gemfile
-    - rvm: jruby-9.1.17.0
-      gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: 2.2.9
+      gemfile: gemfiles/rails_5_2.gemfile
+    # JRuby does not provide support for anything below rails 5
+    - rvm: jruby-9.2.11.0
+      gemfile: gemfiles/rails_4_2.gemfile
   exclude:
     - rvm: 2.1.9
       gemfile: gemfiles/rails_5_0.gemfile
@@ -53,13 +62,5 @@ jobs:
       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
-      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,8 +1,10 @@
-appraise "rails-4-2" do
-  gem "rails", "~> 4.2.0"
+# frozen_string_literal: true
+
+appraise 'rails-4-2' do
+  gem 'rails', '~> 4.2.0'
   platforms :ruby do
-    gem "pg", "< 1.0.0"
-    gem "mysql2", "~> 0.4.0"
+    gem 'pg', '< 1.0.0'
+    gem 'mysql2', '~> 0.4.0'
   end
   platforms :jruby do
     gem 'activerecord-jdbc-adapter', '~> 1.3'
@@ -11,10 +13,10 @@ appraise "rails-4-2" do
   end
 end
 
-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 +25,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 +37,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,9 +46,8 @@ 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.rc1'
   platforms :ruby do
     gem 'sqlite3', '~> 1.4'
   end
@@ -57,9 +58,8 @@ appraise "rails-6-0" do
   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 'rails', '>= 3.1.2'
+gem 'perx-rubocop', '~> 0.0.3'
 
 group :local do
-  gem 'pry'
   gem 'guard-rspec', '~> 4.2'
+  gem 'pry'
 end

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:
@@ -569,6 +590,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

@@ -85,6 +85,7 @@ 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']
+    params << "--port #{my_config['port']}" if my_config['port']
     %x{ mysqladmin #{params.join(' ')} create #{my_config['database']} } rescue "test db already exists"
     ActiveRecord::Base.establish_connection my_config
     migrate
@@ -97,6 +98,7 @@ 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']
+    params << "--port #{my_config['port']}" if my_config['port']
     %x{ mysqladmin #{params.join(' ')} drop #{my_config['database']} --force}
   end
 

data/apartment.gemspec

@@ -21,11 +21,11 @@ Gem::Specification.new do |s|
 
   # 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 '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 'appraisal',    '~> 2.2'
   s.add_development_dependency 'bundler',      '>= 1.3', '< 2.0'
   s.add_development_dependency 'capybara',     '~> 2.0'
   s.add_development_dependency 'rake',         '~> 0.9'
@@ -40,8 +40,8 @@ Gem::Specification.new do |s|
     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

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", "~> 5.0.0"
+gem 'rails', '~> 5.0.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 'pg', '< 1.0.0'
 end
 
 platforms :jruby do
-  gem "activerecord-jdbc-adapter", "~> 50.0"
-  gem "activerecord-jdbcpostgresql-adapter", "~> 50.0"
-  gem "activerecord-jdbcmysql-adapter", "~> 50.0"
+  gem 'activerecord-jdbc-adapter', '~> 50.0'
+  gem 'activerecord-jdbcmysql-adapter', '~> 50.0'
+  gem 'activerecord-jdbcpostgresql-adapter', '~> 50.0'
 end
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_5_1.gemfile

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", "~> 5.1.0"
+gem 'rails', '~> 5.1.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 'pg', '< 1.0.0'
 end
 
 platforms :jruby do
-  gem "activerecord-jdbc-adapter", "~> 51.0"
-  gem "activerecord-jdbcpostgresql-adapter", "~> 51.0"
-  gem "activerecord-jdbcmysql-adapter", "~> 51.0"
+  gem 'activerecord-jdbc-adapter', '~> 51.0'
+  gem 'activerecord-jdbcmysql-adapter', '~> 51.0'
+  gem 'activerecord-jdbcpostgresql-adapter', '~> 51.0'
 end
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_5_2.gemfile

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", "~> 5.2.0"
+gem 'rails', '~> 5.2.0'
 
 group :local do
-  gem "pry"
-  gem "guard-rspec", "~> 4.2"
+  gem 'guard-rspec', '~> 4.2'
+  gem 'pry'
 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', '~> 52.0'
+  gem 'activerecord-jdbcmysql-adapter', '~> 52.0'
+  gem 'activerecord-jdbcpostgresql-adapter', '~> 52.0'
 end
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_6_0.gemfile

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", "~> 6.0.0.rc1"
+gem 'rails', '~> 6.0.0.rc1'
 
 group :local do
-  gem "pry"
-  gem "guard-rspec", "~> 4.2"
+  gem 'guard-rspec', '~> 4.2'
+  gem 'pry'
 end
 
 platforms :ruby do
-  gem "sqlite3", "~> 1.4"
+  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.rc1'
+  gem 'activerecord-jdbcmysql-adapter', '~> 60.0.rc1'
+  gem 'activerecord-jdbcpostgresql-adapter', '~> 60.0.rc1'
 end
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_master.gemfile

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", git: "https://github.com/rails/rails.git"
+gem 'rails', git: 'https://github.com/rails/rails.git'
 
 group :local do
-  gem "pry"
-  gem "guard-rspec", "~> 4.2"
+  gem 'guard-rspec', '~> 4.2'
+  gem 'pry'
 end
 
 platforms :ruby do
-  gem "sqlite3", "~> 1.4"
+  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', '~> 52.0'
+  gem 'activerecord-jdbcmysql-adapter', '~> 52.0'
+  gem 'activerecord-jdbcpostgresql-adapter', '~> 52.0'
 end
 
-gemspec path: "../"
+gemspec path: '../'