ebisu_connection 2.4.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6baf52851e9f37b4ceb898cba5d4bb1fca881d11027a979657e18125441a3a5d
-  data.tar.gz: 1c9da59f932336842dd3816269a108b6a2414de9405aa8dd9f9f6ca4e79f1a93
+  metadata.gz: 1492ff4f579ef693566907ad31141dea9207cedc046502ccc6a3ee6b17ba4a56
+  data.tar.gz: 3d96c7e13ca8452787270f25c91a1c97d75f7defe4ca0d5a4d1fa7d477bf48ea
 SHA512:
-  metadata.gz: 27e307f0414f50c082c0fabc82f8e634f58a2343a19e8a1ea099ccbe0b8f1c1c3aa83c769b6f46c272721ae7604b27db4c37f3b0f291000f509df6436d7ee7f7
-  data.tar.gz: 9fe5baa3c0b004c5413355232f2925f19216e91b3dfaa05aa065e3e29aff6796a04491939e22f8469194698faa8470b2516419de57ce667a6c2196eb836810eb
+  metadata.gz: cb7daa78160f1707d39419c78d23833cdd5d11fd356223ee2f58cb3916d086b9b622173f12f2a35064a275d5bcccde47f68ddc5a53b6286b94fe683a357f4a56
+  data.tar.gz: d620a6cb1fdca4b80f3e6e52cfed313284634e93ee13eaa2ecced333cf595719f6f668f4fd448a4d9b4b8f6b392ca98750df9b0ab82f874ab3cc0ba6f79bddc3

data/.travis.yml

@@ -16,9 +16,9 @@ rvm:
   - 2.4.3
   - 2.5.0
 gemfile:
-  - gemfiles/rails42.gemfile
   - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile
+  - gemfiles/rails52.gemfile
 matrix:
   fast_finish: true
 bundler_args: --jobs 3 --retry 3

data/Appraisals

@@ -1,20 +1,20 @@
-appraise "rails42" do
-  gem "activerecord", "~> 4.2.0"
-  gem 'activesupport', '~> 4.2.0'
-  gem 'mysql2', '>= 0.3.13', '< 0.5'
-  gem 'pg', '~> 0.15'
-end
-
 appraise "rails50" do
   gem "activerecord", "~> 5.0.0"
   gem 'activesupport', '~> 5.0.0'
-  gem 'mysql2', '>= 0.3.18', '< 0.5'
-  gem 'pg', '~> 0.18'
+  gem 'mysql2', '>= 0.3.18', '< 0.6.0'
+  gem 'pg', '>= 0.18', '< 2.0'
 end
 
 appraise "rails51" do
   gem 'activerecord', '~> 5.1.0'
   gem 'activesupport', '~> 5.1.0'
-  gem 'mysql2', '>= 0.3.18', '< 0.5'
-  gem 'pg', '~> 0.18'
+  gem 'mysql2', '>= 0.3.18', '< 0.6.0'
+  gem 'pg', '>= 0.18', '< 2.0'
+end
+
+appraise "rails52" do
+  gem 'activerecord', '~> 5.2.0'
+  gem 'activesupport', '~> 5.2.0'
+  gem 'mysql2', '>= 0.4.4', '< 0.6.0'
+  gem 'pg', '>= 0.18', '< 2.0'
 end

data/README.md

@@ -50,9 +50,8 @@ article.destory
 ```
 
 ## Support ActiveRecord version
-EbisuConnection supports ActiveRecord version 4.2 or later.
-If you are using Rails 4.1 or 4.0, you can use EbisuConnection version 2.1.0 or before.
-If you are using Rails 3.2, could use EbisuConnection version 1.0.0 or before.
+EbisuConnection supports ActiveRecord version 5.0 or later.
+If you are using Rails 4.2, you can use EbisuConnection version 2.4.2 or before.
 
 ## Support DB
 EbisuConnection supports MySQL and PostgreSQL.
@@ -82,26 +81,27 @@ $ gem install ebisu_connection
 config/database.yml
 
 ```yaml
-production:
+default: &default
   adapter: mysql2
   encoding: utf8
-  reconnect: true
-  database: kaeru
-  pool: 5
-  username: master
-  password: master
-  host: localhost
-  socket: /var/run/mysqld/mysqld.sock
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  username: root
+  password:
+
+production:
+  <<: *default
+  database: blog_production
+  username: master_db_user
+  password: <%= ENV['MASTER_DATABASE_PASSWORD'] %>
+  host: master_db
 
   replica:
-    username: replica
-    password: replica
-    host: replica
+    username: replica_db_user
+    password: <%= ENV['REPLICA_DATABASE_PASSWORD'] %>
 ```
 
-```replica``` is a config to connect to replica servers.  
-Others will use the master server settings.  
-  
+`replica` is the configuration used for connecting read-only queries to the database replica.  All other connections will use the database master settings.
+
 Config of each replica server fill out to `config/replica.yml`
 
 ```yaml
@@ -123,26 +123,27 @@ String format is it. You can write config with hash.
 If you may want to user multiple replica group, write multiple replica group to config/database.yml. 
 
 ```yaml
-production:
+default: &default
   adapter: mysql2
   encoding: utf8
-  reconnect: true
-  database: kaeru
-  pool: 5
-  username: master
-  password: master
-  host: localhost
-  socket: /var/run/mysqld/mysqld.sock
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  username: root
+  password:
+
+production:
+  <<: *default
+  database: blog_production
+  username: master_db_user
+  password: <%= ENV['MASTER_DATABASE_PASSWORD'] %>
+  host: master_db
 
   replica:
-    username: replica
-    password: replica
-    host: replica
+    username: replica_db_user
+    password: <%= ENV['REPLICA_DATABASE_PASSWORD'] %>
 
   admin_replica:
-    username: replica
-    password: replica
-    host: admin_replica
+    username: admin_replica_db_user
+    password: <%= ENV['ADMIN_REPLICA_DATABASE_PASSWORD'] %>
 ```
 
 Config of each replica server fill out to `config/replica.yml`
@@ -160,7 +161,7 @@ production:
     - "replica5, 20"
 ```
 
-And call establish_fresh_connection method in model that access to ```admin_replica``` replica group.
+The custom replica stanza can then be applied as an argument to the `establish_fresh_connection` method in the models that should use it.  For example:
 
 ```ruby
 class AdminUser < ActiveRecord::Base
@@ -168,7 +169,7 @@ class AdminUser < ActiveRecord::Base
 end
 ```
 
-The children is access to same replica group of parent.
+The child (sub) classes of the configured model will inherit the same access as the parent class.  Example:
 
 ```ruby
 class Parent < ActiveRecord::Base
@@ -182,10 +183,12 @@ class Benefit < Parent
 end
 ```
 
-AdminUser and Benefit access to ```admin_replica``` replica group.
+The `AdminUser` and `Benefit` models will access the database configured for the `admin_replica` group.
+
 
+### Master-only Models
 
-### Declare model that doesn't use replica db
+It is possible to declare that specific models always use the DB master for all connections, using the `master_db_only!` method:
 
 ```ruby
 class SomethingModel < ActiveRecord::Base
@@ -193,10 +196,9 @@ class SomethingModel < ActiveRecord::Base
 end
 ```
 
-If model that always access to master servers is exist, You may want to write ```master_db_only!```  in model.
-The model that master_db_only model's child is always access to master db.
+All queries generated by methods on the `CustomerState` model will be directed to the DB master.
 
-### for Unicorn
+### Using EbisuConnection With Unicorn
 
 ```ruby
 before_fork do |server, worker|
@@ -204,12 +206,6 @@ before_fork do |server, worker|
   ActiveRecord::Base.clear_all_replica_connections!
   ...
 end
-
-after_fork do |server, worker|
-  ...
-  ActiveRecord::Base.establish_fresh_connection
-  ...
-end
 ```
 
 ## Contributing

data/ebisu_connection.gemspec

@@ -21,14 +21,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2'
 
-  spec.add_dependency 'fresh_connection', '~> 2.4.0'
-  spec.add_dependency 'concurrent-ruby', '~> 1.0.0'
+  spec.add_dependency 'fresh_connection', '~> 3.0.0'
 
-  spec.add_development_dependency 'mysql2', '>= 0.3.13', '< 0.5'
-  spec.add_development_dependency 'pg', '~> 0.11'
+  spec.add_development_dependency 'mysql2', '>= 0.3.18', '< 0.6.0'
+  spec.add_development_dependency 'pg', '>= 0.18', '< 2.0'
   spec.add_development_dependency "bundler", ">= 1.3.0", "< 2.0"
   spec.add_development_dependency "rake", ">= 0.8.7"
   spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", "~> 5.10.0"
   spec.add_development_dependency "minitest-reporters"
 end

data/gemfiles/rails50.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "activerecord", "~> 5.0.0"
 gem "activesupport", "~> 5.0.0"
-gem "mysql2", ">= 0.3.18", "< 0.5"
-gem "pg", "~> 0.18"
+gem "mysql2", ">= 0.3.18", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"
 
 gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "activerecord", "~> 5.1.0"
 gem "activesupport", "~> 5.1.0"
-gem "mysql2", ">= 0.3.18", "< 0.5"
-gem "pg", "~> 0.18"
+gem "mysql2", ">= 0.3.18", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"
 
 gemspec path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
+gem "mysql2", ">= 0.4.4", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"
+
+gemspec path: "../"

data/lib/ebisu_connection.rb

@@ -1,17 +1,13 @@
 require 'active_support'
 require "fresh_connection"
-require "ebisu_connection/conf_file"
+require "ebisu_connection/config"
 
 module EbisuConnection
   class << self
     attr_writer :env
 
     def replica_file=(file)
-      ConfFile.replica_file = file
-    end
-
-    def slaves_file=(file)
-      ConfFile.slaves_file = file
+      Config.replica_file = file
     end
 
     def env

data/lib/ebisu_connection/config.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+
+module EbisuConnection
+  class Config
+    include Enumerable
+
+    class << self
+      attr_writer :replica_file
+
+      def config
+        return @config if defined?(@config)
+
+        conf = YAML.load_file(replica_file)
+        @config = conf[EbisuConnection.env.to_s] || {}
+      end
+
+      private
+
+      def replica_file
+        return @replica_file if @replica_file
+
+        raise "nothing replica_file. You have to set a file path using EbisuConnection.replica_file= method" unless defined?(Rails)
+
+        file = %w(yml yaml).map{|ext| Rails.root.join("config/replica.#{ext}").to_s }.detect {|f| File.exist?(f) }
+        return file if file
+
+        raise "nothing replica_file. You have to put a config/replica.yml file"
+      end
+    end
+
+    def initialize(spec_name)
+      @conf = load_config(spec_name)
+    end
+
+    def each(&block)
+      @conf.each(&block)
+    end
+
+    private
+
+    def load_config(spec_name)
+      c = self.class.config
+
+      if c.is_a?(Hash)
+        c[spec_name] || c
+      else
+        c
+      end
+    end
+  end
+end

data/lib/ebisu_connection/connection_manager.rb

@@ -1,6 +1,5 @@
-require "concurrent"
 require "ebisu_connection/replica"
-require "ebisu_connection/greatest_common_divisor"
+require "ebisu_connection/load_balancer"
 
 module EbisuConnection
   class ConnectionManager < FreshConnection::AbstractConnectionManager
@@ -9,65 +8,51 @@ module EbisuConnection
     def initialize(spec_name = nil)
       super
 
-      @replicas = Concurrent::Array.new
-
-      replica_conf.each do |conf|
-        @replicas << Replica.new(conf, spec_name)
+      @replicas = replica_conf.map do |conf|
+        Replica.new(conf, spec_name)
       end
-
-      recalc_roulette
     end
 
     def replica_connection
       raise AllReplicaHasGoneError if @replicas.empty?
-      @replicas[@roulette.sample].connection
+      load_balancer.replica.connection
     end
 
     def put_aside!
-      @replicas.each do |pool|
-        pool.release_connection if pool.active_connection? && !pool.connection.transaction_open?
-      end
+      @replicas.each(&:put_aside!)
     end
 
     def clear_all_connections!
-      @replicas.each do |pool|
-        pool.disconnect!
-      end
+      @replicas.each(&:disconnect!)
     end
 
     def recovery?
-      dead_replicas = @replicas.select do |pool|
-        c = pool.connection rescue nil
+      dead_replicas = @replicas.select do |replica|
+        c = replica.connection rescue nil
         !c || !c.active?
       end
+
       return false if dead_replicas.empty?
 
-      dead_replicas.each do |pool|
-        pool.disconnect!
-        @replicas.delete(pool)
+      dead_replicas.each do |replica|
+        replica.disconnect!
+        @replicas.delete(replica)
       end
 
       raise AllReplicaHasGoneError if @replicas.empty?
 
-      recalc_roulette
+      @load_balancer = nil
       true
     end
 
     private
 
-    def recalc_roulette
-      weight_list = @replicas.map {|pool| pool.weight }
-
-      @roulette = []
-      gcd = GreatestCommonDivisor.calc(weight_list)
-      weight_list.each_with_index do |w, index|
-        weight = w / gcd
-        @roulette.concat([index] * weight)
-      end
+    def load_balancer
+      @load_balancer ||= LoadBalancer.new(@replicas)
     end
 
     def replica_conf
-      ConfFile.replica_conf(spec_name)
+      @replica_conf ||= Config.new(spec_name)
     end
   end
 end

data/lib/ebisu_connection/load_balancer.rb

@@ -0,0 +1,32 @@
+require "ebisu_connection/greatest_common_divisor"
+
+module EbisuConnection
+  class LoadBalancer
+    def initialize(replicas)
+      @replicas = replicas
+    end
+
+    def replica
+      @replicas[roulette.sample]
+    end
+
+    private
+
+    def roulette
+      @roulette ||= calc_roulette
+    end
+
+    def calc_roulette
+      set = []
+      weight_list = @replicas.map(&:weight)
+      gcd = GreatestCommonDivisor.calc(weight_list)
+
+      weight_list.each_with_index do |w, index|
+        weight = w / gcd
+        set.concat([index] * weight)
+      end
+
+      set
+    end
+  end
+end

data/lib/ebisu_connection/replica.rb

@@ -28,6 +28,13 @@ module EbisuConnection
     def connection
       @pool.connection
     end
+    
+    def put_aside!
+      return unless active_connection?
+      return if connection.transaction_open?
+
+      release_connection
+    end
 
     def active_connection?
       @pool.active_connection?

data/lib/ebisu_connection/version.rb

@@ -1,3 +1,3 @@
 module EbisuConnection
-  VERSION = "2.4.2"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebisu_connection
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 3.0.0
 platform: ruby
 authors:
 - tsukasaoishi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fresh_connection
@@ -16,62 +16,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.13
+        version: 0.3.18
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.13
+        version: 0.3.18
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,16 +116,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.10.0
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -167,13 +159,14 @@ files:
 - bin/setup
 - bin/test
 - ebisu_connection.gemspec
-- gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
 - lib/ebisu_connection.rb
-- lib/ebisu_connection/conf_file.rb
+- lib/ebisu_connection/config.rb
 - lib/ebisu_connection/connection_manager.rb
 - lib/ebisu_connection/greatest_common_divisor.rb
+- lib/ebisu_connection/load_balancer.rb
 - lib/ebisu_connection/replica.rb
 - lib/ebisu_connection/version.rb
 homepage: https://github.com/tsukasaoishi/ebisu_connection
@@ -196,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: EbisuConnection supports connections with configured replica servers.

data/gemfiles/rails42.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 4.2.0"
-gem "activesupport", "~> 4.2.0"
-gem "mysql2", ">= 0.3.13", "< 0.5"
-gem "pg", "~> 0.15"
-
-gemspec path: "../"

data/lib/ebisu_connection/conf_file.rb

@@ -1,64 +0,0 @@
-require 'yaml'
-require 'active_support/deprecation'
-
-module EbisuConnection
-  class ConfFile
-    class << self
-      attr_writer :replica_file
-
-      def slaves_file=(file)
-        ActiveSupport::Deprecation.warn(
-          "'slaves_file=' is deprecated and will removed from version 2.5.0. use 'replica_file=' instead."
-        )
-
-        self.replica_file = file
-      end
-
-      def replica_conf(spec_name)
-        return config unless config.is_a?(Hash)
-
-        c = config[spec_name]
-        return c if c
-
-        if spec_name == "replica" && config.key?("slave")
-          ActiveSupport::Deprecation.warn(
-            "'slave' in replica.yml is deprecated and will ignored from version 2.5.0. use 'replica' insted."
-          )
-
-          c = config["slave"]
-        end
-
-        c || config
-      end
-
-      private
-
-      def config
-        return @config if defined?(@config)
-
-        conf = YAML.load_file(replica_file)
-        @config = conf[EbisuConnection.env.to_s] || {}
-      end
-
-      def replica_file
-        return @replica_file if @replica_file
-
-        raise "nothing replica_file. You have to set a file path using EbisuConnection.replica_file= method" unless defined?(Rails)
-
-        file = %w(yml yaml).map{|ext| Rails.root.join("config/replica.#{ext}").to_s }.detect {|f| File.exist?(f) }
-        return file if file
-
-        file = %w(yml yaml).map{|ext| Rails.root.join("config/slave.#{ext}").to_s }.detect {|f| File.exist?(f) }
-        if file
-          ActiveSupport::Deprecation.warn(
-            "file name 'config/#{file}' is deprecated and will ignored from version 2.5.0. use 'config/replica.yml' insted."
-          )
-
-          return file
-        end
-
-        raise "nothing replica_file. You have to put a config/replica.yml file"
-      end
-    end
-  end
-end