database_slave 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: d29bdcf5bfb9d4ba3ef24383ff365cf3f6476408
-  data.tar.gz: d9229d9c018ac2abf96ace3ff7574666b0e7087e
-SHA512:
-  metadata.gz: 0b8219a825ccacffba30827b92a38743f8dfb41835380a74f4c1edba88df788002b7a8189cf4012a5b1f89465dc534d30d4d8d0eff8bcde5da98e11aee43008a
-  data.tar.gz: c38189f41332ab653580de3938a688b681e727daa2eb2edd3c5ab62ee72c7ee21d6d6f9639dbdee01946bd95b7ea0f8ed6416bf6b000a2560dd095b75ea37fda
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjZhMzMxNjJjNmYzZmNmM2VkYTc0OGY1MmJjMjhkNzJhYzVlOTczZA==
+  data.tar.gz: !binary |-
+    NzlkOGUyODcwOWVkOTQxNTYyN2VmYjcxMjY3ZTk1ZmE0NjcwN2YwZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NWNkMzAzNjcwOTI5M2ViZjk0OGEwOWQyODlmMjcyNzg1YmMwZmRjZGZhMWFj
+    MjczMjc5ZWUxNjQzYzUzY2E2MjZjODI2YTQzODkxZmU0Yzg5YWIwYjdjZTc1
+    ZDUzYTMyYmE4MzFlZWQ4MjZiN2VmNmQ3Y2M4MGIzZjZkNDM1MTI=
+  data.tar.gz: !binary |-
+    YTgzNWZiMjdmYjFjOTZkYTM0ZmM5YmJjNWI4MDk0NWFmYjE0YTQ5NjY1NDc3
+    M2YzMTQyZTYyZTA1ZjViZDhlMzUyMGQ0NWFkODExOTJkODMwMzllODk1Y2Fm
+    OTc3ZjhiYzNiZjEwNmI1NTQ0ZjA1OTc0MGQxN2I1Nzc5YzRmOWM=

data/CHANGELOG

@@ -0,0 +1,4 @@
+0.1.1 - 2015.03.31
+  * alias using using_slave
+  * 解决父查询中包含default_scope等子查询而导致父查询不走从库的bug
+  * supprt pluck/count/sum etc.

data/README.md

@@ -1,4 +1,7 @@
 # Database_slave
+[![Gem Version](https://badge.fury.io/rb/database_slave.svg)](https://github.com/Gnodiah/database_slave)
+![](http://ruby-gem-downloads-badge.herokuapp.com/database_slave?type=total&color=red)
+
 This gem provides master and slave databases support for Rails applications. It maintains a slave database configuration in config/shards.yml, and treats config/database.yml as master database. Then, you can choose which database you want to use in your ActiveRecord::Relation clauses.
 
 For example, you can use slave database to execute complicated and time-consuming database queries to balance the performance of master database, or separate read and write database operations.
@@ -8,12 +11,26 @@ For example, you can use slave database to execute complicated and time-consumin
 * Ruby  >= 2.0.0
 * Rails >= 3.2.x
 
+# Installation
+
+Put the following line into you Gemfile:
+
+```bash
+gem 'database_slave', '>= 0.1.0'
+```
+
+then execute:
+
+```bash
+bundle install
+```
+
 # Preparing
 
 1. First of all, create a file named **shards.yml** in your Rails config directory,
   its content is very similar to config/database.yml:
 
-  ```
+  ```yml
   development:
     slave_database1:
       adapter: mysql2
@@ -40,7 +57,7 @@ For example, you can use slave database to execute complicated and time-consumin
 
 2. Then add following to your settings.yml file:
 
-  ```
+  ```ruby
   using_slave: true
   ```
 

data/TODOLIST

@@ -2,3 +2,4 @@
 * 添加测试代码
 * 需要优化代码: 只允许gem外部代码read slave_name, 不允许write(出于安全考虑)
 * 添加generator自动生成config/shards.yml.example
+* 根据从库名自动生成方法如using_book_slave, 代替using_slave(:book_slave)

data/database_slave.gemspec

@@ -5,7 +5,6 @@ require 'database_slave/version'
 Gem::Specification.new do |gem|
   gem.name                  = 'database_slave'
   gem.version               = DatabaseSlave::VERSION
-  gem.date                  = '2015-03-17'
   gem.summary               = "Provide master and slave databases support for Rails applications."
   gem.description           = "Provide master and slave databases support for Rails applications."
   gem.authors               = ["Hayden Wei"]

data/lib/database_slave/base.rb

@@ -7,7 +7,7 @@ module DatabaseSlave
       self.slave_connections = []
 
       class << self
-        delegate :using_slave, to: :scoped
+        delegate :using_slave, :using, to: :scoped
       end
     end
   end

data/lib/database_slave/relation.rb

@@ -47,7 +47,7 @@ module DatabaseSlave
       end
     end
 
-    # alias using using_slave
+    alias using using_slave
 
     # === Description
     #
@@ -55,18 +55,97 @@ module DatabaseSlave
     #
     # 这里我们重写ActiveRecord::Relation的to_a方法只是为了做一件事:
     #
-    #   必须在当前relation返回后将是否使用从库的标识设置为否, 
+    #   必须在当前relation返回后将是否使用从库的标识设置为否,
     #   以免影响执行下一个relation时的主从库选择错误.
     #
     # 对应到代码即:
     #   DatabaseSlave::RuntimeRegistry.current_slave_name = nil
     #
     def to_a
-      DatabaseSlave::RuntimeRegistry.current_slave_name = slave_name if using_slave?
+      # 该if语句的作用是: 确保在一条使用从库的查询中存在的其他先决条件的
+      # 查询也使用从库。例如:
+      #
+      #   class Book < ActiveRecord::Base
+      #     default_scope lambda { where(:tag_id => Tag.published.pluck(:id)) }
+      #   end
+      #
+      # 当我们使用如下查询
+      #
+      #   Book.order('id DESC').limit(2).pluck(:id)
+      #
+      # 时, default_scope中的Tag需要被先查询出来. 为了Book和Tag的查询都使用从库,
+      # 避免查询Tag后便释放了从库连接而导致Book的查询使用的还是主库. 故在这里
+      # 加了条件判断: 如果父查询已经设置了使用从库, 那么内部的所有查询都使用从库,
+      # 直到父查询返回.
+      #
+      # Supports ActiveRecord::QueryMethods:
+      #   select, group, order, reorder, joins, where, having,
+      #   limit, offset, uniq
+      #
+      # And ActiveRecord::FinderMethods:
+      #   first, first!, last, last!, find, all
+      #
+      # And ActiveRecord::Batches:
+      #   find_each, find_in_batches
+      #
+      if !DatabaseSlave::RuntimeRegistry.current_slave_name
+        begin
+          DatabaseSlave::RuntimeRegistry.current_slave_name = slave_name if using_slave?
+          super
+        ensure
+          DatabaseSlave::RuntimeRegistry.current_slave_name = nil
+        end
+      else
+        super
+      end
+    end if defined?(Rails)
 
-      super
-    ensure
-      DatabaseSlave::RuntimeRegistry.current_slave_name = nil
+    # Supports ActiveRecord::FinderMethods:
+    #   exists?
+    #
+    def exists?(id = false)
+      if !DatabaseSlave::RuntimeRegistry.current_slave_name
+        begin
+          DatabaseSlave::RuntimeRegistry.current_slave_name = slave_name if using_slave?
+          super
+        ensure
+          DatabaseSlave::RuntimeRegistry.current_slave_name = nil
+        end
+      else
+        super
+      end
+    end if defined?(Rails)
+
+    # Supports ActiveRecord::Calculations:
+    #   pluck
+    #
+    def pluck(column_name)
+      if !DatabaseSlave::RuntimeRegistry.current_slave_name
+        begin
+          DatabaseSlave::RuntimeRegistry.current_slave_name = slave_name if using_slave?
+          super
+        ensure
+          DatabaseSlave::RuntimeRegistry.current_slave_name = nil
+        end
+      else
+        super
+      end
+    end if defined?(Rails)
+
+    # Supports ActiveRecord::Calculations:
+    #   count, average, minimun, maximum, sum, calculate
+    #
+    def calculate(operation, column_name, options = {})
+      if !DatabaseSlave::RuntimeRegistry.current_slave_name
+        begin
+          DatabaseSlave::RuntimeRegistry.current_slave_name = slave_name if using_slave?
+          super
+        ensure
+          DatabaseSlave::RuntimeRegistry.current_slave_name = nil
+        end
+      else
+        super
+      end
     end if defined?(Rails)
   end
 

data/lib/database_slave/version.rb

@@ -1,3 +1,3 @@
 module DatabaseSlave
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_slave
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Hayden Wei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies: []
 description: Provide master and slave databases support for Rails applications.
 email: haidongrun@gmail.com
@@ -16,7 +16,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- CHANGELOG
 - LICENSE
 - README.md
 - TODOLIST
@@ -39,18 +40,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Provide master and slave databases support for Rails applications.
 test_files: []
+has_rdoc: