switch_point 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77687087fa3661aba6aace55de51de3f92de2e93
-  data.tar.gz: ec806bac134278e915188fa93d988d640b8e50ac
+  metadata.gz: 7e586669d11f096afeeb93a78957547b262583dd
+  data.tar.gz: 72070196c4ca9a4ace102c2e70e24924eac98859
 SHA512:
-  metadata.gz: e5d6a8c24fa34a4cdefd0e87786c62bc9e861beb2d848478445cb9329362b9457bfdfe06f64ad27c451a21731feddd2a7a7d70b9d4b6a361c9177701640a6a9c
-  data.tar.gz: 90bcacff53ac17022d2494584c564daa56942f978e30fd7c0322a93063f7a193b057d241a2837767b043bae06a6f79dd96c43fc95cfa0d3cd7232333d4d9efd4
+  metadata.gz: bcd62b44be847b7466f31083b10eb9662061e27f33855d75bc5867ba5c12b43ac6fd57e2fb539e5a3234755540e397b9c5a3c1b30a036cbb09b60ef63d6ed282
+  data.tar.gz: 56249e61ef7b33a5b170680a1fd9350e8fdc42a54d051790e2c6bbb53b2056661e93c9fed7a66d9cdc1a9b4b49ef6926073f12d5dc2ba7764e27a8fbbac4ef2c

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.4.3 (2014-06-24)
+- Add Model.transaction_with method (#2, @ryopeko)
+
 ## 0.4.2 (2014-06-19)
 - Establish connection lazily
     - Just like ActiveRecord::Base, real connection isn't created until `.connection` is called

data/README.md

@@ -40,6 +40,11 @@ Suppose `after_save` callback is set to User model. When `User.create` is called
     - At this point, the connection is READONLY and in a transaction.
 6. COMMIT TRANSACTION is sent to READONLY connection.
 
+### connection-related methods of model
+Model has several connection-related methods: `connection_handler`, `connection_pool`, `connected?` and so on.
+Since only `connection` method is monkey-patched, other connection-related methods doesn't work properly.
+If you'd like to use those methods, send it to `Model.switch_point_proxy.model_for_connection`.
+
 ## Internals
 There's a proxy which holds two connections: readonly one and writable one.
 A proxy has a thread-local state indicating the current mode: readonly or writable.

data/lib/switch_point/model.rb

@@ -47,11 +47,36 @@ module SwitchPoint
         end
       end
 
+      def transaction_with(*models, &block)
+        unless can_transaction_with?(*models)
+          raise RuntimeError.new("switch_point's model names must be consistent")
+        end
+
+        with_writable do
+          self.transaction(&block)
+        end
+      end
+
       private
 
       def assert_existing_switch_point!(name)
         SwitchPoint.config.fetch(name)
       end
+
+      def can_transaction_with?(*models)
+        writable_switch_points = [self, *models].map do |model|
+          if model.instance_variable_defined?(:@switch_point_name)
+            SwitchPoint.config.model_name(
+              model.instance_variable_get(:@switch_point_name),
+              :writable
+            )
+          else
+            nil
+          end
+        end
+
+        writable_switch_points.uniq.size == 1
+      end
     end
   end
 end

data/lib/switch_point/proxy.rb

@@ -120,19 +120,27 @@ module SwitchPoint
       @current_name = @initial_name
     end
 
-    def connection
+    def model_for_connection
       ProxyRepository.checkout(@current_name) # Ensure the target proxy is created
       model_name = SwitchPoint.config.model_name(@current_name, mode)
       if model_name
-        Proxy.const_get(model_name).connection
+        Proxy.const_get(model_name)
       elsif mode == :readonly
         # When only writable is specified, re-use writable connection.
         with_writable do
-          connection
+          model_for_connection
         end
       else
-        ActiveRecord::Base.connection
+        ActiveRecord::Base
       end
     end
+
+    def connection
+      model_for_connection.connection
+    end
+
+    def connected?
+      model_for_connection.connected?
+    end
   end
 end

data/lib/switch_point/version.rb

@@ -1,3 +1,3 @@
 module SwitchPoint
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/spec/models.rb

@@ -2,6 +2,9 @@ SwitchPoint.configure do |config|
   config.define_switch_point :main,
     readonly: :main_readonly,
     writable: :main_writable
+  config.define_switch_point :main2,
+    readonly: :main2_readonly,
+    writable: :main2_writable
   config.define_switch_point :user,
     readonly: :user,
     writable: :user
@@ -31,6 +34,14 @@ class Book < ActiveRecord::Base
   end
 end
 
+class Book2 < ActiveRecord::Base
+  use_switch_point :main
+end
+
+class Book3 < ActiveRecord::Base
+  use_switch_point :main2
+end
+
 class Publisher < ActiveRecord::Base
   use_switch_point :main
 end
@@ -66,6 +77,8 @@ base = { adapter: 'sqlite3' }
 ActiveRecord::Base.configurations = {
   'main_readonly' => base.merge(database: 'main_readonly.sqlite3'),
   'main_writable' => base.merge(database: 'main_writable.sqlite3'),
+  'main2_readonly' => base.merge(database: 'main2_readonly.sqlite3'),
+  'main2_writable' => base.merge(database: 'main2_writable.sqlite3'),
   'main_readonly_special' => base.merge(database: 'main_readonly_special.sqlite3'),
   'user' => base.merge(database: 'user.sqlite3'),
   'comment_readonly' => base.merge(database: 'comment_readonly.sqlite3'),
@@ -76,8 +89,20 @@ ActiveRecord::Base.establish_connection(:default)
 
 # XXX: Check connection laziness
 [Book, User, Note, Nanika1, ActiveRecord::Base].each do |model|
+  if model.connected?
+    raise "ActiveRecord::Base didn't establish connection lazily!"
+  end
+end
+ActiveRecord::Base.connection # Create connection
+
+[Book, User, Nanika3].each do |model|
   model.with_writable do
-    if model.connected?
+    if model.switch_point_proxy.connected?
+      raise "#{model.name} didn't establish connection lazily!"
+    end
+  end
+  model.with_readonly do
+    if model.switch_point_proxy.connected?
       raise "#{model.name} didn't establish connection lazily!"
     end
   end

data/spec/spec_helper.rb

@@ -38,8 +38,19 @@ RSpec.configure do |config|
     Book.with_writable do
       Book.connection.execute('CREATE TABLE books (id integer primary key autoincrement)')
     end
+
+    Book2.with_writable do
+      Book2.connection.execute('CREATE TABLE book2s (id integer primary key autoincrement)')
+    end
+
     FileUtils.cp('main_writable.sqlite3', 'main_readonly.sqlite3')
 
+    Book3.with_writable do
+      Book3.connection.execute('CREATE TABLE book3s (id integer primary key autoincrement)')
+    end
+
+    FileUtils.cp('main2_writable.sqlite3', 'main2_readonly.sqlite3')
+
     Note.connection.execute('CREATE TABLE notes (id integer primary key autoincrement)')
 
     Nanika3.connection.execute('CREATE TABLE nanika3s (id integer primary key)')

data/spec/switch_point/model_spec.rb

@@ -261,4 +261,112 @@ RSpec.describe SwitchPoint::Model do
       end
     end
   end
+
+  describe '.transaction_with' 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
+        end
+
+        @after_book_count = Book.with_writable do
+          Book.count
+        end
+        @after_book2_count = Book2.with_writable do
+          Book2.count
+        end
+      end
+
+      it 'should create a new record' do
+        expect(
+          Book.with_writable do
+            Book.count
+          end
+        ).to be > @before_book_count
+
+        expect(
+          Book2.with_writable do
+            Book2.count
+          end
+        ).to be > @before_book2_count
+      end
+    end
+
+    context "when each model has a other writable" do
+      it {
+        expect {
+          Book.transaction_with(Book3) do
+            new_book  = Book.create
+            new_book3 = Book3.create
+          end
+        }.to raise_error RuntimeError
+      }
+    end
+
+    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
+            Book3.create
+          end
+          raise ActiveRecord::Rollback
+        end
+      end
+
+      it 'Book should not create a new record (rollbacked)' do
+        expect(
+          Book.with_writable do
+            Book.count
+          end
+        ).to eq @before_book_count
+      end
+
+      it 'Book3 should create a new record (not rollbacked)' do
+        expect(
+          Book3.with_writable do
+            Book3.count
+          end
+        ).to be > @before_book3_count
+      end
+    end
+
+    context "when nested transaction_with then parent transaction rollbacked" do
+      before do
+        @before_book_count  = Book.count
+        @before_book3_count = Book3.count
+
+        Book.transaction_with do
+          Book.create
+
+          Book3.transaction_with do
+            Book3.create
+          end
+
+          raise ActiveRecord::Rollback
+        end
+
+        it {
+          expect(
+            Book.with_writable do
+              Book.count
+            end
+          ).to be = @before_book_count
+
+          expect(
+            Book3.with_writable do
+              Book3.count
+            end
+          ).to be > @before_book3_count
+        }
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: switch_point
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal