switch_point 0.5.0.pre → 0.9.0

data/lib/switch_point/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwitchPoint
-  VERSION = "0.5.0.pre"
+  VERSION = '0.9.0'
 end

data/spec/models.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 SwitchPoint.configure do |config|
   config.define_switch_point :main,
     readonly: :main_readonly,
@@ -30,8 +32,7 @@ class Book < ActiveRecord::Base
 
   private
 
-  def do_after_save
-  end
+  def do_after_save; end
 end
 
 class Book2 < ActiveRecord::Base
@@ -85,8 +86,13 @@ class DerivedNanika2 < AbstractNanika
   use_switch_point :main2
 end
 
-base = { adapter: 'sqlite3' }
-ActiveRecord::Base.configurations = {
+base =
+  if RUBY_PLATFORM == 'java'
+    { adapter: 'jdbcsqlite3' }
+  else
+    { adapter: 'sqlite3' }
+  end
+databases = {
   'main_readonly' => base.merge(database: 'main_readonly.sqlite3'),
   'main_writable' => base.merge(database: 'main_writable.sqlite3'),
   'main2_readonly' => base.merge(database: 'main2_readonly.sqlite3'),
@@ -95,8 +101,15 @@ ActiveRecord::Base.configurations = {
   'user' => base.merge(database: 'user.sqlite3'),
   'comment_readonly' => base.merge(database: 'comment_readonly.sqlite3'),
   'comment_writable' => base.merge(database: 'comment_writable.sqlite3'),
-  'default' => base.merge(database: 'default.sqlite3')
+  'default' => base.merge(database: 'default.sqlite3'),
 }
+ActiveRecord::Base.configurations =
+  # ActiveRecord.gem_version was introduced in ActiveRecord 4.0
+  if ActiveRecord.respond_to?(:gem_version) && ActiveRecord.gem_version >= Gem::Version.new('5.1.0')
+    { 'test' => databases }
+  else
+    databases
+  end
 ActiveRecord::Base.establish_connection(:default)
 
 # XXX: Check connection laziness

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
+ENV['RAILS_ENV'] ||= 'test'
+
 require 'coveralls'
 require 'simplecov'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter,
 ]
@@ -57,8 +61,14 @@ RSpec.configure do |config|
   end
 
   config.after(:suite) do
-    ActiveRecord::Base.configurations.each_value do |config|
-      FileUtils.rm_f(config[:database])
+    if ActiveRecord::Base.configurations.respond_to?(:configs_for)
+      ActiveRecord::Base.configurations.configs_for.each do |c|
+        FileUtils.rm_f(c.config['database'])
+      end
+    else
+      ActiveRecord::Base.configurations.each_value do |c|
+        FileUtils.rm_f(c[:database])
+      end
     end
   end
 

data/spec/switch_point/model_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe SwitchPoint::Model do
   describe '.use_switch_point' do
     after do
@@ -33,8 +35,8 @@ RSpec.describe SwitchPoint::Model do
 
     context 'when auto_writable is disabled' do
       it 'raises error when destructive query is requested in readonly mode' do
-        expect { Book.create }.to raise_error(SwitchPoint::Connection::ReadonlyError)
-        expect { Book.with_readonly { Book.create } }.to raise_error(SwitchPoint::Connection::ReadonlyError)
+        expect { Book.create }.to raise_error(SwitchPoint::ReadonlyError)
+        expect { Book.with_readonly { Book.create } }.to raise_error(SwitchPoint::ReadonlyError)
         expect { Book.with_writable { Book.create } }.to_not raise_error
       end
     end
@@ -69,7 +71,6 @@ RSpec.describe SwitchPoint::Model do
 
     it 'works with newly checked-out connection' do
       Thread.start do
-        expect(Book.connection.pool.connections.size).to be > 1 # Assertion
         Book.with_writable do
           Book.create
         end
@@ -218,7 +219,7 @@ RSpec.describe SwitchPoint::Model do
             expect(Book.connection.query_cache.size).to eq(1)
             Book.with_writable do
               Book.create
-              FileUtils.cp('main_writable.sqlite3', 'main_readonly.sqlite3')  # XXX: emulate replication
+              FileUtils.cp('main_writable.sqlite3', 'main_readonly.sqlite3') # XXX: emulate replication
             end
             expect(Book.connection.query_cache.size).to eq(0)
             expect(Book.count).to eq(1)
@@ -228,8 +229,8 @@ RSpec.describe SwitchPoint::Model do
     end
 
     context 'without use_switch_point' do
-      it 'bypasses given block' do
-        expect(Note.with_writable { :bypass }).to eq(:bypass)
+      it 'raises error' do
+        expect { Note.with_writable { :bypass } }.to raise_error(SwitchPoint::UnconfiguredError)
       end
     end
 
@@ -243,6 +244,16 @@ RSpec.describe SwitchPoint::Model do
     end
   end
 
+  describe '#with_writable' do
+    it 'behaves like .with_writable' do
+      book = Book.with_writable { Book.create! }
+      book.with_writable do
+        expect(Book).to connect_to('main_writable.sqlite3')
+      end
+      expect(Book).to connect_to('main_readonly.sqlite3')
+    end
+  end
+
   describe '.with_readonly' do
     context 'when writable! is called globally' do
       before do
@@ -262,9 +273,27 @@ RSpec.describe SwitchPoint::Model do
     end
   end
 
+  describe '#with_readonly' do
+    before do
+      SwitchPoint.writable!(:main)
+    end
+
+    after do
+      SwitchPoint.readonly!(:main)
+    end
+
+    it 'behaves like .with_readonly' do
+      book = Book.create!
+      book.with_readonly do
+        expect(Book).to connect_to('main_readonly.sqlite3')
+      end
+      expect(Book).to connect_to('main_writable.sqlite3')
+    end
+  end
+
   describe '#with_mode' do
     it 'raises error if unknown mode is given' do
-      expect { SwitchPoint::ProxyRepository.checkout(:main).with_mode(:typo) }.to raise_error
+      expect { SwitchPoint::ProxyRepository.checkout(:main).with_mode(:typo) }.to raise_error(ArgumentError)
     end
   end
 
@@ -292,14 +321,14 @@ RSpec.describe SwitchPoint::Model do
   end
 
   describe '.transaction_with' do
-    context "when each model has a same writable" do
+    context 'when each model has a same writable' do
       before do
         @before_book_count  = Book.count
         @before_book2_count = Book2.count
 
         Book.transaction_with(Book2) do
-          new_book  = Book.create
-          new_book2 = Book2.create
+          Book.create
+          Book2.create
         end
 
         @after_book_count = Book.with_writable do
@@ -325,25 +354,25 @@ RSpec.describe SwitchPoint::Model do
       end
     end
 
-    context "when each model has a other writable" do
+    context 'when each model has a other writable' do
       it {
         expect {
           Book.transaction_with(Book3) do
-            new_book  = Book.create
-            new_book3 = Book3.create
+            Book.create
+            Book3.create
           end
-        }.to raise_error RuntimeError
+        }.to raise_error(SwitchPoint::Error)
       }
     end
 
-    context "when raise exception in transaction that include some model, and models each have other writable" do
+    context 'when raise exception in transaction that include some model, and models each have other writable' do
       before do
         @before_book_count  = Book.count
         @before_book3_count = Book3.count
 
         Book.transaction_with(Book2) do
-          new_book  = Book.create
-          new_book3 = Book3.with_writable do
+          Book.create
+          Book3.with_writable do
             Book3.create
           end
           raise ActiveRecord::Rollback
@@ -367,7 +396,7 @@ RSpec.describe SwitchPoint::Model do
       end
     end
 
-    context "when nested transaction_with then parent transaction rollbacked" do
+    context 'when nested transaction_with then parent transaction rollbacked' do
       before do
         @before_book_count  = Book.count
         @before_book3_count = Book3.count
@@ -398,4 +427,48 @@ RSpec.describe SwitchPoint::Model do
       end
     end
   end
+
+  describe '#transaction_with' do
+    it 'behaves like .transaction_with' do
+      book = Book.with_writable { Book.create! }
+      expect(Book.with_writable { Book.count }).to eq(1)
+      book.transaction_with(Book2) do
+        Book.create!
+        raise ActiveRecord::Rollback
+      end
+      expect(Book.with_writable { Book.count }).to eq(1)
+
+      expect { book.transaction_with(Book3) {} }.to raise_error(SwitchPoint::Error) # rubocop:disable Lint/EmptyBlock
+    end
+  end
+
+  describe '.cache' do
+    it 'enables query cache for both readonly and writable' do
+      Book.connection
+      Book.with_writable { Book.connection }
+
+      Book.cache do
+        expect { Book.count }.to change { Book.connection.query_cache.size }.from(0).to(1)
+        Book.with_writable do
+          expect { Book.count }.to change { Book.connection.query_cache.size }.from(0).to(1)
+        end
+      end
+    end
+  end
+
+  describe '.uncached' do
+    it 'disables query cache for both readonly and writable' do
+      Book.connection
+      Book.with_writable { Book.connection }
+
+      Book.cache do
+        Book.uncached do
+          expect { Book.count }.to_not change { Book.connection.query_cache.size }.from(0)
+          Book.with_writable do
+            expect { Book.count }.to_not change { Book.connection.query_cache.size }.from(0)
+          end
+        end
+      end
+    end
+  end
 end

data/spec/switch_point/query_cache_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'rack'
+
+class TestApp
+  def call(env)
+    state = {}
+    [Nanika1, Nanika2].each do |model|
+      r = model.with_readonly { model.connection.query_cache_enabled }
+      w = model.with_writable { model.connection.query_cache_enabled }
+      state[model.name] = { readonly: r, writable: w }
+    end
+    env[:state] = state
+    :result
+  end
+end
+
+RSpec.describe SwitchPoint::QueryCache do
+  let(:app) do
+    Rack::Builder.new do
+      use SwitchPoint::QueryCache
+      run TestApp.new
+    end
+  end
+
+  describe '#call' do
+    before do
+      # Ensure the connection is established.
+      # The query cache is enabled only when connected.
+      # https://github.com/rails/rails/commit/25fc1f584def4c1bc36be805833194d8aee55b3a
+      [Nanika1, Nanika2].each do |model|
+        model.with_readonly { model.connection }
+        model.with_writable { model.connection }
+      end
+    end
+
+    it 'enables query cache of all models' do
+      env = {}
+      expect(app.call(env)).to eq(:result)
+      expect(env[:state]).to eq(
+        'Nanika1' => { readonly: true, writable: true },
+        'Nanika2' => { readonly: true, writable: true },
+      )
+    end
+
+    context 'when names are specified' do
+      let(:app) do
+        Rack::Builder.new do
+          use SwitchPoint::QueryCache, %i[main nanika1]
+          run TestApp.new
+        end
+      end
+
+      it 'enables query caches of specified models' do
+        env = {}
+        expect(app.call(env)).to eq(:result)
+        expect(env[:state]).to eq(
+          'Nanika1' => { readonly: true, writable: true },
+          'Nanika2' => { readonly: false, writable: true },
+        )
+      end
+    end
+
+    context 'when unknown name is specified' do
+      let(:app) do
+        Rack::Builder.new do
+          use SwitchPoint::QueryCache, [:unknown]
+          run TestApp.new
+        end
+      end
+
+      it 'raises error' do
+        expect { app.call({}) }.to raise_error(KeyError)
+      end
+    end
+  end
+end

data/spec/switch_point_spec.rb

@@ -1,4 +1,50 @@
+# frozen_string_literal: true
+
 RSpec.describe SwitchPoint do
+  describe '.writable_all!' do
+    after do
+      SwitchPoint.readonly_all!
+    end
+
+    it 'changes connection globally' do
+      expect(Book).to connect_to('main_readonly.sqlite3')
+      expect(Book3).to connect_to('main2_readonly.sqlite3')
+      expect(Comment).to connect_to('comment_readonly.sqlite3')
+      expect(User).to connect_to('user.sqlite3')
+      expect(BigData).to connect_to('main_readonly_special.sqlite3')
+      SwitchPoint.writable_all!
+      expect(Book).to connect_to('main_writable.sqlite3')
+      expect(Book3).to connect_to('main2_writable.sqlite3')
+      expect(Comment).to connect_to('comment_writable.sqlite3')
+      expect(User).to connect_to('user.sqlite3')
+      expect(BigData).to connect_to('main_writable.sqlite3')
+    end
+
+    it 'affects thread-globally' do
+      SwitchPoint.writable_all!
+      Thread.start do
+        expect(Book).to connect_to('main_writable.sqlite3')
+        expect(Book3).to connect_to('main2_writable.sqlite3')
+        expect(Comment).to connect_to('comment_writable.sqlite3')
+        expect(User).to connect_to('user.sqlite3')
+        expect(BigData).to connect_to('main_writable.sqlite3')
+      end.join
+    end
+
+    context 'within with block' do
+      it 'changes the current mode' do
+        SwitchPoint.writable_all!
+        Book.with_readonly do
+          expect(Book).to connect_to('main_readonly.sqlite3')
+        end
+        expect(Book).to connect_to('main_writable.sqlite3')
+        Book.with_writable do
+          expect(Book).to connect_to('main_writable.sqlite3')
+        end
+      end
+    end
+  end
+
   describe '.writable!' do
     after do
       SwitchPoint.readonly!(:main)
@@ -31,6 +77,12 @@ RSpec.describe SwitchPoint do
         end
       end
     end
+
+    context 'with unknown name' do
+      it 'raises error' do
+        expect { SwitchPoint.writable!(:unknown) }.to raise_error(KeyError)
+      end
+    end
   end
 
   describe '.with_writable' do
@@ -44,5 +96,22 @@ RSpec.describe SwitchPoint do
       expect(Publisher).to connect_to('main_readonly.sqlite3')
       expect(Nanika1).to connect_to('main_readonly.sqlite3')
     end
+
+    context 'with unknown name' do
+      it 'raises error' do
+        expect { SwitchPoint.with_writable(:unknown) { raise RuntimeError } }.to raise_error(KeyError)
+      end
+    end
+  end
+
+  describe '.with_writable_all' do
+    it 'changes all connections' do
+      expect(Book).to connect_to('main_readonly.sqlite3')
+      expect(Comment).to connect_to('comment_readonly.sqlite3')
+      SwitchPoint.with_writable_all do
+        expect(Book).to connect_to('main_writable.sqlite3')
+        expect(Comment).to connect_to('comment_writable.sqlite3')
+      end
+    end
   end
 end

data/switch_point.gemspec

@@ -1,28 +1,33 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'switch_point/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "switch_point"
+  spec.name          = 'switch_point'
   spec.version       = SwitchPoint::VERSION
-  spec.authors       = ["Kohei Suzuki"]
-  spec.email         = ["eagletmt@gmail.com"]
-  spec.summary       = %q{Switching database connection between readonly one and writable one.}
-  spec.description   = %q{Switching database connection between readonly one and writable one.}
-  spec.homepage      = "https://github.com/eagletmt/switch_point"
-  spec.license       = "MIT"
+  spec.authors       = ['Kohei Suzuki']
+  spec.email         = ['eagletmt@gmail.com']
+  spec.summary       = 'Switching database connection between readonly one and writable one.'
+  spec.description   = 'Switching database connection between readonly one and writable one.'
+  spec.homepage      = 'https://github.com/eagletmt/switch_point'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0.0.rc1"
-  spec.add_development_dependency "sqlite3"
-  spec.add_dependency "activerecord", ">= 3.2.0"
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'coveralls', '>= 0.8.22'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop', '>= 0.50.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'  # XXX: The latest coveralls still depends on old version
+  spec.add_dependency 'activerecord', '>= 3.2.0', '< 6.1.0'
 end