fresh_connection 3.0.0.rc2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9647d59e3a6fcfa7c194109a6797bc0962f42a491ff226bbe140a093a3c71c28
-  data.tar.gz: 133f4e76f9e4f369b69241e18e331f503b2e00bc337c7778f3c026aee8a08796
+  metadata.gz: 4b67bc1788b59977212ab408786a2c50de89e59834dcb7eabfd45fd5a8b556aa
+  data.tar.gz: '0555593d5a5e54322e767ea4475d86263ea87c48d2aa618156ace835e5881389'
 SHA512:
-  metadata.gz: d5a063f3414c1e2251410930a06e09966af1db29920ec46d25908465dfef59c43feaf458aa3d71e6e04e82d343b2bca5f5caeb54a05be5947cd6800330a5ab12
-  data.tar.gz: 6d626b364389c7d63b687e1a6b6d2c551d1f66f73d32b782bb43505f5e44cec268d87779234c56929d678375cd929ca5ac13ed48557c12515e55e35c2097a1f9
+  metadata.gz: e20fade2abed85117b4dc3e55c7188ee85cdf723a0a65a270f3b53105812ff416d0d4afe94a366f87fd24dc51352d332d766b1a7622d974ec19426b0008e4087
+  data.tar.gz: 3de5c92aac34aa8fa73f556e53e0063857020724578779d8eb0f197865baf230e09c348666f49685281971d2239eb41ad7449fc2d783f16026a250f21a1d14f1

data/Appraisals

@@ -13,8 +13,8 @@ appraise "rails51" do
 end
 
 appraise "rails52" do
-  gem 'activerecord', '5.2.0'
-  gem 'activesupport', '5.2.0'
+  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

@@ -44,8 +44,6 @@ Account.count
 ### Access to the DB Master
 If you wish to ensure that queries are directed to the DB master, call `read_master`.
 
-> Note: Before version 0.4.3, `readonly(false)` must be used.
-
 ```ruby
 Article.where(id: 1).read_master
 
@@ -72,9 +70,8 @@ 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 5.0 or later.
+- If you are using Rails 4.2, you can use FreshConnection version 2.4.4 or before.
 
 ## Databases Supported
 FreshConnection currently supports MySQL and PostgreSQL.
@@ -98,88 +95,68 @@ Or install it manually with:
 $ 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.
-
-In the `Gemfile`, use:
-
-```ruby
-gem "fresh_connection", require: false
-```
-
-Then, in `config/application.rb`, add the following:
-
-```ruby
-config.after_initialize do
-  require 'fresh_connection'
-end
-```
-
 ## Configuration
 
 The FreshConnection database replica is configured within the standard Rails
 database configuration file, `config/database.yml`, using a `replica:` stanza.
 
-*Security Note*:
-
-> We strongly recommend against using secrets within the `config/database.yml`
-> file.  Instead, it is both convenient and advisable to use ERB substitutions with 
-> environment variables within the file.
-
-> Using the [`dotenv`](https://github.com/bkeepers/dotenv) gem to keep secrets in a `.env` file that is never committed 
-> to the source management repository will help make secrets manageable.
-
 Below is a sample such configuration file.
 
 ### `config/database.yml`
 
 ```yaml
+default: &default
+  adapter: mysql2
+  encoding: utf8
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  username: root
+  password:
+
 production:
-  adapter:   mysql2
-  encoding:  utf8
-  reconnect: true
-  database:  <%= ENV['DB_MASTER_NAME'] %>
-  pool:      5
-  username:  <%= ENV['DB_MASTER_USER'] %>
-  password:  <%= ENV['DB_MASTER_PASS'] %>
-  host:      <%= ENV['DB_MASTER_HOST'] %>
-  socket:    /var/run/mysqld/mysqld.sock
+  <<: *default
+  database: blog_production
+  username: master_db_user
+  password: <%= ENV['MASTER_DATABASE_PASSWORD'] %>
+  host: master_db
 
   replica:
-    username: <%= ENV['DB_REPLICA_USER'] %>
-    password: <%= ENV['DB_REPLICA_PASS'] %>
-    host:     <%= ENV['DB_REPLICA_HOST'] %>
+    username: replica_db_user
+    password: <%= ENV['REPLICA_DATABASE_PASSWORD'] %>
+    host: replica_db
 ```
 
 `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`.
 
 For example:
 
 ```yaml
+default: &default
+  adapter: mysql2
+  encoding: utf8
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  username: root
+  password:
+
 production:
-  adapter:   mysql2
-  encoding:  utf8
-  reconnect: true
-  database:  <%= ENV['DB_MASTER_NAME'] %>
-  pool:      5
-  username:  <%= ENV['DB_MASTER_USER'] %>
-  password:  <%= ENV['DB_MASTER_PASS'] %>
-  host:      <%= ENV['DB_MASTER_HOST'] %>
-  socket:    /var/run/mysqld/mysqld.sock
+  <<: *default
+  database: blog_production
+  username: master_db_user
+  password: <%= ENV['MASTER_DATABASE_PASSWORD'] %>
+  host: master_db
 
   replica:
-    username: <%= ENV['DB_REPLICA_USER'] %>
-    password: <%= ENV['DB_REPLICA_PASS'] %>
-    host:     <%= ENV['DB_REPLICA_HOST'] %>
+    username: replica_db_user
+    password: <%= ENV['REPLICA_DATABASE_PASSWORD'] %>
+    host: replica_db
 
   admin_replica:
-    username: <%= ENV['DB_ADMIN_REPLICA_USER'] %>
-    password: <%= ENV['DB_ADMIN_REPLICA_PASS'] %>
-    host:     <%= ENV['DB_ADMIN_REPLICA_HOST'] %>
+    username: admin_replica_db_user
+    password: <%= ENV['ADMIN_REPLICA_DATABASE_PASSWORD'] %>
+    host: admin_replica_db
 ```
 
 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:
@@ -211,46 +188,23 @@ The `AdminUser` and `Benefit` models will access the database configured for the
 
 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
 
+### 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` |
+The environment variables corresponding to the `:replica` group are `DATABASE_REPLICA_URL`.  
+The URL string components is the same as Rails' `DATABASE_URL'.
 
-
-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
+#### 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'
-
-### Special-Case Replica URL
+    DATABASE_REPLICA1_URL='mysql://localhost/dbreplica1?pool=5&reconnect=true'
+    DATABASE_REPLICA2_URL='postgresql://localhost:6432/ro_db?pool=5&reconnect=true'
+    DATABASE_ADMIN_REPLICA_URL='postgresql://localhost:6432/admin_db?pool=5&reconnect=true'
 
-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
 
@@ -274,12 +228,6 @@ before_fork do |server, worker|
   ActiveRecord::Base.clear_all_replica_connections!
   ...
 end
-
-after_fork do |server, worker|
-  ...
-  ActiveRecord::Base.establish_fresh_connection
-  ...
-end
 ```
 
 ### Replica Connection Manager

data/gemfiles/rails52.gemfile

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "5.2.0"
-gem "activesupport", "5.2.0"
+gem "activerecord", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
 gem "mysql2", ">= 0.4.4", "< 0.6.0"
 gem "pg", ">= 0.18", "< 2.0"
 

data/lib/fresh_connection/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module FreshConnection
-  VERSION = "3.0.0.rc2"
+  VERSION = "3.0.0"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fresh_connection
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc2
+  version: 3.0.0
 platform: ruby
 authors:
 - Tsukasa OISHI
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -251,9 +251,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6