ros-apartment 2.3.0 → 2.4.0

data/spec/tasks/apartment_rake_spec.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'rake'
 require 'apartment/migrator'
 require 'apartment/tenant'
 
-describe "apartment rake tasks" do
-
+describe 'apartment rake tasks' do
   before do
     @rake = Rake::Application.new
     Rake.application = @rake
@@ -20,110 +21,104 @@ describe "apartment rake tasks" do
 
   after do
     Rake.application = nil
-    ENV['VERSION'] = nil    # linux users reported env variable carrying on between tests
+    ENV['VERSION'] = nil # linux users reported env variable carrying on between tests
   end
 
   after(:all) do
     Apartment::Test.load_schema
   end
 
-  let(:version){ '1234' }
+  let(:version) { '1234' }
 
   context 'database migration' do
-
-    let(:tenant_names){ 3.times.map{ Apartment::Test.next_db } }
-    let(:tenant_count){ tenant_names.length }
+    let(:tenant_names) { 3.times.map { Apartment::Test.next_db } }
+    let(:tenant_count) { tenant_names.length }
 
     before do
       allow(Apartment).to receive(:tenant_names).and_return tenant_names
     end
 
-    describe "apartment:migrate" do
+    describe 'apartment:migrate' do
       before do
-        allow(ActiveRecord::Migrator).to receive(:migrate)   # don't care about this
+        allow(ActiveRecord::Migrator).to receive(:migrate) # don't care about this
       end
 
-      it "should migrate public and all multi-tenant dbs" do
+      it 'should migrate public and all multi-tenant dbs' do
         expect(Apartment::Migrator).to receive(:migrate).exactly(tenant_count).times
         @rake['apartment:migrate'].invoke
       end
     end
 
-    describe "apartment:migrate:up" do
-
-      context "without a version" do
+    describe 'apartment:migrate:up' do
+      context 'without a version' do
         before do
           ENV['VERSION'] = nil
         end
 
-        it "requires a version to migrate to" do
-          expect{
+        it 'requires a version to migrate to' do
+          expect do
             @rake['apartment:migrate:up'].invoke
-          }.to raise_error("VERSION is required")
+          end.to raise_error('VERSION is required')
         end
       end
 
-      context "with version" do
-
+      context 'with version' do
         before do
           ENV['VERSION'] = version
         end
 
-        it "migrates up to a specific version" do
+        it 'migrates up to a specific version' do
           expect(Apartment::Migrator).to receive(:run).with(:up, anything, version.to_i).exactly(tenant_count).times
           @rake['apartment:migrate:up'].invoke
         end
       end
     end
 
-    describe "apartment:migrate:down" do
-
-      context "without a version" do
+    describe 'apartment:migrate:down' do
+      context 'without a version' do
         before do
           ENV['VERSION'] = nil
         end
 
-        it "requires a version to migrate to" do
-          expect{
+        it 'requires a version to migrate to' do
+          expect do
             @rake['apartment:migrate:down'].invoke
-          }.to raise_error("VERSION is required")
+          end.to raise_error('VERSION is required')
         end
       end
 
-      context "with version" do
-
+      context 'with version' do
         before do
           ENV['VERSION'] = version
         end
 
-        it "migrates up to a specific version" do
+        it 'migrates up to a specific version' do
           expect(Apartment::Migrator).to receive(:run).with(:down, anything, version.to_i).exactly(tenant_count).times
           @rake['apartment:migrate:down'].invoke
         end
       end
     end
 
-    describe "apartment:rollback" do
-      let(:step){ '3' }
+    describe 'apartment:rollback' do
+      let(:step) { '3' }
 
-      it "should rollback dbs" do
+      it 'should rollback dbs' do
         expect(Apartment::Migrator).to receive(:rollback).exactly(tenant_count).times
         @rake['apartment:rollback'].invoke
       end
 
-      it "should rollback dbs STEP amt" do
+      it 'should rollback dbs STEP amt' do
         expect(Apartment::Migrator).to receive(:rollback).with(anything, step.to_i).exactly(tenant_count).times
         ENV['STEP'] = step
         @rake['apartment:rollback'].invoke
       end
     end
 
-    describe "apartment:drop" do
-      it "should migrate public and all multi-tenant dbs" do
+    describe 'apartment:drop' do
+      it 'should migrate public and all multi-tenant dbs' do
         expect(Apartment::Tenant).to receive(:drop).exactly(tenant_count).times
         @rake['apartment:drop'].invoke
       end
     end
-
   end
 end

data/spec/tenant_spec.rb

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Apartment::Tenant do
-  context "using mysql", database: :mysql do
-
+  context 'using mysql', database: :mysql do
     before { subject.reload!(config) }
 
-    describe "#adapter" do
-      it "should load mysql adapter" do
+    describe '#adapter' do
+      it 'should load mysql adapter' do
         subject.adapter
         expect(Apartment::Adapters::Mysql2Adapter).to be_a(Class)
       end
     end
 
-    # TODO this doesn't belong here, but there aren't integration tests currently for mysql
+    # TODO: this doesn't belong here, but there aren't integration tests currently for mysql
     # where to put???
-    describe "exception recovery", :type => :request do
+    describe 'exception recovery', type: :request do
       before do
         subject.create db1
       end
-      after{ subject.drop db1 }
+      after { subject.drop db1 }
 
       # it "should recover from incorrect database" do
       #   session = Capybara::Session.new(:rack_test, Capybara.app)
@@ -30,9 +31,9 @@ describe Apartment::Tenant do
       # end
     end
 
-    # TODO re-organize these tests
-    context "with prefix and schemas" do
-      describe "#create" do
+    # TODO: re-organize these tests
+    context 'with prefix and schemas' do
+      describe '#create' do
         before do
           Apartment.configure do |config|
             config.prepend_environment = true
@@ -42,35 +43,41 @@ describe Apartment::Tenant do
           subject.reload!(config)
         end
 
-        after { subject.drop "db_with_prefix" rescue nil }
+        after do
+          begin
+            subject.drop 'db_with_prefix'
+          rescue StandardError => _e
+            nil
+          end
+        end
 
-        it "should create a new database" do
-          subject.create "db_with_prefix"
+        it 'should create a new database' do
+          subject.create 'db_with_prefix'
         end
       end
     end
   end
 
-  context "using postgresql", database: :postgresql do
+  context 'using postgresql', database: :postgresql do
     before do
       Apartment.use_schemas = true
       subject.reload!(config)
     end
 
-    describe "#adapter" do
-      it "should load postgresql adapter" do
+    describe '#adapter' do
+      it 'should load postgresql adapter' do
         expect(subject.adapter).to be_a(Apartment::Adapters::PostgresqlSchemaAdapter)
       end
 
-      it "raises exception with invalid adapter specified" do
+      it 'raises exception with invalid adapter specified' do
         subject.reload!(config.merge(adapter: 'unknown'))
 
-        expect {
+        expect do
           Apartment::Tenant.adapter
-        }.to raise_error(RuntimeError)
+        end.to raise_error(RuntimeError)
       end
 
-      context "threadsafety" do
+      context 'threadsafety' do
         before { subject.create db1 }
         after  { subject.drop   db1 }
 
@@ -83,8 +90,8 @@ describe Apartment::Tenant do
       end
     end
 
-    # TODO above spec are also with use_schemas=true
-    context "with schemas" do
+    # TODO: above spec are also with use_schemas=true
+    context 'with schemas' do
       before do
         Apartment.configure do |config|
           config.excluded_models = []
@@ -94,30 +101,28 @@ describe Apartment::Tenant do
         subject.create db1
       end
 
-      after{ subject.drop db1 }
+      after { subject.drop db1 }
 
-      describe "#create" do
-        it "should seed data" do
+      describe '#create' do
+        it 'should seed data' do
           subject.switch! db1
           expect(User.count).to be > 0
         end
       end
 
-      describe "#switch!" do
+      describe '#switch!' do
+        let(:x) { rand(3) }
 
-        let(:x){ rand(3) }
+        context 'creating models' do
+          before { subject.create db2 }
+          after { subject.drop db2 }
 
-        context "creating models" do
-
-          before{ subject.create db2 }
-          after{ subject.drop db2 }
-
-          it "should create a model instance in the current schema" do
+          it 'should create a model instance in the current schema' do
             subject.switch! db2
-            db2_count = User.count + x.times{ User.create }
+            db2_count = User.count + x.times { User.create }
 
             subject.switch! db1
-            db_count = User.count + x.times{ User.create }
+            db_count = User.count + x.times { User.create }
 
             subject.switch! db2
             expect(User.count).to eq(db2_count)
@@ -127,11 +132,10 @@ describe Apartment::Tenant do
           end
         end
 
-        context "with excluded models" do
-
+        context 'with excluded models' do
           before do
             Apartment.configure do |config|
-              config.excluded_models = ["Company"]
+              config.excluded_models = ['Company']
             end
             subject.init
           end
@@ -144,12 +148,12 @@ describe Apartment::Tenant do
             end
           end
 
-          it "should create excluded models in public schema" do
+          it 'should create excluded models in public schema' do
             subject.reset # ensure we're on public schema
-            count = Company.count + x.times{ Company.create }
+            count = Company.count + x.times { Company.create }
 
             subject.switch! db1
-            x.times{ Company.create }
+            x.times { Company.create }
             expect(Company.count).to eq(count + x)
             subject.reset
             expect(Company.count).to eq(count + x)
@@ -158,7 +162,7 @@ describe Apartment::Tenant do
       end
     end
 
-    context "seed paths" do
+    context 'seed paths' do
       before do
         Apartment.configure do |config|
           config.excluded_models = []
@@ -167,7 +171,7 @@ describe Apartment::Tenant do
         end
       end
 
-      after{ subject.drop db1 }
+      after { subject.drop db1 }
 
       it 'should seed from default path' do
         subject.create db1
@@ -178,7 +182,7 @@ describe Apartment::Tenant do
 
       it 'should seed from custom path' do
         Apartment.configure do |config|
-          config.seed_data_file = "#{Rails.root}/db/seeds/import.rb"
+          config.seed_data_file = Rails.root.join('db', 'seeds', 'import.rb')
         end
         subject.create db1
         subject.switch! db1

data/spec/unit/config_spec.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Apartment do
-
-  describe "#config" do
-
-    let(:excluded_models){ ["Company"] }
-    let(:seed_data_file_path){ "#{Rails.root}/db/seeds/import.rb" }
+  describe '#config' do
+    let(:excluded_models) { ['Company'] }
+    let(:seed_data_file_path) { Rails.root.join('db', 'seeds', 'import.rb') }
 
     def tenant_names_from_array(names)
       names.each_with_object({}) do |tenant, hash|
@@ -13,21 +13,21 @@ describe Apartment do
       end.with_indifferent_access
     end
 
-    it "should yield the Apartment object" do
+    it 'should yield the Apartment object' do
       Apartment.configure do |config|
         config.excluded_models = []
         expect(config).to eq(Apartment)
       end
     end
 
-    it "should set excluded models" do
+    it 'should set excluded models' do
       Apartment.configure do |config|
         config.excluded_models = excluded_models
       end
       expect(Apartment.excluded_models).to eq(excluded_models)
     end
 
-    it "should set use_schemas" do
+    it 'should set use_schemas' do
       Apartment.configure do |config|
         config.excluded_models = []
         config.use_schemas = false
@@ -35,14 +35,14 @@ describe Apartment do
       expect(Apartment.use_schemas).to be false
     end
 
-    it "should set seed_data_file" do
+    it 'should set seed_data_file' do
       Apartment.configure do |config|
         config.seed_data_file = seed_data_file_path
       end
       expect(Apartment.seed_data_file).to eq(seed_data_file_path)
     end
 
-    it "should set seed_after_create" do
+    it 'should set seed_after_create' do
       Apartment.configure do |config|
         config.excluded_models = []
         config.seed_after_create = true
@@ -50,7 +50,7 @@ describe Apartment do
       expect(Apartment.seed_after_create).to be true
     end
 
-    context "databases" do
+    context 'databases' do
       let(:users_conf_hash) { { port: 5444 } }
 
       before do
@@ -59,54 +59,53 @@ describe Apartment do
         end
       end
 
-      context "tenant_names as string array" do
-        let(:tenant_names) { ['users', 'companies'] }
+      context 'tenant_names as string array' do
+        let(:tenant_names) { %w[users companies] }
 
-        it "should return object if it doesnt respond_to call" do
+        it 'should return object if it doesnt respond_to call' do
           expect(Apartment.tenant_names).to eq(tenant_names_from_array(tenant_names).keys)
         end
 
-        it "should set tenants_with_config" do
+        it 'should set tenants_with_config' do
           expect(Apartment.tenants_with_config).to eq(tenant_names_from_array(tenant_names))
         end
       end
 
-      context "tenant_names as proc returning an array" do
-        let(:tenant_names) { lambda { ['users', 'companies'] } }
+      context 'tenant_names as proc returning an array' do
+        let(:tenant_names) { -> { %w[users companies] } }
 
-        it "should return object if it doesnt respond_to call" do
+        it 'should return object if it doesnt respond_to call' do
           expect(Apartment.tenant_names).to eq(tenant_names_from_array(tenant_names.call).keys)
         end
 
-        it "should set tenants_with_config" do
+        it 'should set tenants_with_config' do
           expect(Apartment.tenants_with_config).to eq(tenant_names_from_array(tenant_names.call))
         end
       end
 
-      context "tenant_names as Hash" do
+      context 'tenant_names as Hash' do
         let(:tenant_names) { { users: users_conf_hash }.with_indifferent_access }
 
-        it "should return object if it doesnt respond_to call" do
+        it 'should return object if it doesnt respond_to call' do
           expect(Apartment.tenant_names).to eq(tenant_names.keys)
         end
 
-        it "should set tenants_with_config" do
+        it 'should set tenants_with_config' do
           expect(Apartment.tenants_with_config).to eq(tenant_names)
         end
       end
 
-      context "tenant_names as proc returning a Hash" do
-        let(:tenant_names) { lambda { { users: users_conf_hash }.with_indifferent_access } }
+      context 'tenant_names as proc returning a Hash' do
+        let(:tenant_names) { -> { { users: users_conf_hash }.with_indifferent_access } }
 
-        it "should return object if it doesnt respond_to call" do
+        it 'should return object if it doesnt respond_to call' do
           expect(Apartment.tenant_names).to eq(tenant_names.call.keys)
         end
 
-        it "should set tenants_with_config" do
+        it 'should set tenants_with_config' do
           expect(Apartment.tenants_with_config).to eq(tenant_names.call)
         end
       end
     end
-
   end
 end

data/spec/unit/elevators/domain_spec.rb

@@ -1,29 +1,30 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'apartment/elevators/domain'
 
 describe Apartment::Elevators::Domain do
+  subject(:elevator) { described_class.new(proc {}) }
 
-  subject(:elevator){ described_class.new(Proc.new{}) }
-
-  describe "#parse_tenant_name" do
-    it "parses the host for a domain name" do
+  describe '#parse_tenant_name' do
+    it 'parses the host for a domain name' do
       request = ActionDispatch::Request.new('HTTP_HOST' => 'example.com')
       expect(elevator.parse_tenant_name(request)).to eq('example')
     end
 
-    it "ignores a www prefix and domain suffix" do
+    it 'ignores a www prefix and domain suffix' do
       request = ActionDispatch::Request.new('HTTP_HOST' => 'www.example.bc.ca')
       expect(elevator.parse_tenant_name(request)).to eq('example')
     end
 
-    it "returns nil if there is no host" do
+    it 'returns nil if there is no host' do
       request = ActionDispatch::Request.new('HTTP_HOST' => '')
       expect(elevator.parse_tenant_name(request)).to be_nil
     end
   end
 
-  describe "#call" do
-    it "switches to the proper tenant" do
+  describe '#call' do
+    it 'switches to the proper tenant' do
       expect(Apartment::Tenant).to receive(:switch).with('example')
 
       elevator.call('HTTP_HOST' => 'www.example.com')

data/spec/unit/elevators/first_subdomain_spec.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'apartment/elevators/first_subdomain'
 
 describe Apartment::Elevators::FirstSubdomain do
-  describe "subdomain" do
-    subject { described_class.new("test").parse_tenant_name(request) }
-    let(:request) { double(:request, :host => "#{subdomain}.example.com") }
+  describe 'subdomain' do
+    subject { described_class.new('test').parse_tenant_name(request) }
+    let(:request) { double(:request, host: "#{subdomain}.example.com") }
 
-    context "one subdomain" do
-      let(:subdomain) { "test" }
-      it { is_expected.to eq("test") }
+    context 'one subdomain' do
+      let(:subdomain) { 'test' }
+      it { is_expected.to eq('test') }
     end
 
-    context "nested subdomains" do
-      let(:subdomain) { "test1.test2" }
-      it { is_expected.to eq("test1") }
+    context 'nested subdomains' do
+      let(:subdomain) { 'test1.test2' }
+      it { is_expected.to eq('test1') }
     end
-    
-    context "no subdomain" do
+
+    context 'no subdomain' do
       let(:subdomain) { nil }
       it { is_expected.to eq(nil) }
     end
   end
-end
+end

data/spec/unit/elevators/generic_spec.rb

@@ -1,49 +1,50 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'apartment/elevators/generic'
 
 describe Apartment::Elevators::Generic do
-
   class MyElevator < described_class
     def parse_tenant_name(*)
       'tenant2'
     end
   end
 
-  subject(:elevator){ described_class.new(Proc.new{}) }
+  subject(:elevator) { described_class.new(proc {}) }
 
-  describe "#call" do
-    it "calls the processor if given" do
-      elevator = described_class.new(Proc.new{}, Proc.new{'tenant1'})
+  describe '#call' do
+    it 'calls the processor if given' do
+      elevator = described_class.new(proc {}, proc { 'tenant1' })
 
       expect(Apartment::Tenant).to receive(:switch).with('tenant1')
 
       elevator.call('HTTP_HOST' => 'foo.bar.com')
     end
 
-    it "raises if parse_tenant_name not implemented" do
-      expect {
+    it 'raises if parse_tenant_name not implemented' do
+      expect do
         elevator.call('HTTP_HOST' => 'foo.bar.com')
-      }.to raise_error(RuntimeError)
+      end.to raise_error(RuntimeError)
     end
 
-    it "switches to the parsed db_name" do
-      elevator = MyElevator.new(Proc.new{})
+    it 'switches to the parsed db_name' do
+      elevator = MyElevator.new(proc {})
 
       expect(Apartment::Tenant).to receive(:switch).with('tenant2')
 
       elevator.call('HTTP_HOST' => 'foo.bar.com')
     end
 
-    it "calls the block implementation of `switch`" do
-      elevator = MyElevator.new(Proc.new{}, Proc.new{'tenant2'})
+    it 'calls the block implementation of `switch`' do
+      elevator = MyElevator.new(proc {}, proc { 'tenant2' })
 
       expect(Apartment::Tenant).to receive(:switch).with('tenant2').and_yield
       elevator.call('HTTP_HOST' => 'foo.bar.com')
     end
 
-    it "does not call `switch` if no database given" do
-      app = Proc.new{}
-      elevator = MyElevator.new(app, Proc.new{})
+    it 'does not call `switch` if no database given' do
+      app = proc {}
+      elevator = MyElevator.new(app, proc {})
 
       expect(Apartment::Tenant).not_to receive(:switch)
       expect(app).to receive :call