ebisu_connection 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 011e0158431fa0a4bd5ad63fab9412b192051025
-  data.tar.gz: 6ced00b03e9db99aef015c0f0bff065b3f1fcdfa
+  metadata.gz: 8d68fd9cf9403b92b48722cbcfc3f08b66077b7a
+  data.tar.gz: 3829842b34dd46b27489a069caa7ba75fd75c927
 SHA512:
-  metadata.gz: cee60eec2aa12d8943c851b559d779a5859d7f5b4669bba6f8c1bc8d571115b29188a90878ff4fd3e9a4ea8cbe248b2fee78b5761ad88d356702507571018a7e
-  data.tar.gz: dd620796df1bf68d7e2668ae4c9f42baf878131bb0fb4ecc45e9373a8c6de6fc32fe8f53e5aed2d5543f9c5e1488895c67fb178a96d837942b4f369f3e76ed25
+  metadata.gz: a76ce24504d64d243ac54c654afff4f9465a9b53cbb0d2a5266a36c62e77fcfaeea71332ce611781ab66b6c6494852f282d1eea1a1697fc5bdd13e0299736214
+  data.tar.gz: effc77faf0ce1d1f710a04e86cbbb6ba2ef9ed142a38c90c2fa0db2b1ac936b961bcbdcd16e2a70ffa44c99c659eade7e4d590406797f97dcc6543bc93b20cc4

data/.travis.yml

@@ -8,7 +8,7 @@ before_script:
   - bundle update
   - cp test/config/database_postgresql.yml.travis test/config/database_postgresql.yml
   - psql -c 'create database ebisu_connection_test_master;' -U postgres
-  - psql -c 'create database ebisu_connection_test_slave;' -U postgres
+  - psql -c 'create database ebisu_connection_test_replica;' -U postgres
 cache: bundler
 rvm:
   - 2.1.10

data/README.md

@@ -1,24 +1,24 @@
 # EbisuConnection
 [![Gem Version](https://badge.fury.io/rb/ebisu_connection.svg)](http://badge.fury.io/rb/ebisu_connection) [![Build Status](https://travis-ci.org/tsukasaoishi/ebisu_connection.svg?branch=master)](https://travis-ci.org/tsukasaoishi/ebisu_connection) [![Code Climate](https://codeclimate.com/github/tsukasaoishi/ebisu_connection/badges/gpa.svg)](https://codeclimate.com/github/tsukasaoishi/ebisu_connection)
 
-EbisuConnection allows access to slave servers.  
-You could assign a performance weight to each slave server.
+EbisuConnection allows access to replica servers.  
+You could assign a performance weight to each replica server.
 
 ```
 Rails ------------ Master DB
              |
              | 
-             +---- Slave1 DB (weight 10)
+             +---- Replica1 DB (weight 10)
              |
              |
-             +---- Slave2 DB (weight 20)
+             +---- Replica2 DB (weight 20)
 ```
 
-If you could put a load balancer in front of slave servers, should use [FreshConnection](https://github.com/tsukasaoishi/fresh_connection).
+If you could put a load balancer in front of replica servers, should use [FreshConnection](https://github.com/tsukasaoishi/fresh_connection).
 
 ## Usage
-### Access to Slave
-Read query goes to the slave server.
+### Access to Replica
+Read query goes to the replica server.
 
 ```ruby
 Article.where(:id => 1)
@@ -50,7 +50,8 @@ article.destory
 ```
 
 ## Support ActiveRecord version
-EbisuConnection supports ActiveRecord version 4.0 or later.  
+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.
 
 ## Support DB
@@ -92,27 +93,27 @@ production:
   host: localhost
   socket: /var/run/mysqld/mysqld.sock
 
-  slave:
-    username: slave
-    password: slave
-    host: slave
+  replica:
+    username: replica
+    password: replica
+    host: replica
 ```
 
-```slave``` is a config to connect to slave servers.  
+```replica``` is a config to connect to replica servers.  
 Others will use the master server settings.  
   
-Config of each slave server fill out to `config/slave.yml`
+Config of each replica server fill out to `config/replica.yml`
 
 ```yaml
 production:
-  - "slave1, 10"
-  - "slave2, 20"
+  - "replica1, 10"
+  - "replica2, 20"
   -
-    host: "slave3"
+    host: "replica3"
     weight: 30
 ```
 
-If ``config/slave.yml`` changed, it is reflected dynamic. Application doesn't need restart.
+If ``config/replica.yml`` changed, it is reflected dynamic. Application doesn't need restart.
 
 ```yaml
 "hostname, weight"
@@ -120,8 +121,8 @@ If ``config/slave.yml`` changed, it is reflected dynamic. Application doesn't ne
 
 String format is it. You can write config with hash.
 
-### use multiple slave servers group
-If you may want to user multiple slave group, write multiple slave group to config/database.yml. 
+### use multiple replica servers group
+If you may want to user multiple replica group, write multiple replica group to config/database.yml. 
 
 ```yaml
 production:
@@ -135,45 +136,45 @@ production:
   host: localhost
   socket: /var/run/mysqld/mysqld.sock
 
-  slave:
-    username: slave
-    password: slave
-    host: slave
+  replica:
+    username: replica
+    password: replica
+    host: replica
 
-  admin_slave:
-    username: slave
-    password: slave
-    host: admin_slaves
+  admin_replica:
+    username: replica
+    password: replica
+    host: admin_replica
 ```
 
-Config of each slave server fill out to `config/slave.yml`
+Config of each replica server fill out to `config/replica.yml`
 
 ```yaml
 production:
-  slave:
-    - "slave1, 10"
-    - "slave2, 20"
+  replica:
+    - "replica1, 10"
+    - "replica2, 20"
     -
-      host: "slave3"
+      host: "replica3"
       weight: 30
-  admin_slave:
-    - "slave3, 10"
-    - "slave4, 20"
+  admin_replica:
+    - "replica4, 10"
+    - "replica5, 20"
 ```
 
-And call establish_fresh_connection method in model that access to ```admin_slave``` slave group.
+And call establish_fresh_connection method in model that access to ```admin_replica``` replica group.
 
 ```ruby
 class AdminUser < ActiveRecord::Base
-  establish_fresh_connection :admin_slave
+  establish_fresh_connection :admin_replica
 end
 ```
 
-The children is access to same slave group of parent.
+The children is access to same replica group of parent.
 
 ```ruby
 class Parent < ActiveRecord::Base
-  establish_fresh_connection :admin_slave
+  establish_fresh_connection :admin_replica
 end
 
 class AdminUser < Parent
@@ -183,10 +184,10 @@ class Benefit < Parent
 end
 ```
 
-AdminUser and Benefit access to ```admin_slave``` slave group.
+AdminUser and Benefit access to ```admin_replica``` replica group.
 
 
-### Declare model that doesn't use slave db
+### Declare model that doesn't use replica db
 
 ```ruby
 class SomethingModel < ActiveRecord::Base
@@ -202,7 +203,7 @@ The model that master_db_only model's child is always access to master db.
 ```ruby
 before_fork do |server, worker|
   ...
-  ActiveRecord::Base.clear_all_slave_connections!
+  ActiveRecord::Base.clear_all_replica_connections!
   ...
 end
 

data/ebisu_connection.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["tsukasaoishi"]
   spec.email         = ["tsukasa.oishi@gmail.com"]
 
-  spec.summary       = %q{EbisuConnection supports to connect with slave DB servers.}
-  spec.description   = %q{EbisuConnection supports to connect with slave DB servers. It doesn't need Load Balancer.}
+  spec.summary       = %q{EbisuConnection supports connections with configured replica servers.}
+  spec.description   = %q{https://github.com/tsukasaoishi/ebisu_connection}
   spec.homepage      = "https://github.com/tsukasaoishi/ebisu_connection"
   spec.license       = "MIT"
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.1'
 
-  spec.add_dependency 'fresh_connection', '~> 2.2.0'
+  spec.add_dependency 'fresh_connection', '~> 2.3.0'
   spec.add_dependency 'concurrent-ruby', '~> 1.0.0'
 
   spec.add_development_dependency 'mysql2', '>= 0.3.13', '< 0.5'

data/gemfiles/rails42.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "activerecord", "~> 4.2.0"
 gem "mysql2", "~> 0.3.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails50.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "activerecord", "5.0.0"
 gem "mysql2", ">= 0.3.18", "< 0.5"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/ebisu_connection.rb

@@ -1,3 +1,4 @@
+require 'active_support/deprecation'
 require "fresh_connection"
 require "ebisu_connection/conf_file"
 
@@ -5,8 +6,16 @@ module EbisuConnection
   class << self
     attr_writer :env
 
+    def replica_file=(file)
+      ConfFile.replica_file = file
+    end
+
     def slaves_file=(file)
-      ConfFile.slaves_file = file
+      ActiveSupport::Deprecation.warn(
+        "'slaves_file=' is deprecated and will removed from version 2.4.0. use 'replica_file=' insted."
+      )
+
+      self.replica_file = file
     end
 
     def check_interval=(interval)
@@ -21,3 +30,4 @@ end
 
 require "ebisu_connection/connection_manager"
 FreshConnection.connection_manager = EbisuConnection::ConnectionManager
+ActiveRecord::Base.establish_fresh_connection

data/lib/ebisu_connection/conf_file.rb

@@ -1,9 +1,18 @@
 require 'yaml'
+require 'active_support/deprecation'
 
 module EbisuConnection
   class ConfFile
     class << self
-      attr_writer :slaves_file, :check_interval
+      attr_writer :replica_file, :check_interval
+
+      def slaves_file=(file)
+        ActiveSupport::Deprecation.warn(
+          "'slaves_file=' is deprecated and will removed from version 2.4.0. use 'replica_file=' insted."
+        )
+
+        self.replica_file = file
+      end
 
       def if_modify
         if time_to_check? && modify?
@@ -12,25 +21,63 @@ module EbisuConnection
       end
 
       def conf_clear!
-        @slaves_conf = nil
+        @replica_conf = nil
       end
 
-      def slaves_conf(slave_group)
-        @slaves_conf ||= get_slaves_conf
-        if @slaves_conf.is_a?(Hash)
-          @slaves_conf[slave_group] || @slaves_conf
+      def replica_conf(replica_group)
+        @replica_conf ||= get_replica_conf
+
+        if @replica_conf.is_a?(Hash)
+          c = @replica_conf[replica_group]
+
+          if !c && replica_group == "replica" && @replica_conf.key?("slave")
+            ActiveSupport::Deprecation.warn(
+              "'slave' in replica.yml is deprecated and will ignored from version 2.4.0. use 'replica' insted."
+            )
+
+            c = @replica_conf["slave"]
+          end
+
+          c || @replica_conf
         else
-          @slaves_conf
+          @replica_conf
         end
       end
 
+      def slaves_conf(replica_group)
+        ActiveSupport::Deprecation.warn(
+          "'slaves_conf' is deprecated and will removed from version 2.4.0. use 'replica_conf' insted."
+        )
+
+        replica_conf(replica_group)
+      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) }
+
+        unless 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.4.0. use 'config/replica.yml' insted."
+            )
+          end
+        end
+
+        raise "nothing replica_file. You have to put a config/replica.yml file" unless file
+
+        @replica_file = file
+      end
+
       def slaves_file
-        return @slaves_file if @slaves_file
-        raise "nothing slaves_file. You have to set a file path using EbisuConnection.slaves_file= method" unless defined?(Rails)
+        ActiveSupport::Deprecation.warn(
+          "'slaves_file' is deprecated and will removed from version 2.4.0. use 'replica_file' insted."
+        )
 
-        @slaves_file = %w(yml yaml).map{|ext| Rails.root.join("config/slave.#{ext}").to_s }.detect {|f| File.exist?(f) }
-        raise "nothing slaves_file. You have to put a config/slave.yml file" unless @slaves_file
-        @slaves_file
+        replica_file
       end
 
       def check_interval
@@ -50,12 +97,12 @@ module EbisuConnection
       end
 
       def modify?
-        @file_mtime != File.mtime(slaves_file)
+        @file_mtime != File.mtime(replica_file)
       end
 
-      def get_slaves_conf
-        @file_mtime = File.mtime(slaves_file)
-        conf = YAML.load_file(slaves_file)
+      def get_replica_conf
+        @file_mtime = File.mtime(replica_file)
+        conf = YAML.load_file(replica_file)
         conf[EbisuConnection.env.to_s] || {}
       end
     end

data/lib/ebisu_connection/connection_manager.rb

@@ -1,15 +1,24 @@
 require "concurrent"
-require "ebisu_connection/slave_group"
+require 'active_support/deprecation'
+require "ebisu_connection/replica_group"
 
 module EbisuConnection
   class ConnectionManager < FreshConnection::AbstractConnectionManager
-    def initialize(slave_group = "slave")
+    def initialize(replica_group = "replica")
       super
-      @slaves = Concurrent::Map.new
+      @replicas = Concurrent::Map.new
+    end
+
+    def replica_connection
+      replicas.sample.connection
     end
 
     def slave_connection
-      slaves.sample.connection
+      ActiveSupport::Deprecation.warn(
+        "'slave_connection' is deprecated and will removed from version 2.4.0. use 'replica_connection' insted."
+      )
+
+      replica_connection
     end
 
     def put_aside!
@@ -22,26 +31,26 @@ module EbisuConnection
     end
 
     def clear_all_connections!
-      @slaves.each_value do |s|
+      @replicas.each_value do |s|
         s.all_disconnect!
       end
 
-      @slaves.clear
+      @replicas.clear
       ConfFile.conf_clear!
     end
 
     def recovery?
-      slaves.recovery_connection?
+      replicas.recovery_connection?
     end
 
     private
 
     def check_own_connection
-      s = @slaves[current_thread_id]
+      s = @replicas[current_thread_id]
 
       if s && s.reserved_release?
         s.all_disconnect!
-        @slaves.delete(current_thread_id)
+        @replicas.delete(current_thread_id)
         true
       else
         false
@@ -49,24 +58,24 @@ module EbisuConnection
     end
 
     def reserve_release_all_connection
-      @slaves.each_value do |s|
+      @replicas.each_value do |s|
         s.reserve_release_connection!
       end
       ConfFile.conf_clear!
     end
 
-    def slaves
-      @slaves.fetch_or_store(current_thread_id) do |_|
-        get_slaves
+    def replicas
+      @replicas.fetch_or_store(current_thread_id) do |_|
+        get_replicas
       end
     end
 
-    def get_slaves
-      SlaveGroup.new(slaves_conf, slave_group)
+    def get_replicas
+      ReplicaGroup.new(replica_conf, replica_group)
     end
 
-    def slaves_conf
-      ConfFile.slaves_conf(slave_group)
+    def replica_conf
+      ConfFile.replica_conf(replica_group)
     end
 
     def current_thread_id

data/lib/ebisu_connection/{slave.rb → replica.rb}

@@ -1,8 +1,8 @@
 module EbisuConnection
-  class Slave
+  class Replica
     attr_reader :hostname, :weight
 
-    def initialize(conf, slave_group)
+    def initialize(conf, replica_group)
       case conf
       when String
         host, weight = conf.split(/\s*,\s*/)
@@ -12,11 +12,11 @@ module EbisuConnection
         weight = conf["weight"] || conf[:weight]
         port = conf["port"] || conf[:port]
       else
-        raise ArgumentError, "slaves config is invalid"
+        raise ArgumentError, "replica config is invalid"
       end
 
       spec = modify_spec(port)
-      @connection_factory = FreshConnection::ConnectionFactory.new(slave_group, spec)
+      @connection_factory = FreshConnection::ConnectionFactory.new(replica_group, spec)
       @weight = (weight || 1).to_i
     end
 

data/lib/ebisu_connection/{slave_group.rb → replica_group.rb}

@@ -1,33 +1,33 @@
-require "ebisu_connection/slave"
+require "ebisu_connection/replica"
 require "ebisu_connection/greatest_common_divisor"
 
 module EbisuConnection
-  class SlaveGroup
-    class AllSlavesHasGoneError < StandardError; end
+  class ReplicaGroup
+    class AllReplicaHasGoneError < StandardError; end
 
-    def initialize(slaves_conf, slave_group)
-      @slaves = slaves_conf.map do |conf|
-        Slave.new(conf, slave_group)
+    def initialize(replica_conf, replica_group)
+      @replicas = replica_conf.map do |conf|
+        Replica.new(conf, replica_group)
       end
 
       recalc_roulette
     end
 
     def sample
-      raise AllSlavesHasGoneError if @slaves.empty?
-      @slaves[@roulette.sample]
+      raise AllReplicaHasGoneError if @replicas.empty?
+      @replicas[@roulette.sample]
     end
 
     def recovery_connection?
-      dead_slaves = @slaves.select{|s| !s.active? }
-      return false if dead_slaves.empty?
+      dead_replicas = @replicas.select{|s| !s.active? }
+      return false if dead_replicas.empty?
 
-      dead_slaves.each do |s|
+      dead_replicas.each do |s|
         s.disconnect!
-        @slaves.delete(s)
+        @replicas.delete(s)
       end
 
-      raise AllSlavesHasGoneError if @slaves.empty?
+      raise AllReplicaHasGoneError if @replicas.empty?
 
       recalc_roulette
       true
@@ -35,7 +35,7 @@ module EbisuConnection
 
     def all_disconnect!
       @reserve_release = nil
-      @slaves.each {|s| s.disconnect!}
+      @replicas.each {|s| s.disconnect!}
     end
 
     def reserve_release_connection!
@@ -49,7 +49,7 @@ module EbisuConnection
     private
 
     def recalc_roulette
-      weight_list = @slaves.map {|s| s.weight }
+      weight_list = @replicas.map {|s| s.weight }
 
       @roulette = []
       gcd = GreatestCommonDivisor.calc(weight_list)

data/lib/ebisu_connection/version.rb

@@ -1,3 +1,3 @@
 module EbisuConnection
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebisu_connection
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - tsukasaoishi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fresh_connection
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -148,8 +148,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: EbisuConnection supports to connect with slave DB servers. It doesn't
-  need Load Balancer.
+description: https://github.com/tsukasaoishi/ebisu_connection
 email:
 - tsukasa.oishi@gmail.com
 executables: []
@@ -174,8 +173,8 @@ files:
 - lib/ebisu_connection/conf_file.rb
 - lib/ebisu_connection/connection_manager.rb
 - lib/ebisu_connection/greatest_common_divisor.rb
-- lib/ebisu_connection/slave.rb
-- lib/ebisu_connection/slave_group.rb
+- lib/ebisu_connection/replica.rb
+- lib/ebisu_connection/replica_group.rb
 - lib/ebisu_connection/version.rb
 homepage: https://github.com/tsukasaoishi/ebisu_connection
 licenses:
@@ -200,5 +199,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: EbisuConnection supports to connect with slave DB servers.
+summary: EbisuConnection supports connections with configured replica servers.
 test_files: []