switch_point 0.5.0.pre → 0.9.0

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+
+platforms :ruby do
+  gem "sqlite3"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+
+platforms :ruby do
+  gem "sqlite3"
+end
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+
+platforms :ruby do
+  gem "sqlite3"
+end
+
+gemspec path: "../"

data/lib/switch_point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/lazy_load_hooks'
 require 'switch_point/config'
 require 'switch_point/version'
@@ -13,7 +15,7 @@ module SwitchPoint
     end
 
     def readonly_all!
-      config.keys.each do |name|
+      config.each_key do |name|
         readonly!(name)
       end
     end
@@ -23,7 +25,7 @@ module SwitchPoint
     end
 
     def writable_all!
-      config.keys.each do |name|
+      config.each_key do |name|
         writable!(name)
       end
     end
@@ -36,10 +38,18 @@ module SwitchPoint
       with_mode(:readonly, *names, &block)
     end
 
+    def with_readonly_all(&block)
+      with_readonly(*config.keys, &block)
+    end
+
     def with_writable(*names, &block)
       with_mode(:writable, *names, &block)
     end
 
+    def with_writable_all(&block)
+      with_writable(*config.keys, &block)
+    end
+
     def with_mode(mode, *names, &block)
       names.reverse.inject(block) do |func, name|
         lambda do
@@ -52,13 +62,12 @@ module SwitchPoint
 end
 
 ActiveSupport.on_load(:active_record) do
-  require 'switch_point/model'
   require 'switch_point/connection'
-  ActiveRecord::Base.send(:include, SwitchPoint::Model)
+  require 'switch_point/model'
+  require 'switch_point/query_cache'
+
+  ActiveRecord::Base.include SwitchPoint::Model
   ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
-    include SwitchPoint::Connection
-    SwitchPoint::Connection::DESTRUCTIVE_METHODS.each do |method_name|
-      alias_method_chain method_name, :switch_point
-    end
+    prepend SwitchPoint::Connection
   end
 end

data/lib/switch_point/config.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 module SwitchPoint
   class Config
+    attr_accessor :auto_writable
+    alias_method :auto_writable?, :auto_writable
+
     def initialize
       self.auto_writable = false
     end
@@ -9,27 +14,17 @@ module SwitchPoint
       switch_points[name] = config
     end
 
-    def auto_writable=(val)
-      @auto_writable = val
-    end
-
-    def auto_writable?
-      @auto_writable
-    end
-
     def switch_points
       @switch_points ||= {}
     end
 
     def database_name(name, mode)
-      switch_points[name][mode]
+      fetch(name)[mode]
     end
 
     def model_name(name, mode)
-      if switch_points[name][mode]
+      if fetch(name)[mode]
         "#{name}_#{mode}".camelize
-      else
-        nil
       end
     end
 
@@ -41,18 +36,23 @@ module SwitchPoint
       switch_points.keys
     end
 
+    def each_key(&block)
+      switch_points.each_key(&block)
+    end
+
     private
 
     def assert_valid_config!(config)
-      unless config.has_key?(:readonly) || config.has_key?(:writable)
+      unless config.key?(:readonly) || config.key?(:writable)
         raise ArgumentError.new(':readonly or :writable must be specified')
       end
-      if config.has_key?(:readonly)
+
+      if config.key?(:readonly)
         unless config[:readonly].is_a?(Symbol)
           raise TypeError.new(":readonly's value must be Symbol")
         end
       end
-      if config.has_key?(:writable)
+      if config.key?(:writable)
         unless config[:writable].is_a?(Symbol)
           raise TypeError.new(":writable's value must be Symbol")
         end

data/lib/switch_point/connection.rb

@@ -1,36 +1,37 @@
+# frozen_string_literal: true
+
+require 'switch_point/error'
 require 'switch_point/proxy_repository'
 
 module SwitchPoint
   module Connection
     # See ActiveRecord::ConnectionAdapters::QueryCache
-    DESTRUCTIVE_METHODS = [:insert, :update, :delete]
+    DESTRUCTIVE_METHODS = %i[insert update delete].freeze
 
     DESTRUCTIVE_METHODS.each do |method_name|
-      define_method(:"#{method_name}_with_switch_point") do |*args, &block|
-        parent_method = :"#{method_name}_without_switch_point"
-        if self.pool.equal?(ActiveRecord::Base.connection_pool)
-          Connection.handle_base_connection(self, parent_method, *args, &block)
+      define_method(method_name) do |*args, &block|
+        if pool.equal?(ActiveRecord::Base.connection_pool)
+          Connection.handle_base_connection(self)
+          super(*args, &block)
         else
+          parent_method = method(method_name).super_method
           Connection.handle_generated_connection(self, parent_method, method_name, *args, &block)
         end
       end
     end
 
-    class ReadonlyError < StandardError
-    end
-
-    def self.handle_base_connection(conn, parent_method, *args, &block)
+    def self.handle_base_connection(conn)
       switch_points = conn.pool.spec.config[:switch_points]
       if switch_points
         switch_points.each do |switch_point|
           proxy = ProxyRepository.find(switch_point[:name])
           if switch_point[:mode] != :writable
-            raise RuntimeError.new("ActiveRecord::Base's switch_points must be writable, but #{switch_point[:name]} is #{switch_point[:mode]}")
+            raise Error.new("ActiveRecord::Base's switch_points must be writable, but #{switch_point[:name]} is #{switch_point[:mode]}")
           end
+
           purge_readonly_query_cache(proxy)
         end
       end
-      conn.send(parent_method, *args, &block)
     end
 
     def self.handle_generated_connection(conn, parent_method, method_name, *args, &block)
@@ -46,12 +47,12 @@ module SwitchPoint
           end
         when :writable
           purge_readonly_query_cache(proxy)
-          conn.send(parent_method, *args, &block)
+          parent_method.call(*args, &block)
         else
-          raise RuntimeError.new("Unknown mode #{switch_point[:mode]} is given with #{name}")
+          raise Error.new("Unknown mode #{switch_point[:mode]} is given with #{name}")
         end
       else
-        conn.send(parent_method, *args, &block)
+        parent_method.call(*args, &block)
       end
     end
 

data/lib/switch_point/error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SwitchPoint
+  class Error < StandardError
+  end
+
+  class ReadonlyError < Error
+  end
+
+  class UnconfiguredError < Error
+  end
+end

data/lib/switch_point/model.rb

@@ -1,28 +1,36 @@
+# frozen_string_literal: true
+
+require 'switch_point/error'
 require 'switch_point/proxy_repository'
 
 module SwitchPoint
   module Model
     def self.included(model)
+      super
       model.singleton_class.class_eval do
         include ClassMethods
-        alias_method_chain :connection, :switch_point
+        prepend MonkeyPatch
       end
     end
 
-    module ClassMethods
-      def connection_with_switch_point
-        if switch_point_proxy
-          switch_point_proxy.connection
-        else
-          connection_without_switch_point
-        end
-      end
+    def with_readonly(&block)
+      self.class.with_readonly(&block)
+    end
 
+    def with_writable(&block)
+      self.class.with_writable(&block)
+    end
+
+    def transaction_with(*models, &block)
+      self.class.transaction_with(*models, &block)
+    end
+
+    module ClassMethods
       def with_readonly(&block)
         if switch_point_proxy
           switch_point_proxy.with_readonly(&block)
         else
-          block.call
+          raise UnconfiguredError.new("#{name} isn't configured to use switch_point")
         end
       end
 
@@ -30,7 +38,7 @@ module SwitchPoint
         if switch_point_proxy
           switch_point_proxy.with_writable(&block)
         else
-          block.call
+          raise UnconfiguredError.new("#{name} isn't configured to use switch_point")
         end
       end
 
@@ -40,7 +48,7 @@ module SwitchPoint
       end
 
       def switch_point_proxy
-        if @switch_point_name
+        if defined?(@switch_point_name)
           ProxyRepository.checkout(@switch_point_name)
         elsif self == ActiveRecord::Base
           nil
@@ -51,11 +59,11 @@ module SwitchPoint
 
       def transaction_with(*models, &block)
         unless can_transaction_with?(*models)
-          raise RuntimeError.new("switch_point's model names must be consistent")
+          raise Error.new("switch_point's model names must be consistent")
         end
 
         with_writable do
-          self.transaction(&block)
+          transaction(&block)
         end
       end
 
@@ -72,13 +80,37 @@ module SwitchPoint
               model.instance_variable_get(:@switch_point_name),
               :writable
             )
-          else
-            nil
           end
         end
 
         writable_switch_points.uniq.size == 1
       end
     end
+
+    module MonkeyPatch
+      def connection
+        if switch_point_proxy
+          switch_point_proxy.connection
+        else
+          super
+        end
+      end
+
+      def cache(&block)
+        if switch_point_proxy
+          switch_point_proxy.cache(&block)
+        else
+          super
+        end
+      end
+
+      def uncached(&block)
+        if switch_point_proxy
+          switch_point_proxy.uncached(&block)
+        else
+          super
+        end
+      end
+    end
   end
 end

data/lib/switch_point/proxy.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
+require 'switch_point/error'
+
 module SwitchPoint
   class Proxy
     attr_reader :initial_name
 
-    AVAILABLE_MODES = [:writable, :readonly]
+    AVAILABLE_MODES = %i[writable readonly].freeze
     DEFAULT_MODE = :readonly
 
     def initialize(name)
@@ -26,7 +30,7 @@ module SwitchPoint
         # Re-use writable connection
         Proxy.const_get(SwitchPoint.config.model_name(name, :writable))
       else
-        Class.new(ActiveRecord::Base)
+        ActiveRecord::Base
       end
     end
 
@@ -34,12 +38,13 @@ module SwitchPoint
       switch_point = { name: name, mode: mode }
       if pool.equal?(ActiveRecord::Base.connection_pool)
         if mode != :writable
-          raise RuntimeError.new("ActiveRecord::Base's switch_points must be writable, but #{name} is #{mode}")
+          raise Error.new("ActiveRecord::Base's switch_points must be writable, but #{name} is #{mode}")
         end
+
         switch_points = pool.spec.config[:switch_points] || []
         switch_points << switch_point
         pool.spec.config[:switch_points] = switch_points
-      elsif pool.spec.config.has_key?(:switch_point)
+      elsif pool.spec.config.key?(:switch_point)
         # Only :writable is specified
       else
         pool.spec.config[:switch_point] = switch_point
@@ -95,7 +100,8 @@ module SwitchPoint
       unless AVAILABLE_MODES.include?(new_mode)
         raise ArgumentError.new("Unknown mode: #{new_mode}")
       end
-      saved_mode = self.thread_local_mode
+
+      saved_mode = thread_local_mode
       self.thread_local_mode = new_mode
       block.call
     ensure
@@ -142,5 +148,17 @@ module SwitchPoint
     def connected?
       model_for_connection.connected?
     end
+
+    def cache(&block)
+      r = with_readonly { model_for_connection }
+      w = with_writable { model_for_connection }
+      r.cache { w.cache(&block) }
+    end
+
+    def uncached(&block)
+      r = with_readonly { model_for_connection }
+      w = with_writable { model_for_connection }
+      r.uncached { w.uncached(&block) }
+    end
   end
 end

data/lib/switch_point/proxy_repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'switch_point/proxy'
 

data/lib/switch_point/query_cache.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SwitchPoint
+  class QueryCache
+    def initialize(app, names = nil)
+      @app = app
+      @names = names
+    end
+
+    def call(env)
+      names.reverse.inject(lambda { @app.call(env) }) do |func, name|
+        lambda { ProxyRepository.checkout(name).cache(&func) }
+      end.call
+    end
+
+    private
+
+    def names
+      @names ||= SwitchPoint.config.keys
+    end
+  end
+end