ros-apartment 2.3.0 → 2.4.0

data/spec/dummy_engine/test/dummy/config.ru

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application

data/spec/examples/connection_adapter_examples.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-shared_examples_for "a connection based apartment adapter" do
+shared_examples_for 'a connection based apartment adapter' do
   include Apartment::Spec::AdapterRequirements
 
-  let(:default_tenant){ subject.switch{ ActiveRecord::Base.connection.current_database } }
+  let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
 
-  describe "#init" do
+  describe '#init' do
     after do
       # Apartment::Tenant.init creates per model connection.
       # Remove the connection after testing not to unintentionally keep the connection across tests.
@@ -14,9 +16,9 @@ shared_examples_for "a connection based apartment adapter" do
       end
     end
 
-    it "should process model exclusions" do
+    it 'should process model exclusions' do
       Apartment.configure do |config|
-        config.excluded_models = ["Company"]
+        config.excluded_models = ['Company']
       end
       Apartment::Tenant.init
 
@@ -24,19 +26,19 @@ shared_examples_for "a connection based apartment adapter" do
     end
   end
 
-  describe "#drop" do
-    it "should raise an error for unknown database" do
-      expect {
+  describe '#drop' do
+    it 'should raise an error for unknown database' do
+      expect do
         subject.drop 'unknown_database'
-      }.to raise_error(Apartment::TenantNotFound)
+      end.to raise_error(Apartment::TenantNotFound)
     end
   end
 
-  describe "#switch!" do
-    it "should raise an error if database is invalid" do
-      expect {
+  describe '#switch!' do
+    it 'should raise an error if database is invalid' do
+      expect do
         subject.switch! 'unknown_database'
-      }.to raise_error(Apartment::TenantNotFound)
+      end.to raise_error(Apartment::TenantNotFound)
     end
   end
 end

data/spec/examples/generic_adapter_custom_configuration_example.rb

@@ -1,12 +1,13 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-shared_examples_for "a generic apartment adapter able to handle custom configuration" do
+require 'spec_helper'
 
+shared_examples_for 'a generic apartment adapter able to handle custom configuration' do
   let(:custom_tenant_name) { 'test_tenantwwww' }
-  let(:db) { |example| example.metadata[:database]}
+  let(:db) { |example| example.metadata[:database] }
   let(:custom_tenant_names) do
     {
-      custom_tenant_name => get_custom_db_conf
+      custom_tenant_name => custom_db_conf
     }
   end
 
@@ -19,12 +20,11 @@ shared_examples_for "a generic apartment adapter able to handle custom configura
     Apartment.with_multi_server_setup = false
   end
 
-  context "database key taken from specific config" do
+  context 'database key taken from specific config' do
+    let(:expected_args) { custom_db_conf }
 
-    let(:expected_args) { get_custom_db_conf }
-
-    describe "#create" do
-      it "should establish_connection with the separate connection with expected args" do
+    describe '#create' do
+      it 'should establish_connection with the separate connection with expected args' do
         expect(Apartment::Adapters::AbstractAdapter::SeparateDbConnectionHandler).to receive(:establish_connection).with(expected_args).and_call_original
 
         # because we dont have another server to connect to it errors
@@ -33,8 +33,8 @@ shared_examples_for "a generic apartment adapter able to handle custom configura
       end
     end
 
-    describe "#drop" do
-      it "should establish_connection with the separate connection with expected args" do
+    describe '#drop' do
+      it 'should establish_connection with the separate connection with expected args' do
         expect(Apartment::Adapters::AbstractAdapter::SeparateDbConnectionHandler).to receive(:establish_connection).with(expected_args).and_call_original
 
         # because we dont have another server to connect to it errors
@@ -44,15 +44,13 @@ shared_examples_for "a generic apartment adapter able to handle custom configura
     end
   end
 
-  context "database key from tenant name" do
-
-    let(:expected_args) {
-      get_custom_db_conf.tap {|args| args.delete(:database) }
-    }
-
-    describe "#switch!" do
+  context 'database key from tenant name' do
+    let(:expected_args) do
+      custom_db_conf.tap { |args| args.delete(:database) }
+    end
 
-      it "should connect to new db" do
+    describe '#switch!' do
+      it 'should connect to new db' do
         expect(Apartment).to receive(:establish_connection) do |args|
           db_name = args.delete(:database)
 
@@ -72,24 +70,24 @@ shared_examples_for "a generic apartment adapter able to handle custom configura
   def specific_connection
     {
       postgresql: {
-        adapter:  'postgresql',
+        adapter: 'postgresql',
         database: 'override_database',
         password: 'override_password',
         username: 'overridepostgres'
       },
       mysql: {
-        adapter:  'mysql2',
+        adapter: 'mysql2',
         database: 'override_database',
         username: 'root'
       },
       sqlite: {
-        adapter:  'sqlite3',
+        adapter: 'sqlite3',
         database: 'override_database'
       }
     }
   end
 
-  def get_custom_db_conf
+  def custom_db_conf
     specific_connection[db.to_sym].with_indifferent_access
   end
 end

data/spec/examples/generic_adapter_examples.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-shared_examples_for "a generic apartment adapter" do
+shared_examples_for 'a generic apartment adapter' do
   include Apartment::Spec::AdapterRequirements
 
-  before {
+  before do
     Apartment.prepend_environment = false
     Apartment.append_environment = false
-  }
+  end
 
-  describe "#init" do
-    it "should not retain a connection after railtie" do
+  describe '#init' do
+    it 'should not retain a connection after railtie' do
       # this test should work on rails >= 4, the connection pool code is
       # completely different for 3.2 so we'd have to have a messy conditional..
       unless Rails::VERSION::MAJOR < 4
@@ -18,9 +20,9 @@ shared_examples_for "a generic apartment adapter" do
         Apartment::Railtie.config.to_prepare_blocks.map(&:call)
 
         num_available_connections = Apartment.connection_class.connection_pool
-          .instance_variable_get(:@available)
-          .instance_variable_get(:@queue)
-          .size
+                                             .instance_variable_get(:@available)
+                                             .instance_variable_get(:@queue)
+                                             .size
 
         expect(num_available_connections).to eq(1)
       end
@@ -30,23 +32,22 @@ shared_examples_for "a generic apartment adapter" do
   #
   #   Creates happen already in our before_filter
   #
-  describe "#create" do
-
-    it "should create the new databases" do
+  describe '#create' do
+    it 'should create the new databases' do
       expect(tenant_names).to include(db1)
       expect(tenant_names).to include(db2)
     end
 
-    it "should load schema.rb to new schema" do
+    it 'should load schema.rb to new schema' do
       subject.switch(db1) do
         expect(connection.tables).to include('companies')
       end
     end
 
-    it "should yield to block if passed and reset" do
+    it 'should yield to block if passed and reset' do
       subject.drop(db2) # so we don't get errors on creation
 
-      @count = 0  # set our variable so its visible in and outside of blocks
+      @count = 0 # set our variable so its visible in and outside of blocks
 
       subject.create(db2) do
         @count = User.count
@@ -56,19 +57,19 @@ shared_examples_for "a generic apartment adapter" do
 
       expect(subject.current).not_to eq(db2)
 
-      subject.switch(db2){ expect(User.count).to eq(@count + 1) }
+      subject.switch(db2) { expect(User.count).to eq(@count + 1) }
     end
 
-    it "should raise error when the schema.rb is missing unless Apartment.use_sql is set to true" do
+    it 'should raise error when the schema.rb is missing unless Apartment.use_sql is set to true' do
       next if Apartment.use_sql
 
       subject.drop(db1)
       begin
         Dir.mktmpdir do |tmpdir|
           Apartment.database_schema_file = "#{tmpdir}/schema.rb"
-          expect {
+          expect do
             subject.create(db1)
-          }.to raise_error(Apartment::FileNotFound)
+          end.to raise_error(Apartment::FileNotFound)
         end
       ensure
         Apartment.remove_instance_variable(:@database_schema_file)
@@ -76,33 +77,33 @@ shared_examples_for "a generic apartment adapter" do
     end
   end
 
-  describe "#drop" do
-    it "should remove the db" do
+  describe '#drop' do
+    it 'should remove the db' do
       subject.drop db1
       expect(tenant_names).not_to include(db1)
     end
   end
 
-  describe "#switch!" do
-    it "should connect to new db" do
+  describe '#switch!' do
+    it 'should connect to new db' do
       subject.switch!(db1)
       expect(subject.current).to eq(db1)
     end
 
-    it "should reset connection if database is nil" do
+    it 'should reset connection if database is nil' do
       subject.switch!
       expect(subject.current).to eq(default_tenant)
     end
 
-    it "should raise an error if database is invalid" do
-      expect {
+    it 'should raise an error if database is invalid' do
+      expect do
         subject.switch! 'unknown_database'
-      }.to raise_error(Apartment::ApartmentError)
+      end.to raise_error(Apartment::ApartmentError)
     end
   end
 
-  describe "#switch" do
-    it "connects and resets the tenant" do
+  describe '#switch' do
+    it 'connects and resets the tenant' do
       subject.switch(db1) do
         expect(subject.current).to eq(db1)
       end
@@ -111,32 +112,32 @@ shared_examples_for "a generic apartment adapter" do
 
     # We're often finding when using Apartment in tests, the `current` (ie the previously connect to db)
     # gets dropped, but switch will try to return to that db in a test.  We should just reset if it doesn't exist
-    it "should not throw exception if current is no longer accessible" do
+    it 'should not throw exception if current is no longer accessible' do
       subject.switch!(db2)
 
-      expect {
-        subject.switch(db1){ subject.drop(db2) }
-      }.to_not raise_error
+      expect do
+        subject.switch(db1) { subject.drop(db2) }
+      end.to_not raise_error
     end
   end
 
-  describe "#reset" do
-    it "should reset connection" do
+  describe '#reset' do
+    it 'should reset connection' do
       subject.switch!(db1)
       subject.reset
       expect(subject.current).to eq(default_tenant)
     end
   end
 
-  describe "#current" do
-    it "should return the current db name" do
+  describe '#current' do
+    it 'should return the current db name' do
       subject.switch!(db1)
       expect(subject.current).to eq(db1)
     end
   end
 
-  describe "#each" do
-    it "iterates over each tenant by default" do
+  describe '#each' do
+    it 'iterates over each tenant by default' do
       result = []
       Apartment.tenant_names = [db2, db1]
 
@@ -148,7 +149,7 @@ shared_examples_for "a generic apartment adapter" do
       expect(result).to eq([db2, db1])
     end
 
-    it "iterates over the given tenants" do
+    it 'iterates over the given tenants' do
       result = []
       Apartment.tenant_names = [db2]
 

data/spec/examples/schema_adapter_examples.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-shared_examples_for "a schema based apartment adapter" do
+# rubocop:disable Metrics/BlockLength
+shared_examples_for 'a schema based apartment adapter' do
   include Apartment::Spec::AdapterRequirements
 
-  let(:schema1){ db1 }
-  let(:schema2){ db2 }
-  let(:public_schema){ default_tenant }
-
-  describe "#init" do
+  let(:schema1) { db1 }
+  let(:schema2) { db2 }
+  let(:public_schema) { default_tenant }
 
+  describe '#init' do
     before do
       Apartment.configure do |config|
-        config.excluded_models = ["Company"]
+        config.excluded_models = ['Company']
       end
     end
 
@@ -23,15 +25,14 @@ shared_examples_for "a schema based apartment adapter" do
       end
     end
 
-    it "should process model exclusions" do
+    it 'should process model exclusions' do
       Apartment::Tenant.init
 
-      expect(Company.table_name).to eq("public.companies")
+      expect(Company.table_name).to eq('public.companies')
     end
 
-    context "with a default_schema", :default_schema => true do
-
-      it "should set the proper table_name on excluded_models" do
+    context 'with a default_schema', default_schema: true do
+      it 'should set the proper table_name on excluded_models' do
         Apartment::Tenant.init
 
         expect(Company.table_name).to eq("#{default_schema}.companies")
@@ -40,14 +41,14 @@ shared_examples_for "a schema based apartment adapter" do
       it 'sets the search_path correctly' do
         Apartment::Tenant.init
 
-        expect(User.connection.schema_search_path).to match(%r|#{default_schema}|)
+        expect(User.connection.schema_search_path).to match(/|#{default_schema}|/)
       end
     end
 
-    context "persistent_schemas", :persistent_schemas => true do
-      it "sets the persistent schemas in the schema_search_path" do
+    context 'persistent_schemas', persistent_schemas: true do
+      it 'sets the persistent schemas in the schema_search_path' do
         Apartment::Tenant.init
-        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %{"#{schema}"} }.join(', ')
+        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %("#{schema}") }.join(', ')
       end
     end
   end
@@ -55,180 +56,184 @@ shared_examples_for "a schema based apartment adapter" do
   #
   #   Creates happen already in our before_filter
   #
-  describe "#create" do
-
-    it "should load schema.rb to new schema" do
+  describe '#create' do
+    it 'should load schema.rb to new schema' do
       connection.schema_search_path = schema1
       expect(connection.tables).to include('companies')
     end
 
-    it "should yield to block if passed and reset" do
+    it 'should yield to block if passed and reset' do
       subject.drop(schema2) # so we don't get errors on creation
 
-      @count = 0  # set our variable so its visible in and outside of blocks
+      @count = 0 # set our variable so its visible in and outside of blocks
 
       subject.create(schema2) do
         @count = User.count
-        expect(connection.schema_search_path).to start_with %{"#{schema2}"}
+        expect(connection.schema_search_path).to start_with %("#{schema2}")
         User.create
       end
 
-      expect(connection.schema_search_path).not_to start_with %{"#{schema2}"}
+      expect(connection.schema_search_path).not_to start_with %("#{schema2}")
 
-      subject.switch(schema2){ expect(User.count).to eq(@count + 1) }
+      subject.switch(schema2) { expect(User.count).to eq(@count + 1) }
     end
 
-    context "numeric database names" do
-      let(:db){ 1234 }
-      it "should allow them" do
-        expect {
+    context 'numeric database names' do
+      let(:db) { 1234 }
+      it 'should allow them' do
+        expect do
           subject.create(db)
-        }.to_not raise_error
+        end.to_not raise_error
         expect(tenant_names).to include(db.to_s)
       end
 
-      after{ subject.drop(db) }
+      after { subject.drop(db) }
     end
-
   end
 
-  describe "#drop" do
-    it "should raise an error for unknown database" do
-      expect {
-        subject.drop "unknown_database"
-      }.to raise_error(Apartment::TenantNotFound)
+  describe '#drop' do
+    it 'should raise an error for unknown database' do
+      expect do
+        subject.drop 'unknown_database'
+      end.to raise_error(Apartment::TenantNotFound)
     end
 
-    context "numeric database names" do
-      let(:db){ 1234 }
+    context 'numeric database names' do
+      let(:db) { 1234 }
 
-      it "should be able to drop them" do
+      it 'should be able to drop them' do
         subject.create(db)
-        expect {
+        expect do
           subject.drop(db)
-        }.to_not raise_error
+        end.to_not raise_error
         expect(tenant_names).not_to include(db.to_s)
       end
 
-      after { subject.drop(db) rescue nil }
+      after do
+        begin
+          subject.drop(db)
+        rescue StandardError => _e
+          nil
+        end
+      end
     end
   end
 
-  describe "#switch" do
-    it "connects and resets" do
+  describe '#switch' do
+    it 'connects and resets' do
       subject.switch(schema1) do
-        expect(connection.schema_search_path).to start_with %{"#{schema1}"}
+        expect(connection.schema_search_path).to start_with %("#{schema1}")
       end
 
-      expect(connection.schema_search_path).to start_with %{"#{public_schema}"}
+      expect(connection.schema_search_path).to start_with %("#{public_schema}")
     end
   end
 
-  describe "#reset" do
-    it "should reset connection" do
+  describe '#reset' do
+    it 'should reset connection' do
       subject.switch!(schema1)
       subject.reset
-      expect(connection.schema_search_path).to start_with %{"#{public_schema}"}
+      expect(connection.schema_search_path).to start_with %("#{public_schema}")
     end
 
-    context "with default_schema", :default_schema => true do
-      it "should reset to the default schema" do
+    context 'with default_schema', default_schema: true do
+      it 'should reset to the default schema' do
         subject.switch!(schema1)
         subject.reset
-        expect(connection.schema_search_path).to start_with %{"#{default_schema}"}
+        expect(connection.schema_search_path).to start_with %("#{default_schema}")
       end
     end
 
-    context "persistent_schemas", :persistent_schemas => true do
+    context 'persistent_schemas', persistent_schemas: true do
       before do
         subject.switch!(schema1)
         subject.reset
       end
 
-      it "maintains the persistent schemas in the schema_search_path" do
-        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %{"#{schema}"} }.join(', ')
+      it 'maintains the persistent schemas in the schema_search_path' do
+        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %("#{schema}") }.join(', ')
       end
 
-      context "with default_schema", :default_schema => true do
-        it "prioritizes the switched schema to front of schema_search_path" do
+      context 'with default_schema', default_schema: true do
+        it 'prioritizes the switched schema to front of schema_search_path' do
           subject.reset # need to re-call this as the default_schema wasn't set at the time that the above reset ran
-          expect(connection.schema_search_path).to start_with %{"#{default_schema}"}
+          expect(connection.schema_search_path).to start_with %("#{default_schema}")
         end
       end
     end
   end
 
-  describe "#switch!" do
-    it "should connect to new schema" do
+  describe '#switch!' do
+    it 'should connect to new schema' do
       subject.switch!(schema1)
-      expect(connection.schema_search_path).to start_with %{"#{schema1}"}
+      expect(connection.schema_search_path).to start_with %("#{schema1}")
     end
 
-    it "should reset connection if database is nil" do
+    it 'should reset connection if database is nil' do
       subject.switch!
-      expect(connection.schema_search_path).to eq(%{"#{public_schema}"})
+      expect(connection.schema_search_path).to eq(%("#{public_schema}"))
     end
 
-    it "should raise an error if schema is invalid" do
-      expect {
+    it 'should raise an error if schema is invalid' do
+      expect do
         subject.switch! 'unknown_schema'
-      }.to raise_error(Apartment::TenantNotFound)
+      end.to raise_error(Apartment::TenantNotFound)
     end
 
-    context "numeric databases" do
-      let(:db){ 1234 }
+    context 'numeric databases' do
+      let(:db) { 1234 }
 
-      it "should connect to them" do
+      it 'should connect to them' do
         subject.create(db)
-        expect {
+        expect do
           subject.switch!(db)
-        }.to_not raise_error
+        end.to_not raise_error
 
-        expect(connection.schema_search_path).to start_with %{"#{db.to_s}"}
+        expect(connection.schema_search_path).to start_with %("#{db}")
       end
 
-      after{ subject.drop(db) }
+      after { subject.drop(db) }
     end
 
-    describe "with default_schema specified", :default_schema => true do
+    describe 'with default_schema specified', default_schema: true do
       before do
         subject.switch!(schema1)
       end
 
-      it "should switch out the default schema rather than public" do
+      it 'should switch out the default schema rather than public' do
         expect(connection.schema_search_path).not_to include default_schema
       end
 
-      it "should still switch to the switched schema" do
-        expect(connection.schema_search_path).to start_with %{"#{schema1}"}
+      it 'should still switch to the switched schema' do
+        expect(connection.schema_search_path).to start_with %("#{schema1}")
       end
     end
 
-    context "persistent_schemas", :persistent_schemas => true do
-
-      before{ subject.switch!(schema1) }
+    context 'persistent_schemas', persistent_schemas: true do
+      before { subject.switch!(schema1) }
 
-      it "maintains the persistent schemas in the schema_search_path" do
-        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %{"#{schema}"} }.join(', ')
+      it 'maintains the persistent schemas in the schema_search_path' do
+        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %("#{schema}") }.join(', ')
       end
 
-      it "prioritizes the switched schema to front of schema_search_path" do
-        expect(connection.schema_search_path).to start_with %{"#{schema1}"}
+      it 'prioritizes the switched schema to front of schema_search_path' do
+        expect(connection.schema_search_path).to start_with %("#{schema1}")
       end
     end
   end
 
-  describe "#current" do
-    it "should return the current schema name" do
+  describe '#current' do
+    it 'should return the current schema name' do
       subject.switch!(schema1)
       expect(subject.current).to eq(schema1)
     end
 
-    context "persistent_schemas", :persistent_schemas => true do
-      it "should exlude persistent_schemas" do
+    context 'persistent_schemas', persistent_schemas: true do
+      it 'should exlude persistent_schemas' do
         subject.switch!(schema1)
         expect(subject.current).to eq(schema1)
       end
     end
   end
 end
+# rubocop:enable Metrics/BlockLength