fresh_connection 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5209747ee5ebffd0721b5c2dbcf20940721867c4
-  data.tar.gz: 022c9dce7d03c2ca0bc0732022ea70099df547df
+  metadata.gz: deb0b581ea9aecc3c27b3d32a6a14c93ee3a543f
+  data.tar.gz: 0323e5cd09c34895529a49d339c00797c45cfa07
 SHA512:
-  metadata.gz: 700f794d9cb774036025d53b6cf471ffd83c8a9de8b1188c1d0bf153e292c98c69804473a1e20bf535e18fc4be771d264585db463affeeda1b7b2303942aa868
-  data.tar.gz: d4f6fbea8f6debe411aa22f603a3e463bc03986dbefd05ded39374fe645641811e862814f09c34de2d38881ceb6e946ab8b4b8cdaed638bbf226337c0bbb0505
+  metadata.gz: 5163c26ac8a920f5b5f3485d4049b147ae826075ba8cfb6c2b1f6adf2b3e9966c046304932851c2b0b64228892c08569c2b5d81d7ef0bd21ae5db025e2f28bbc
+  data.tar.gz: 71e16efe75624fd56cf02374bb8db2fa5e94c3038c3b044dbb8df1ba689ed797f1e5254bb65fd31a9d4276125c876f13edb3db4d5dc8142ce002ae5ec18f125d

data/README.md

@@ -4,16 +4,16 @@
 **FreshConnection** provides access to one or more configured database replicas.
 
 For example:
-```
+
+```text
 Rails ------------ DB Master
              |
              +---- DB Replica
-
 ```
 
-or:
+or
 
-```
+```text
 Rails -------+---- DB Master
              |
              |                     +------ DB Replica1
@@ -23,16 +23,13 @@ Rails -------+---- DB Master
                                    +------ DB Replica2
 ```
 
-FreshConnction connects one or more configured DB replicas, or with multiple
-replicas behind a DB query load balancer.
+FreshConnction connects one or more configured DB replicas, or with multiple replicas behind a DB query load balancer.
 
 - Read queries go to the DB replica.
 - Write queries go to the DB master.
 - Within a transaction, all queries go to the DB master.
 
-If you wish to use multiple DB replicas on any given connection but not have
-a load balancer (such as [`pgbouncer`](https://pgbouncer.github.io) for Posgres
-databases), you can use [EbisuConnection](https://github.com/tsukasaoishi/ebisu_connection).
+If you wish to use multiple DB replicas on any given connection but do not have a load balancer (such as [`pgbouncer`](https://pgbouncer.github.io) for Posgres databases), you can use [EbisuConnection](https://github.com/tsukasaoishi/ebisu_connection).
 
 ## Usage
 ### Access to the DB Replica
@@ -46,7 +43,8 @@ Account.count
 
 ### Access to the DB Master
 If you wish to ensure that queries are directed to the DB master, call `read_master`.
-Before version 0.4.3, `readonly(false)` must be used.
+
+> Note: Before version 0.4.3, `readonly(false)` must be used.
 
 ```ruby
 Article.where(id: 1).read_master
@@ -73,9 +71,10 @@ old_article.destroy
 ```
 
 ## ActiveRecord Versions Supported
-FreshConnection supports ActiveRecord version 4.2 or later.
-If you are using Rails 4.1 or 4.0, you can use FreshConnection version 2.1.2 or before.
-If you are using Rails 3.2, you can use FreshConnection version 1.0.0 or before.
+
+- FreshConnection supports ActiveRecord version 4.2 or later.
+- If you are using Rails 4.1 or 4.0, you can use FreshConnection version 2.1.2 or before.
+- If you are using Rails 3.2, you can use FreshConnection version 1.0.0 or before.
 
 ## Databases Supported
 FreshConnection currently supports MySQL and PostgreSQL.
@@ -100,9 +99,8 @@ $ gem install fresh_connection
 ```
 
 ### Variant Installation For Use With Some Other ActiveRecord Gems
-If you are using NewRelic or other gems that insert themselves into the
-ActiveRecord call-chain using `method_alias`, then a slight variation on the
-installation and configuration is required.
+
+If you are using NewRelic or other gems that insert themselves into the ActiveRecord call-chain using `method_alias`, then a slight variation on the installation and configuration is required.
 
 In the `Gemfile`, use:
 
@@ -154,12 +152,10 @@ production:
     host:     <%= ENV['DB_REPLICA_HOST'] %>
 ```
 
-`replica` is the configuration used for connecting read-only queries to the
-database replica.  All other connections will use the database master settings.
+`replica` is the configuration used for connecting read-only queries to the database replica.  All other connections will use the database master settings.
 
 ### Multiple DB Replicas
-If you want to use multiple configured DB replicas, the configuration can
-contain multiple `replica` stanzas in the configuration file `config/database.yml`.
+If you want to use multiple configured DB replicas, the configuration can contain multiple `replica` stanzas in the configuration file `config/database.yml`.
 
 For example:
 
@@ -186,9 +182,7 @@ production:
     host:     <%= ENV['DB_ADMIN_REPLICA_HOST'] %>
 ```
 
-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:
+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
@@ -196,8 +190,7 @@ class AdminUser < ActiveRecord::Base
 end
 ```
 
-The child (sub) classes of the configured model will inherit the same access
-as the parent class.  Example:
+The child (sub) classes of the configured model will inherit the same access as the parent class.  Example:
 
 ```ruby
 class AdminBase < ActiveRecord::Base
@@ -214,18 +207,54 @@ class Customer < ActiveRecord::Base
 end
 ```
 
-The `AdminUser` and `Benefit` models will access the database configured for
-the `admin_replica` group.
+The `AdminUser` and `Benefit` models will access the database configured for the `admin_replica` group.
+
+The `Customer` model will use the default connections: read-only queries will connect to the standard DB replica, and state-changing queries will connect to the DB master.
+
+### Replica Configuration With Environment Variables
+
+
+Alternative to using a configuration in the `database.yml` file, it is possible to completely specify the replica access components using environment variables.
+
+The environment variables corresponding to the `:replica` group are `DATABASE_REPLICA_URL` and `DATABASE_REPLICA1_URL`, with the latter being used only if the former is not defined.
+
+The URL value is a [URL](https://en.wikipedia.org/wiki/URL) string with the following components:
+
+   _adapter://dbuser:dbpass@dbhost:dbport/dbname?querypath_
+
+where the components are:
+
+| Component | Purpose | Examples  |
+| --------- | ------- | --------- |
+| _adapter_ | Declares the database adapter | `mysql`, `postgresql` |
+| _dbuser_  | The login for the database | `root`, `postgres` |
+| _dbpass_  | The password for the database | |
+| _dbhost_ | The hostname for the database | `db1`, `localhost` |
+| _dbport_ | The port for the database connection | `3306`, `5432` |
+| _dbname_ | The name of the database | `mydb`, `appdb`, etc. |
+| _querypath_ | One or more variable assignments: _var1=val1_, separated by '&' | `pools=5&reconnect=true` |
+
+
+For example, here is a URL appropriate for a connection to a test database on the local host, on a custom port:
+
+    export DATABASE_REPLICA_URL='postgresql://root:somepw@localhost:6432/test_db?pool=5&reconnect=true
+
+### Multiple Replica Environment Variables
+
+To specific URLs for multiple replicas, replace the string `REPLICA` in the environment variable name with the replica name, in upper case. See the examples for replicas: `:replica1`, `:replica2`, and `:admin_replica`
+
+
+    ENVIRONMENT_REPLICA1_URL='mysql://localhost/dbreplica1?pool=5&reconnect=true'
+    ENVIRONMENT_REPLICA2_URL='postgresql://localhost:6432/ro_db?pool=5&reconnect=true'
+    ENVIRONMENT_ADMIN_REPLICA_URL='postgresql://localhost:6432/admin_db?pool=5&reconnect=true'
 
-The `Customer` model will use the default connections: read-only queries will
-connect to the standard DB replica, and state-changing queries will connect to
-the DB master.
+### Special-Case Replica URL
 
+When `:replica` is used but `DATABASE_REPLICA_URL` is *not* defined, then the value of `DATABASE_REPLICA1_URL` will be used if it is defined.
 
 ### Master-only Models
 
-It is possible to declare that specific models always use the DB master for all connections, using
-the `master_db_only!` method:
+It is possible to declare that specific models always use the DB master for all connections, using the `master_db_only!` method:
 
 ```ruby
 class CustomerState < ActiveRecord::Base
@@ -237,9 +266,7 @@ All queries generated by methods on the `CustomerState` model will be directed t
 
 ### Using FreshConnection With Unicorn
 
-When using FreshConnection with Unicorn (or any other multi-processing web
-server which restarts processes on the fly), connection management needs
-special attention during startup:
+When using FreshConnection with Unicorn (or any other multi-processing web server which restarts processes on the fly), connection management needs special attention during startup:
 
 ```ruby
 before_fork do |server, worker|
@@ -256,9 +283,7 @@ end
 ```
 
 ### Replica Connection Manager
-The default replica connection manager is `FreshConnection::ConnectionManager`.
-If an alternative (custom) replica connection manager is desired, this can be done
-with a simple assignment within a Rails initializer:
+The default replica connection manager is `FreshConnection::ConnectionManager`. If an alternative (custom) replica connection manager is desired, this can be done with a simple assignment within a Rails initializer:
 
 `config/initializers/fresh_connection.rb`:
 
@@ -266,8 +291,7 @@ with a simple assignment within a Rails initializer:
 FreshConnection.connection_manager = MyOwnReplicaConnection
 ```
 
-The `MyOwnReplicaConnection` class should inherit from
-`FreshConnection::AbstractConnectionManager`, which has this interface:
+The `MyOwnReplicaConnection` class should inherit from `FreshConnection::AbstractConnectionManager`, which has this interface:
 
 ```ruby
 class MyOwnReplicaConnection < FreshConnection::AbstractConnectionManager
@@ -305,12 +329,12 @@ end
 
 ## Test
 
-I'm glad that you would test!
-To run the test suite, `mysql` must be installed.
+I'm glad that you would like to test!
+To run the test suite, both `mysql` and `postgresql` must be installed.
 
 ### Test Configuration
 
-First, configure the test `mysql` server in `spec/database.yml`.
+First, configure the test servers in `test/config/*.yml`
 
 Then, run:
 

data/Rakefile

@@ -1,18 +1,20 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
-desc 'Run mysql2 and postgresql test'
+desc 'Run mysql2 and postgresql tests'
 task :test do
   Rake::Task["test:mysql2"].invoke
+  Rake::Task["test:mysql2_url"].invoke
   Rake::Task["test:postgresql"].invoke
+  Rake::Task["test:postgresql_url"].invoke
 end
 
 namespace :test do
-  %w(mysql2 postgresql).each do |db|
-    Rake::TestTask.new(db) do |t|
+  %w(mysql2 postgresql mysql2_url postgresql_url).each do |test_name|
+    Rake::TestTask.new(test_name) do |t|
       t.libs << "test"
       t.libs << "lib"
-      t.test_files = FileList["test/config/prepare_#{db}", 'test/**/*_test.rb']
+      t.test_files = FileList["test/config/prepare_#{test_name}", 'test/**/*_test.rb']
       t.verbose = true
     end
   end

data/lib/fresh_connection/abstract_connection_manager.rb

@@ -7,7 +7,7 @@ module FreshConnection
         return unless name == :slave_connection
 
         ActiveSupport::Deprecation.warn(
-          "'slave_connection' has been deprecated. use 'replica_connection' insted."
+          "'slave_connection' has been deprecated. use 'replica_connection' instead."
         )
       end
     end
@@ -22,7 +22,7 @@ module FreshConnection
 
     def slave_group
       ActiveSupport::Deprecation.warn(
-        "'slave_group' is deprecated and will removed from version 2.4.0. use 'replica_group' insted."
+        "'slave_group' is deprecated and will removed from version 2.4.0. use 'replica_group' instead."
       )
 
       replica_group

data/lib/fresh_connection/connection_factory.rb

@@ -1,11 +1,14 @@
 require 'active_support/deprecation'
 require 'active_support/core_ext/hash/keys'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash/indifferent_access'
 
 module FreshConnection
   class ConnectionFactory
-    def initialize(group, modify_spec = {})
+    def initialize(group, modify_spec = nil)
       @group = group.to_sym
-      @modify_spec = modify_spec.symbolize_keys
+      @modify_spec = modify_spec || {}.with_indifferent_access
+      @spec = nil
     end
 
     def new_connection
@@ -22,20 +25,44 @@ module FreshConnection
       @spec ||= build_spec
     end
 
+    # when building a spec from envars, there may be no database.yml file, so
+    # be careful to avoid implicit dependency on it or derived contents.
+
     def build_spec
-      config = ar_spec.config.symbolize_keys
-      group_config = config[@group]
+      url = database_group_url(@group.to_s)
+      if url
+        build_group_spec_from_url(url)
+      else
+        build_spec_from_config
+      end
+    end
+
+    def database_group_url(group)
+      ENV['DATABASE_' + group.upcase + '_URL']
+    end
+
+    def build_group_spec_from_url(url)
+      config = ar_spec.config.with_indifferent_access
+      spec = build_spec_from_url(url)
+      group_config = (config[@group] ||= {}.with_indifferent_access)
+      config.merge(group_config).merge(spec).merge(@modify_spec)
+    end
+
+    def build_spec_from_url(url)
+      ActiveRecord::ConnectionAdapters::ConnectionSpecification::ConnectionUrlResolver.new(url).to_hash
+    end
 
-      # provide backward compatibility for older :slave usage
-      if !group_config && @group == :replica && config.key?(:slave)
+    def build_spec_from_config
+      config = ar_spec.config.with_indifferent_access
+      group_config = config[@group] || {}.with_indifferent_access
+
+      if group_config.size == 0 && @group == :replica && config.key?(:slave)
+        # provide backward-compatibility with :slave profile
         ActiveSupport::Deprecation.warn(
-          "'slave' in database.yml is deprecated and will ignored from version 2.4.0. use 'replica' insted."
+          "'slave' in database.yml is deprecated and will ignored from version 2.4.0. use 'replica' instead."
         )
-        group_config = config[:slave]
+        group_config = (config[:slave] || {}).with_indifferent_access
       end
-
-      group_config = (group_config || {}).symbolize_keys
-
       config.merge(group_config).merge(@modify_spec)
     end
 

data/lib/fresh_connection/extend/ar_base.rb

@@ -25,7 +25,7 @@ module FreshConnection
         all.manage_access(false, &block)
       end
 
-      def establish_fresh_connection(replica_group = nil)
+      def establish_fresh_connection(replica_group = "replica")
         replica_connection_handler.establish_connection(name, replica_group)
       end
 
@@ -35,7 +35,7 @@ module FreshConnection
 
       def slave_connection
         ActiveSupport::Deprecation.warn(
-          "'slave_connection' is deprecated and will removed from version 2.4.0. use 'replica_connection' insted."
+          "'slave_connection' is deprecated and will removed from version 2.4.0. use 'replica_connection' instead."
         )
 
         replica_connection
@@ -47,7 +47,7 @@ module FreshConnection
 
       def clear_all_slave_connections!
         ActiveSupport::Deprecation.warn(
-          "'clear_all_slave_connections!' is deprecated and will removed from version 2.4.0. use 'clear_all_replica_connections!' insted."
+          "'clear_all_slave_connections!' is deprecated and will removed from version 2.4.0. use 'clear_all_replica_connections!' instead."
         )
 
         clear_all_replica_connections!
@@ -68,7 +68,7 @@ module FreshConnection
 
       def slave_connection_put_aside!
         ActiveSupport::Deprecation.warn(
-          "'slave_connection_put_aside!' is deprecated and will removed from version 2.4.0. use 'replica_connection_put_aside!' insted."
+          "'slave_connection_put_aside!' is deprecated and will removed from version 2.4.0. use 'replica_connection_put_aside!' instead."
         )
 
         replica_connection_put_aside!
@@ -80,7 +80,7 @@ module FreshConnection
 
       def slave_connection_recovery?
         ActiveSupport::Deprecation.warn(
-          "'slave_connection_recovery?' is deprecated and will removed from version 2.4.0. use 'replica_connection_recovery?' insted."
+          "'slave_connection_recovery?' is deprecated and will removed from version 2.4.0. use 'replica_connection_recovery?' instead."
         )
 
         replica_connection_recovery?
@@ -92,7 +92,7 @@ module FreshConnection
 
       def slave_group
         ActiveSupport::Deprecation.warn(
-          "'slave_connection_recovery?' is deprecated and will removed from version 2.4.0. use 'replica_connection_recovery?' insted."
+          "'slave_connection_recovery?' is deprecated and will removed from version 2.4.0. use 'replica_connection_recovery?' instead."
         )
 
         replica_group

data/lib/fresh_connection/extend/ar_relation.rb

@@ -60,7 +60,7 @@ module FreshConnection
 
       def enable_slave_access
         ActiveSupport::Deprecation.warn(
-          "'enable_slave_access' is deprecated and will removed from version 2.4.0. use 'enable_replica_access' insted."
+          "'enable_slave_access' is deprecated and will removed from version 2.4.0. use 'enable_replica_access' instead."
         )
 
         enable_replica_access

data/lib/fresh_connection/replica_connection_handler.rb

@@ -3,15 +3,17 @@ require 'concurrent'
 module FreshConnection
   class ReplicaConnectionHandler
     def initialize
+      @replica_group_to_pool = Concurrent::Map.new
       @class_to_pool = Concurrent::Map.new
     end
 
     def establish_connection(name, replica_group)
-      if cm = class_to_pool[name]
+      if cm = @class_to_pool[name]
         cm.put_aside!
+        @class_to_pool.delete(name)
       end
 
-      class_to_pool[name] = FreshConnection.connection_manager.new(replica_group)
+      @replica_group_to_pool[name] = replica_group
     end
 
     def connection(klass)
@@ -41,20 +43,23 @@ module FreshConnection
     private
 
     def all_connection_managers
-      class_to_pool.each_value do |connection_manager|
+      @class_to_pool.each_value do |connection_manager|
         yield(connection_manager)
       end
     end
 
     def detect_connection_manager(klass)
-      c = class_to_pool[klass.name]
+      c = class_to_pool(klass.name)
       return c if c
       return nil if ActiveRecord::Base == klass
       detect_connection_manager(klass.superclass)
     end
 
-    def class_to_pool
-      @class_to_pool
+    def class_to_pool(name)
+      return @class_to_pool[name] if @class_to_pool.key?(name)
+      g = @replica_group_to_pool[name]
+      return nil unless g
+      @class_to_pool[name] = FreshConnection.connection_manager.new(g)
     end
   end
 end

data/lib/fresh_connection/version.rb

@@ -1,4 +1,4 @@
 module FreshConnection
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fresh_connection
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Tsukasa OISHI
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord