switch_point 0.4.4 → 0.5.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6b1805e5054f11a52d44b88cd368c7d818d5d68
-  data.tar.gz: b4f1be476532072424bfa41ce5222248c313975c
+  metadata.gz: d937f9d15338cf8a36af264c6c5ff63c985edd11
+  data.tar.gz: 77fb0385c14264cb283ed32f41493dde3aa2ec7a
 SHA512:
-  metadata.gz: c7a172fbd91894e792564c1116e596ae918c0c33f42ce81c11e0c19650684faf2ccf27f096a35e65b3fcc964dc6d0e0945d625a3c22da251e8dd27612eb2c5d4
-  data.tar.gz: bfad8456783ebfa78e92a06af283adf7f0f2168dcf5dbba049e2c2db47ea1b4cd97b68e61ff56916f36a96391d889b94433afb5c4f8c08f236c57ce88ca6ad17
+  metadata.gz: 3dfd6368a9967952b2eb83770ae3e700fe2f2299965364d3ebdca23f986f14303fb565a54b71c32b459df632067dcad8dd941dc1c6d3bc4cd6f97dc95fd3b1f8
+  data.tar.gz: 750d9ea20a474e5d453208dc95fef6df37fa3f6e4ce466a6d341a5ada8b6709a3797abbbef9e37340a1da03f8d9f0e640e55bb607d9cb06a37c6315850764551

data/.travis.yml

@@ -1,12 +1,15 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.1
+  - 2.1
+  - 2.2
   - ruby-head
 gemfile:
   - gemfiles/rails_3.2.gemfile
   - gemfiles/rails_4.0.gemfile
   - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_edge.gemfile
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - gemfile: gemfiles/rails_edge.gemfile

data/Appraisals

@@ -10,4 +10,8 @@ appraise 'rails-4.1' do
   gem 'activerecord', '~> 4.1'
 end
 
+appraise 'rails-edge' do
+  gem 'activerecord', git: 'https://github.com/rails/rails'
+end
+
 # vim: set ft=ruby:

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.5.0 (XXXX-XX-XX)
+- Rename `SwitchPoint.with_connection` to `SwitchPoint.with_mode`
+    - To avoid confusion with `ActiveRecord::ConnectionPool#with_connection`
+- Inherit superclass' switch_point configuration
+
 ## 0.4.4 (2014-07-14)
 - Memorize switch_point config to ConnectionSpecification#config instead of ConnectionPool
     - To support multi-threaded environment since Rails 4.0.

data/README.md

@@ -21,8 +21,75 @@ Or install it yourself as:
     $ gem install switch_point
 
 ## Usage
-
-See [spec/models](spec/models.rb).
+Suppose you have 4 databases: db-blog-master, db-blog-slave, db-comment-master and db-comment-slave.
+Article model and Category model are stored in db-blog-{master,slave} and Comment model is stored in db-comment-{master,slave}.
+
+### Configuration
+In database.yml:
+
+```yaml
+production_blog_master:
+  adapter: mysql2
+  username: blog_writable
+  host: db-blog-master
+production_blog_slave:
+  adapter: mysql2
+  username: blog_readonly
+  host: db-blog-slave
+production_comment_master:
+    ...
+```
+
+In initializer:
+
+```ruby
+SwitchPoint.configure do |config|
+  config.define_switch_point :blog,
+    readonly: :"#{Rails.env}_blog_slave",
+    writable: :"#{Rails.env}_blog_master"
+  config.define_switch_point :comment,
+    readonly: :"#{Rails.env}_comment_slave",
+    writable: :"#{Rails.env}_comment_master"
+end
+```
+
+In models:
+
+```ruby
+class Article < ActiveRecord::Base
+  use_switch_point :blog
+end
+
+class Category < ActiveRecord::Base
+  use_switch_point :blog
+end
+
+class Comment < ActiveRecord::Base
+  use_switch_point :comment
+end
+```
+
+### Switching connections
+
+```ruby
+Article.with_readonly { Article.first } # Read from db-blog-slave
+Category.with_readonly { Category.first } # Also read from db-blog-slave
+Comment.with_readonly { Comment.first } # Read from db-comment-slave
+
+Article.with_readonly do
+  article = Article.first  # Read from db-blog-slave
+  article.title = 'new title'
+  Article.with_writable do
+    article.save!  # Write to db-blog-master
+    article.reload  # Read from db-blog-master
+    Category.first  # Read from db-blog-master
+  end
+end
+```
+
+Note that Article and Category shares their connections.
+
+## Notes
 
 ### auto_writable
 `auto_writable` is disabled by default.

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", :git => "https://github.com/rails/rails"
+
+gemspec :path => "../"

data/lib/switch_point.rb

@@ -33,17 +33,17 @@ module SwitchPoint
     end
 
     def with_readonly(*names, &block)
-      with_connection(:readonly, *names, &block)
+      with_mode(:readonly, *names, &block)
     end
 
     def with_writable(*names, &block)
-      with_connection(:writable, *names, &block)
+      with_mode(:writable, *names, &block)
     end
 
-    def with_connection(mode, *names, &block)
+    def with_mode(mode, *names, &block)
       names.reverse.inject(block) do |func, name|
         lambda do
-          ProxyRepository.checkout(name).with_connection(mode, &func)
+          ProxyRepository.checkout(name).with_mode(mode, &func)
         end
       end.call
     end

data/lib/switch_point/model.rb

@@ -11,7 +11,7 @@ module SwitchPoint
 
     module ClassMethods
       def connection_with_switch_point
-        if @switch_point_name
+        if switch_point_proxy
           switch_point_proxy.connection
         else
           connection_without_switch_point
@@ -42,8 +42,10 @@ module SwitchPoint
       def switch_point_proxy
         if @switch_point_name
           ProxyRepository.checkout(@switch_point_name)
-        else
+        elsif self == ActiveRecord::Base
           nil
+        else
+          superclass.switch_point_proxy
         end
       end
 

data/lib/switch_point/proxy.rb

@@ -84,14 +84,14 @@ module SwitchPoint
     end
 
     def with_readonly(&block)
-      with_connection(:readonly, &block)
+      with_mode(:readonly, &block)
     end
 
     def with_writable(&block)
-      with_connection(:writable, &block)
+      with_mode(:writable, &block)
     end
 
-    def with_connection(new_mode, &block)
+    def with_mode(new_mode, &block)
       unless AVAILABLE_MODES.include?(new_mode)
         raise ArgumentError.new("Unknown mode: #{new_mode}")
       end

data/lib/switch_point/version.rb

@@ -1,3 +1,3 @@
 module SwitchPoint
-  VERSION = "0.4.4"
+  VERSION = "0.5.0.pre"
 end

data/spec/models.rb

@@ -73,6 +73,18 @@ class Nanika3 < ActiveRecord::Base
   use_switch_point :nanika3
 end
 
+class AbstractNanika < ActiveRecord::Base
+  use_switch_point :main
+  self.abstract_class = true
+end
+
+class DerivedNanika1 < AbstractNanika
+end
+
+class DerivedNanika2 < AbstractNanika
+  use_switch_point :main2
+end
+
 base = { adapter: 'sqlite3' }
 ActiveRecord::Base.configurations = {
   'main_readonly' => base.merge(database: 'main_readonly.sqlite3'),

data/spec/switch_point/model_spec.rb

@@ -101,6 +101,35 @@ RSpec.describe SwitchPoint::Model do
       end
     end
 
+    context 'when superclass uses use_switch_point' do
+      context 'without use_switch_point in derived class' do
+        it 'inherits switch_point configuration' do
+          expect(DerivedNanika1).to connect_to('main_readonly.sqlite3')
+        end
+
+        it 'shares connection with superclass' do
+          expect(DerivedNanika1.connection).to equal(AbstractNanika.connection)
+        end
+      end
+
+      context 'with use_switch_point in derived class' do
+        it 'overrides superclass' do
+          expect(DerivedNanika2).to connect_to('main2_readonly.sqlite3')
+        end
+      end
+
+      context 'when superclass changes switch_point' do
+        after do
+          AbstractNanika.use_switch_point :main
+        end
+
+        it 'follows' do
+          AbstractNanika.use_switch_point :main2
+          expect(DerivedNanika1).to connect_to('main2_readonly.sqlite3')
+        end
+      end
+    end
+
     context 'without :writable' do
       it 'sends destructive queries to ActiveRecord::Base' do
         expect(Nanika1).to connect_to('main_readonly.sqlite3')
@@ -233,9 +262,9 @@ RSpec.describe SwitchPoint::Model do
     end
   end
 
-  describe '#with_connection' do
+  describe '#with_mode' do
     it 'raises error if unknown mode is given' do
-      expect { SwitchPoint::ProxyRepository.checkout(:main).with_connection(:typo) }.to raise_error
+      expect { SwitchPoint::ProxyRepository.checkout(:main).with_mode(:typo) }.to raise_error
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: switch_point
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0.pre
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -128,6 +128,7 @@ files:
 - gemfiles/rails_3.2.gemfile
 - gemfiles/rails_4.0.gemfile
 - gemfiles/rails_4.1.gemfile
+- gemfiles/rails_edge.gemfile
 - lib/switch_point.rb
 - lib/switch_point/config.rb
 - lib/switch_point/connection.rb
@@ -155,9 +156,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2