apartment 0.26.1 → 1.0.0

data/spec/dummy_engine/test/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy_engine/test/dummy/config/initializers/assets.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+# Rails.application.config.assets.precompile += %w( search.js )

data/spec/dummy_engine/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy_engine/test/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/dummy_engine/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy_engine/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy_engine/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/spec/dummy_engine/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/dummy_engine/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end

data/spec/dummy_engine/test/dummy/config/locales/en.yml

@@ -0,0 +1,23 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/spec/dummy_engine/test/dummy/config/routes.rb

@@ -0,0 +1,56 @@
+Rails.application.routes.draw do
+  # The priority is based upon order of creation: first created -> highest priority.
+  # See how all your routes lay out with "rake routes".
+
+  # You can have the root of your site routed with "root"
+  # root 'welcome#index'
+
+  # Example of regular route:
+  #   get 'products/:id' => 'catalog#view'
+
+  # Example of named route that can be invoked with purchase_url(id: product.id)
+  #   get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
+
+  # Example resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Example resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Example resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Example resource route with more complex sub-resources:
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', on: :collection
+  #     end
+  #   end
+
+  # Example resource route with concerns:
+  #   concern :toggleable do
+  #     post 'toggle'
+  #   end
+  #   resources :posts, concerns: :toggleable
+  #   resources :photos, concerns: :toggleable
+
+  # Example resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+end

data/spec/dummy_engine/test/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: bb62b819b585a74e69c797f9d03d5a004d8fe82a8e7a7da6fa2f7923030713b7b087c12cc7a918e71073c38afb343f7223d22ba3f1b223b7e76dbf8d5b65fa2c
+
+test:
+  secret_key_base: 67945d3b189c71dffef98de2bb7c14d6fb059679c115ca3cddf65c88babe130afe4d583560d0e308b017dd76ce305bef4159d876de9fd893952d9cbf269c8476
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/spec/examples/connection_adapter_examples.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 shared_examples_for "a connection based apartment adapter" do
   include Apartment::Spec::AdapterRequirements
 
-  let(:default_tenant){ subject.process{ ActiveRecord::Base.connection.current_database } }
+  let(:default_tenant){ subject.switch{ ActiveRecord::Base.connection.current_database } }
 
   describe "#init" do
     it "should process model exclusions" do
@@ -20,15 +20,15 @@ shared_examples_for "a connection based apartment adapter" do
     it "should raise an error for unknown database" do
       expect {
         subject.drop 'unknown_database'
-      }.to raise_error(Apartment::DatabaseNotFound)
+      }.to raise_error(Apartment::TenantNotFound)
     end
   end
 
-  describe "#switch" do
+  describe "#switch!" do
     it "should raise an error if database is invalid" do
       expect {
-        subject.switch 'unknown_database'
-      }.to raise_error(Apartment::DatabaseNotFound)
+        subject.switch! 'unknown_database'
+      }.to raise_error(Apartment::TenantNotFound)
     end
   end
 end

data/spec/examples/generic_adapter_examples.rb

@@ -19,7 +19,7 @@ shared_examples_for "a generic apartment adapter" do
     end
 
     it "should load schema.rb to new schema" do
-      subject.process(db1) do
+      subject.switch(db1) do
         connection.tables.should include('companies')
       end
     end
@@ -31,13 +31,13 @@ shared_examples_for "a generic apartment adapter" do
 
       subject.create(db2) do
         @count = User.count
-        subject.current_tenant.should == db2
+        subject.current.should == db2
         User.create
       end
 
-      subject.current_tenant.should_not == db2
+      subject.current.should_not == db2
 
-      subject.process(db2){ User.count.should == @count + 1 }
+      subject.switch(db2){ User.count.should == @count + 1 }
     end
   end
 
@@ -48,60 +48,98 @@ shared_examples_for "a generic apartment adapter" do
     end
   end
 
-  describe "#process" do
-    it "should connect" do
-      subject.process(db1) do
-        subject.current_tenant.should == db1
-      end
+  describe "#switch!" do
+    it "should connect to new db" do
+      subject.switch!(db1)
+      subject.current.should == db1
     end
 
-    it "should reset" do
-      subject.process(db1)
-      subject.current_tenant.should == default_tenant
+    it "should reset connection if database is nil" do
+      subject.switch!
+      subject.current.should == default_tenant
     end
 
-    # We're often finding when using Apartment in tests, the `current_tenant` (ie the previously connect to db)
-    # gets dropped, but process 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_tenant is no longer accessible" do
-      subject.switch(db2)
+    it "should raise an error if database is invalid" do
+      expect {
+        subject.switch! 'unknown_database'
+      }.to raise_error(Apartment::ApartmentError)
+    end
+  end
+
+  describe "#switch" do
+    it "connects and resets the tenant" do
+      subject.switch(db1) do
+        subject.current.should == db1
+      end
+      subject.current.should == default_tenant
+    end
+
+    # 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
+      subject.switch!(db2)
 
       expect {
-        subject.process(db1){ subject.drop(db2) }
+        subject.switch(db1){ subject.drop(db2) }
       }.to_not raise_error
     end
-  end
 
-  describe "#reset" do
-    it "should reset connection" do
+    it "warns if no block is given, but calls switch!" do
+      expect(Apartment::Deprecation).to receive(:warn)
+
       subject.switch(db1)
-      subject.reset
-      subject.current_tenant.should == default_tenant
+      subject.current.should == db1
     end
   end
 
-  describe "#switch" do
-    it "should connect to new db" do
-      subject.switch(db1)
-      subject.current_tenant.should == db1
-    end
+  describe "#process" do
+    it "is deprecated" do
+      expect(Apartment::Deprecation).to receive(:warn)
 
-    it "should reset connection if database is nil" do
-      subject.switch
-      subject.current_tenant.should == default_tenant
+      subject.process(db1) do
+        subject.current.should == db1
+      end
     end
+  end
 
-    it "should raise an error if database is invalid" do
-      expect {
-        subject.switch 'unknown_database'
-      }.to raise_error(Apartment::ApartmentError)
+  describe "#reset" do
+    it "should reset connection" do
+      subject.switch!(db1)
+      subject.reset
+      subject.current.should == default_tenant
     end
   end
 
-  describe "#current_tenant" do
+  describe "#current" do
     it "should return the current db name" do
-      subject.switch(db1)
-      subject.current_tenant.should == db1
+      subject.switch!(db1)
       subject.current.should == db1
     end
   end
+
+  describe "#each" do
+    it "iterates over each tenant by default" do
+      result = []
+      Apartment.tenant_names = [db2, db1]
+
+      subject.each do |tenant|
+        result << tenant
+        expect(subject.current).to eq(tenant)
+      end
+
+      expect(result).to eq([db2, db1])
+    end
+
+    it "iterates over the given tenants" do
+      result = []
+      Apartment.tenant_names = [db2]
+
+      subject.each([db2]) do |tenant|
+        result << tenant
+        expect(subject.current).to eq(tenant)
+      end
+
+      expect(result).to eq([db2])
+    end
+  end
 end

data/spec/examples/schema_adapter_examples.rb

@@ -67,7 +67,7 @@ shared_examples_for "a schema based apartment adapter" do
 
       connection.schema_search_path.should_not start_with %{"#{schema2}"}
 
-      subject.process(schema2){ User.count.should == @count + 1 }
+      subject.switch(schema2){ User.count.should == @count + 1 }
     end
 
     context "numeric database names" do
@@ -88,7 +88,7 @@ shared_examples_for "a schema based apartment adapter" do
     it "should raise an error for unknown database" do
       expect {
         subject.drop "unknown_database"
-      }.to raise_error(Apartment::SchemaNotFound)
+      }.to raise_error(Apartment::TenantNotFound)
     end
 
     context "numeric database names" do
@@ -106,29 +106,26 @@ shared_examples_for "a schema based apartment adapter" do
     end
   end
 
-  describe "#process" do
-    it "should connect" do
-      subject.process(schema1) do
+  describe "#switch" do
+    it "connects and resets" do
+      subject.switch(schema1) do
         connection.schema_search_path.should start_with %{"#{schema1}"}
       end
-    end
 
-    it "should reset" do
-      subject.process(schema1)
       connection.schema_search_path.should start_with %{"#{public_schema}"}
     end
   end
 
   describe "#reset" do
     it "should reset connection" do
-      subject.switch(schema1)
+      subject.switch!(schema1)
       subject.reset
       connection.schema_search_path.should start_with %{"#{public_schema}"}
     end
 
     context "with default_schema", :default_schema => true do
       it "should reset to the default schema" do
-        subject.switch(schema1)
+        subject.switch!(schema1)
         subject.reset
         connection.schema_search_path.should start_with %{"#{default_schema}"}
       end
@@ -136,7 +133,7 @@ shared_examples_for "a schema based apartment adapter" do
 
     context "persistent_schemas", :persistent_schemas => true do
       before do
-        subject.switch(schema1)
+        subject.switch!(schema1)
         subject.reset
       end
 
@@ -153,21 +150,21 @@ shared_examples_for "a schema based apartment adapter" do
     end
   end
 
-  describe "#switch" do
+  describe "#switch!" do
     it "should connect to new schema" do
-      subject.switch(schema1)
+      subject.switch!(schema1)
       connection.schema_search_path.should start_with %{"#{schema1}"}
     end
 
     it "should reset connection if database is nil" do
-      subject.switch
+      subject.switch!
       connection.schema_search_path.should == %{"#{public_schema}"}
     end
 
     it "should raise an error if schema is invalid" do
       expect {
-        subject.switch 'unknown_schema'
-      }.to raise_error(Apartment::SchemaNotFound)
+        subject.switch! 'unknown_schema'
+      }.to raise_error(Apartment::TenantNotFound)
     end
 
     context "numeric databases" do
@@ -176,7 +173,7 @@ shared_examples_for "a schema based apartment adapter" do
       it "should connect to them" do
         subject.create(db)
         expect {
-          subject.switch(db)
+          subject.switch!(db)
         }.to_not raise_error
 
         connection.schema_search_path.should start_with %{"#{db.to_s}"}
@@ -187,7 +184,7 @@ shared_examples_for "a schema based apartment adapter" do
 
     describe "with default_schema specified", :default_schema => true do
       before do
-        subject.switch(schema1)
+        subject.switch!(schema1)
       end
 
       it "should switch out the default schema rather than public" do
@@ -201,7 +198,7 @@ shared_examples_for "a schema based apartment adapter" do
 
     context "persistent_schemas", :persistent_schemas => true do
 
-      before{ subject.switch(schema1) }
+      before{ subject.switch!(schema1) }
 
       it "maintains the persistent schemas in the schema_search_path" do
         connection.schema_search_path.should end_with persistent_schemas.map { |schema| %{"#{schema}"} }.join(', ')
@@ -213,17 +210,15 @@ shared_examples_for "a schema based apartment adapter" do
     end
   end
 
-  describe "#current_tenant" do
+  describe "#current" do
     it "should return the current schema name" do
-      subject.switch(schema1)
-      subject.current_tenant.should == schema1
+      subject.switch!(schema1)
       subject.current.should == schema1
     end
 
     context "persistent_schemas", :persistent_schemas => true do
       it "should exlude persistent_schemas" do
-        subject.switch(schema1)
-        subject.current_tenant.should == schema1
+        subject.switch!(schema1)
         subject.current.should == schema1
       end
     end