switch_connection 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a610610ba7b802579bd70c8b25df8f8bba50299
+  data.tar.gz: c796e8855c8f3472629390723cd8c0c6c00559ea
+SHA512:
+  metadata.gz: b3a4ad59a79b047914a09d125bae342993ab7b619cd48c23a2d7b0c53ade3be1d1d74948ae011a91741247b10729a611d5f1494e538945a641f196c9f4476958
+  data.tar.gz: 3d2fa748e38c0dc9536d9d41d0699868d387556df4d7730ba19e621a79a69e05d593f7b4810ed8e5f9d6dbdeb933fb4d4a0f765cb94b2025ceeaccc67543aca6

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor
+/gemfiles/*.lock
+.idea
+.ruby-version

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,63 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  Exclude:
+    - "gemfiles/**/*"
+    - "vendor/**/*"
+
+Performance/RedundantBlockCall:
+  Enabled: false
+
+Layout/AlignParameters:
+  Enabled: false
+
+LineLength:
+  Max: 100
+
+Metrics:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - Appraisals
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/BlockDelimiters:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/HashSyntax:
+  Exclude:
+    - Rakefile
+Style/IfUnlessModifier:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/Next:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+Style/RaiseArgs:
+  EnforcedStyle: compact
+Style/SignalException:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "gemfiles/*.gemfile"
+    - "Appraisals"

data/.rubocop_todo.yml

@@ -0,0 +1,2 @@
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.6

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+rvm:
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - ruby-head
+gemfile:
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_edge.gemfile
+sudo: false
+after_script:
+  - bundle exec rake benchmark
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - gemfile: gemfiles/rails_edge.gemfile

data/Appraisals

@@ -0,0 +1,66 @@
+appraise 'rails-3.2' do
+  gem 'activerecord', '~> 3.2.0'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+end
+
+appraise 'rails-4.0' do
+  gem 'activerecord', '~> 4.0.0'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+end
+
+appraise 'rails-4.1' do
+  gem 'activerecord', '~> 4.1.0'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+end
+
+appraise 'rails-4.2' do
+  gem 'activerecord', '~> 4.2.0'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+end
+
+appraise 'rails-5.0' do
+  gem 'activerecord', '~> 5.0.0'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+end
+
+appraise 'rails-5.1' do
+  gem 'activerecord', '~> 5.1.0'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+end
+
+appraise 'rails-5.2' do
+  gem 'activerecord', '~> 5.2.0'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+end
+
+appraise 'rails-edge' do
+  gem 'activerecord', git: 'https://github.com/rails/rails'
+  gem 'arel', git: 'https://github.com/rails/arel'
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+end
+
+# vim: set ft=ruby:

data/CHANGELOG.md

@@ -0,0 +1,73 @@
+## 1.0.0 (2019-07-31)
+- Multi slaves support
+- Connect to master by default
+- Change switch point (thread safe)
+- Log connection name
+
+## 0.8.0 (2016-06-06)
+- Drop Ruby 2.0.0 and 2.1 support
+- Add `AR::Base#with_readonly` and `AR::Base#with_writable`
+    - short-hand for `AR::Base.with_readonly` and `AR::Base.with_writable`
+- Add `AR::Base#transaction_with`
+    - short-hand for `AR::Base.transaction_with`
+- Fix warnings for Rails 5.0
+
+## 0.7.0 (2015-10-16)
+- `Model.with_readonly` and `Model.with_writable` now raises error when the Model doesn't use switch_point
+
+## 0.6.0 (2015-04-14)
+- Add `SwitchConnection::QueryCache` middleware
+- `Model.cache` and `Model.uncached` is now hooked by switch_point
+    - `Model.cache` enables query cache for both readonly and writable.
+    - `Model.uncached` disables query cache for both readonly and writable.
+- Add `SwitchConnection.with_readonly_all` and `SwitchConnection.with_writable_all` as shorthand
+
+## 0.5.0 (2014-11-05)
+- Rename `SwitchConnection.with_connection` to `SwitchConnection.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.
+
+## 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
+
+## 0.4.1 (2014-06-19)
+- Support :writable only configuration
+
+## 0.4.0 (2014-06-17)
+- auto_writable is disabled by default
+    - To restore the previous behavior, set `config.auto_writable = true`.
+- Add shorthand methods `SwitchConnection.with_readonly`, `SwitchConnection.with_writable`
+
+## 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
+
+## 0.2.3 (2014-06-02)
+- Support specifying the same database name within different switch_point
+- Add Proxy#readonly? and Proxy#writable? predicate
+
+## 0.2.2 (2014-05-30)
+- Fix nil error on with_{readonly,writable} from non-switch_point model
+
+## 0.2.1 (2014-05-29)
+- Add Proxy#switch_name to switch proxy configuration
+- Fix weird nil error when Config#define_switch_point isn't called yet
+
+## 0.2.0 (2014-05-29)
+- Always send destructive operations to writable connection
+- Fix bug on pooled connections
+
+## 0.1.0 (2014-05-28)
+- Initial release

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in switch_point.gemspec
+gemspec
+gem 'sqlite3', '~> 1.3.6'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kohei Suzuki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# SwitchConnection
+[![Gem Version](https://badge.fury.io/rb/switch_point.svg)](http://badge.fury.io/rb/switch_point)
+[![Build Status](https://travis-ci.org/phamvanhung2e123/switch_point.svg?branch=master)](https://travis-ci.org/phamvannhung22123/switch_point)
+[![Coverage Status](https://img.shields.io/coveralls/phamvanhung2e123/switch_point.svg?branch=master)](https://coveralls.io/r/phamvannhung2e123/switch_point?branch=master)
+[![Code Climate](https://codeclimate.com/github/phamvanhung2e123/switch_point/badges/gpa.svg)](https://codeclimate.com/github/phamvannhung2e123/switch_point)
+
+Switching database connection between slave one and writable one. Fork from `switch_point` gem.
+Original Version: https://github.com/eagletmt/switch_point.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'switch_connection'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install switch_connection
+
+## Usage
+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_slave
+  host: db-blog-slave
+production_comment_master:
+    ...
+```
+
+In initializer:
+
+```ruby
+SwitchConnection.configure do |config|
+  config.define_switch_point :blog,
+    slaves: [:"#{Rails.env}_blog_slave1",:"#{Rails.env}_blog_slave2"]
+    master: :"#{Rails.env}_blog_master"
+  config.define_switch_point :comment,
+    slaves: [:"#{Rails.env}_comment_slave"]
+    master: :"#{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_slave { Article.first } # Read from db-blog-slave
+Category.with_slave { Category.first } # Also read from db-blog-slave
+Comment.with_slave { Comment.first } # Read from db-comment-slave
+
+Article.with_slave do
+  article = Article.first  # Read from db-blog-slave
+  article.title = 'new title'
+  Article.with_master do
+    article.save!  # Write to db-blog-master
+    article.reload  # Read from db-blog-master
+    Category.first  # Read from db-blog-master
+  end
+end
+```
+
+- with_switch_point
+```ruby
+Book.with_switch_point(:main) { Book.count  }
+```
+
+Note that Article and Category shares their connections.
+
+## Notes
+
+### auto_master
+`auto_master` by default.
+
+When `auto_master` is enabled, destructive queries is sent to writable connection even in slave mode.
+But it does NOT work well on transactions.
+
+Suppose `after_save` callback is set to User model. When `User.create` is called, it proceeds as follows.
+
+1. BEGIN TRANSACTION is sent to READONLY connection.
+2. switch_point switches the connection to WRITABLE.
+3. INSERT statement is sent to WRITABLE connection.
+4. switch_point reset the connection to READONLY.
+5. after_save callback 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: slave one and writable one.
+A proxy has a thread-local state indicating the current mode: slave or writable.
+
+Each ActiveRecord model refers to a proxy.
+`ActiveRecord::Base.connection` is hooked and delegated to the referred proxy.
+
+When the writable connection is requested to execute destructive query, the slave connection clears its query cache.
+
+![switch_point](https://gyazo.wanko.cc/switch_point.svg)
+
+### Special case: ActiveRecord::Base.connection
+Basically, each connection managed by a proxy isn't shared between proxies.
+But there's one exception: ActiveRecord::Base.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/phamvanmhung2e123/switch_point/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request