switch_point 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b8ceb04a21d6850779c5fcc61d2b0552bec494f
-  data.tar.gz: 0d6cc9ce87e7f320b1b7e14ff7dd3be22578dbde
+  metadata.gz: d4e8e6fce7bc9a152422f2b1ede1df15b39791c6
+  data.tar.gz: 785d1e66b759b372edb68201454238bd62879ef1
 SHA512:
-  metadata.gz: cfff954c906a2c517ea9a9fb70780bf3504d076ad25db2db6f37dcbd6eadf34017b5649465a6addc8cdbf477abb79559a8c680385f024a7b5d70a179734bf094
-  data.tar.gz: 17a845a358c5ce19a13d8b42d0bef169ffb6c756efc36cc19176bdc4780776e5071982bacac0eb82ebe0ebf33ea8e59de96b23827b03bd6d159c3c74215fc254
+  metadata.gz: 83d13eaf42dcc9e266c1bc3e703b04798ca0bb17473591a819e36c09eb40a294e3a4c57b42970428a9b09f159ac3a20a443d2f158ced0a5f309cd894ebe6d769
+  data.tar.gz: e5c054d22e52bcb1f37ba3d46fb6487b1a462b53f7b443fd9f389195bdd0ed668bd5a3b9df13006a0b2104047febe8b87b02b46e59e8e5ea1342d2f4bbd86741

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.1 (2014-06-04)
+- Support defaulting to writable ActiveRecord::Base connection
+    - When `:writable` key is omitted, ActiveRecord::Base is used for the writable connection.
+
 ## 0.3.0 (2014-06-04)
 - Improve thread safety
 - Raise appropriate error if unknown mode is given to with_connection

data/lib/switch_point/config.rb

@@ -14,7 +14,11 @@ module SwitchPoint
     end
 
     def model_name(name, mode)
-      "#{name}_#{mode}".camelize
+      if switch_points[name][mode]
+        "#{name}_#{mode}".camelize
+      else
+        nil
+      end
     end
 
     def fetch(name)
@@ -28,12 +32,15 @@ module SwitchPoint
     private
 
     def assert_valid_config!(config)
-      [:readonly, :writable].each do |mode|
-        unless config.has_key?(mode)
-          raise ArgumentError.new("#{mode} key is required")
-        end
-        unless config[mode].is_a?(Symbol)
-          raise TypeError.new("#{mode}'s value must be Symbol")
+      unless config.has_key?(:readonly)
+        raise ArgumentError.new(":readonly key is required")
+      end
+      unless config[:readonly].is_a?(Symbol)
+        raise TypeError.new(":readonly's value must be Symbol")
+      end
+      if config.has_key?(:writable)
+        unless config[:writable].is_a?(Symbol)
+          raise TypeError.new(":writable's value must be Symbol")
         end
       end
       nil

data/lib/switch_point/connection.rb

@@ -7,22 +7,44 @@ module SwitchPoint
 
     DESTRUCTIVE_METHODS.each do |method_name|
       define_method(:"#{method_name}_with_switch_point") do |*args, &block|
-        switch_point = self.pool.instance_variable_get(:@switch_point)
         parent_method = :"#{method_name}_without_switch_point"
-        if switch_point
+        if self.pool.equal?(ActiveRecord::Base.connection.pool)
+          Connection.handle_base_connection(self, parent_method, *args, &block)
+        else
+          Connection.handle_generated_connection(self, parent_method, method_name, *args, &block)
+        end
+      end
+    end
+
+    def self.handle_base_connection(conn, parent_method, *args, &block)
+      switch_points = conn.pool.instance_variable_get(:@switch_points)
+      if switch_points
+        switch_points.each do |switch_point|
           proxy = ProxyRepository.find(switch_point[:name])
-          case switch_point[:mode]
-          when :readonly
-            Connection.proxy_to_writable(proxy, method_name, *args, &block)
-          when :writable
-            Connection.purge_readonly_query_cache(proxy)
-            send(parent_method, *args, &block)
-          else
-            raise RuntimeError.new("Unknown mode #{switch_point[:mode]} is given with #{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]}")
           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)
+      switch_point = conn.pool.instance_variable_get(:@switch_point)
+      if switch_point
+        proxy = ProxyRepository.find(switch_point[:name])
+        case switch_point[:mode]
+        when :readonly
+          proxy_to_writable(proxy, method_name, *args, &block)
+        when :writable
+          purge_readonly_query_cache(proxy)
+          conn.send(parent_method, *args, &block)
         else
-          send(parent_method, *args, &block)
+          raise RuntimeError.new("Unknown mode #{switch_point[:mode]} is given with #{name}")
         end
+      else
+        conn.send(parent_method, *args, &block)
       end
     end
 

data/lib/switch_point/proxy.rb

@@ -9,22 +9,35 @@ module SwitchPoint
       @initial_name = name
       @current_name = name
       AVAILABLE_MODES.each do |mode|
-        model = define_model(SwitchPoint.config.model_name(name, mode))
-        model.establish_connection(SwitchPoint.config.database_name(name, mode))
+        model = define_model(name, mode)
         memorize_switch_point(name, mode, model.connection)
       end
       @global_mode = DEFAULT_MODE
     end
 
-    def define_model(model_name)
+    def define_model(name, mode)
       model = Class.new(ActiveRecord::Base)
-      Proxy.const_set(model_name, model)
+      model_name = SwitchPoint.config.model_name(name, mode)
+      if model_name
+        Proxy.const_set(model_name, model)
+        model.establish_connection(SwitchPoint.config.database_name(name, mode))
+      end
       model
     end
 
     def memorize_switch_point(name, mode, connection)
       switch_point = { name: name, mode: mode }
-      connection.pool.instance_variable_set(:@switch_point, switch_point)
+      pool = connection.pool
+      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}")
+        end
+        switch_points = pool.instance_variable_get(:@switch_points) || []
+        switch_points << switch_point
+        pool.instance_variable_set(:@switch_points, switch_points)
+      else
+        pool.instance_variable_set(:@switch_point, switch_point)
+      end
     end
 
     def thread_local_mode
@@ -103,7 +116,12 @@ module SwitchPoint
 
     def connection
       ProxyRepository.checkout(@current_name) # Ensure the target proxy is created
-      Proxy.const_get(SwitchPoint.config.model_name(@current_name, mode)).connection
+      model_name = SwitchPoint.config.model_name(@current_name, mode)
+      if model_name
+        Proxy.const_get(model_name).connection
+      else
+        ActiveRecord::Base.connection
+      end
     end
   end
 end

data/lib/switch_point/version.rb

@@ -1,3 +1,3 @@
 module SwitchPoint
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/models.rb

@@ -11,6 +11,10 @@ SwitchPoint.configure do |config|
   config.define_switch_point :special,
     readonly: :main_readonly_special,
     writable: :main_writable
+  config.define_switch_point :nanika1,
+    readonly: :main_readonly
+  config.define_switch_point :nanika2,
+    readonly: :main_readonly
 end
 
 class Book < ActiveRecord::Base
@@ -36,6 +40,14 @@ end
 class Note < ActiveRecord::Base
 end
 
+class Nanika1 < ActiveRecord::Base
+  use_switch_point :nanika1
+end
+
+class Nanika2 < ActiveRecord::Base
+  use_switch_point :nanika2
+end
+
 base = { adapter: 'sqlite3' }
 ActiveRecord::Base.configurations = {
   'main_readonly' => base.merge(database: 'main_readonly.sqlite3'),

data/spec/spec_helper.rb

@@ -24,11 +24,12 @@ RSpec.configure do |config|
   end
 
   config.before(:suite) do
-    sql = 'CREATE TABLE books (id integer primary key autoincrement)'
-    Book.connection.execute(sql)
     Book.with_writable do
-      Book.connection.execute(sql)
+      Book.connection.execute('CREATE TABLE books (id integer primary key autoincrement)')
     end
+    FileUtils.cp('main_writable.sqlite3', 'main_readonly.sqlite3')
+
+    Note.connection.execute('CREATE TABLE notes (id integer primary key autoincrement)')
   end
 
   config.after(:suite) do

data/spec/switch_point/model_spec.rb

@@ -68,6 +68,23 @@ RSpec.describe SwitchPoint::Model do
         end
       end
     end
+
+    context 'without :writable' do
+      it 'sends destructive queries to ActiveRecord::Base' do
+        expect(Nanika1).to connect_to('main_readonly.sqlite3')
+        Nanika1.with_writable do
+          expect(Nanika1).to connect_to('default.sqlite3')
+          expect(Nanika1.connection).to equal(ActiveRecord::Base.connection)
+        end
+      end
+
+      it 'clears all query caches' do
+        expect(Nanika1.connection).to_not equal(Nanika2.connection)
+        expect(Nanika1.connection).to receive(:clear_query_cache).once
+        expect(Nanika2.connection).to receive(:clear_query_cache).once
+        Note.create
+      end
+    end
   end
 
   describe '.with_writable' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switch_point
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kohei Suzuki