ros-apartment 2.4.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 885fc6d80e82f41a7e4a0ab4c6aea81859c39ffbc35454394430168c3d82a378
-  data.tar.gz: 92df175aec9c46552f8d0d68d154fcc89adc3ae40512c3e2ce9ad1c7d891371e
+  metadata.gz: f2dcb62b879236f8522148786e9ef35dc10b59be747f5e4cd0e9b0d515add9de
+  data.tar.gz: 33cc4f75fbe99a1ec29e6370cee9a83cd9a8ee59b0657ada7ce6f2b0cbd87524
 SHA512:
-  metadata.gz: 60a71a3fa90048da38722e43eb60a8345303aa3131127300a9cab4224f9aeaf6e655022b4fce3c1bb49a9f687b98e79949e29a562bac366bed477aae905d6df7
-  data.tar.gz: 54836f74344304e196678b1d23c07ad9e293f7630651418d9a792cc0d066c619b792e1226426314d8f4969c2e8902321f1f8d47616d0c813f3e09e67b522f99e
+  metadata.gz: 3b4fbc349f3d9198c85914667335662c7d3bc8c64a1c6fa0397b417e4d451247eeb18e44a6949d2f79647889a20542f64c0b25de2d700cb9cf6459e2a2120d80
+  data.tar.gz: 4b5057afb829f973b0234a04136f0f470b38f7b52e2dc96ccdc7d88f70c1d949c06b5195d41da5a74b6460cd23c5a3b0393dc38be21eb5d69d66caa3507746b6

data/.rubocop.yml

@@ -4,6 +4,11 @@ inherit_gem:
   perx-rubocop:
     - default.yml
 
+AllCops:
+  Exclude:
+    - 'gemfiles/**/*.gemfile'
+    - 'gemfiles/vendor/**/*'
+
 Style/WordArray:
   Exclude:
     - spec/schemas/**/*.rb

data/.rubocop_todo.yml

@@ -21,7 +21,7 @@ Metrics/BlockLength:
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 237
+  Max: 200
 
 # Offense count: 4
 # Configuration parameters: CountComments, ExcludedMethods.

data/.story_branch.yml

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

data/.travis.yml

@@ -5,12 +5,11 @@ services:
   - docker
 rvm:
   - jruby-9.2.11.0
-  - 2.1.9
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - 2.6.2
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+  - jruby-head
   - ruby-head
 
 branches:
@@ -19,48 +18,32 @@ branches:
     - 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: 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
-    - 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
+    - rvm: 2.4.10
       gemfile: gemfiles/rails_6_0.gemfile
   fast_finish: true
 cache: bundler

data/Appraisals

@@ -1,18 +1,5 @@
 # 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'
-  end
-  platforms :jruby do
-    gem 'activerecord-jdbc-adapter', '~> 1.3'
-    gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3'
-    gem 'activerecord-jdbcmysql-adapter', '~> 1.3'
-  end
-end
-
 appraise 'rails-5-0' do
   gem 'rails', '~> 5.0.0'
   platforms :ruby do
@@ -47,14 +34,14 @@ appraise 'rails-5-2' do
 end
 
 appraise 'rails-6-0' do
-  gem 'rails', '~> 6.0.0.rc1'
+  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
 

data/Gemfile

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

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,93 @@
+# 2.7.1
+
+# Enhancements
+
+-   N/a
+
+# Bugfixes
+
+-   [Resolves #82] Enhanced db:create breaks plugin compatibility - <https://github.com/rails-on-services/apartment/pull/83>
+
+# Chores
+
+-   Update rake version in development
+-   Renamed gemspec to match gem name
+
+# 2.7.0
+
+# Enhancements
+
+-   [Resolves #70] Rake tasks define methods on main - <https://github.com/rails-on-services/apartment/pull/75>
+-   Add database and schema to active record log. Configurable, defaults to false to keep current behavior - <https://github.com/rails-on-services/apartment/pull/55>
+
+# Bugfixes
+
+-   [Fixes #61] Fix database create in mysql - <https://github.com/rails-on-services/apartment/pull/76>
+
+# Chores
+
+-   Remove deprecated tld_length config option: tld_length was removed in influitive#309, this configuration option doesn't have any effect now. - <https://github.com/rails-on-services/apartment/pull/72>
+-   Using [diffend.io proxy](https://diffend.io) to safely check required gems
+-   Added [story branch](https://github.com/story-branch/story_branch) to the configuration
+-   Using travis-ci to run rubocop as well, replacing github actions: github actions do not work in fork's PRs
+
+# 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

@@ -324,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:
@@ -341,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:
 
@@ -419,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
@@ -457,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

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
@@ -86,12 +95,16 @@ namespace :mysql do
     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"
+    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 = []
@@ -99,12 +112,11 @@ namespace :mysql do
     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}
+    `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