govuk_app_config 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5031bc1148252ab5d6997588107f1411feb9299f67ff0de2ed5ead45971a6e9
-  data.tar.gz: f1acaaf093730f3884b0768cb35a02cd166719fe4e32cdf47c99a6b438dfc635
+  metadata.gz: 629e8bd24b9422af13b87da654890af10134751f9d8b74e5afdf4eada6a70978
+  data.tar.gz: ea026c299d154655ccec7e6e1d2925e044e2457fc2c55e21d511635a442cee70
 SHA512:
-  metadata.gz: 4f4d3782a2cae06a007c8d726f04c04e584fba8796b91244bbb6bb409828153acc0b8c2472e6e090e33bb0a0bf626bf5867cea9e68ee2bc59d8d22e70259a7ee
-  data.tar.gz: dc74cca9bbbd0c0b65c92d58c0e342842a599fb5016c4833d9ddb1933d476e50bd86df61de0eb41284cfaf8ddc9c1b0fcae1039fbeacb635104443ee88d13103
+  metadata.gz: 19f52425763d71a8dc15f0429f67333e3ceda68092535371c5530efeb1dbc5ed73a829e916af6e2f8200543b73bb9f1c4c5ea39e1c4b24f46d920c3906752ab0
+  data.tar.gz: d3b1cf2e316962ee61ce2eefae6652bae6726d8378dd58d90bc03eccf146ca10bc7e417fe8e9de7fb4cf884e2419ea79e7d8601e61ed4b1906a481a318f6cc83

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 1.3.2
+
+* Update instructions to suggest that GovukUnicorn should be required directly
+  `require "govuk_app_config/govuk_unicorn"` rather than passively through
+  `require "govuk_app_config"` to isolate it from other configuration.
+* Move STDOUT/STDERR configuration inside GovukLogging module to reduce side
+  effects when gem is initialised.
+
+### How to upgrade
+
+* In your applications `config/unicorn.rb` file change
+  `require "govuk_app_config"` to `require "govuk_app_config/govuk_unicorn"`
+
 # 1.3.1
 
 * Fix collection of Statsd gauge metrics
@@ -11,7 +24,7 @@
 * Find or create a config/unicorn.rb file in the app
 * At the top of the file insert:
   ```rb
-  require "govuk_app_config"
+  require "govuk_app_config/govuk_unicorn"
   GovukUnicorn.configure(self)
   ```
 * If the app has the following, remove it:
@@ -54,13 +67,13 @@
   * If the app has any of the following (likely in `config/environments/production.rb`), remove it:
     ```rb
     # Use default logging formatter so that PID and timestamp are not suppressed.
-    config.log_formatter = ::Logger::Formatter.new		
+    config.log_formatter = ::Logger::Formatter.new
 
-    # Use a different logger for distributed setups.		
-    # require 'syslog/logger'		
-    config.logger = ActiveSupport::TaggedLogging.new(Logger.new($stderr))		
+    # Use a different logger for distributed setups.
+    # require 'syslog/logger'
+    config.logger = ActiveSupport::TaggedLogging.new(Logger.new($stderr))
 
-    $real_stdout = $stdout.clone		
+    $real_stdout = $stdout.clone
     $stdout.reopen($stderr)
     ```
 

data/README.md

@@ -29,7 +29,7 @@ Find or create a `config/unicorn.rb` in the app
 At the start of the file insert:
 
 ```rb
-require "govuk_app_config"
+require "govuk_app_config/govuk_unicorn"
 GovukUnicorn.configure(self)
 ```
 

data/lib/govuk_app_config/govuk_logging.rb

@@ -1,24 +1,25 @@
-# Rails applications have 2 outputs types:
-#
-# 1) Structured logging statements like the ones we create with
-# `Rails.logger.info` and Rails request logging, which we do with the logstasher
-# gem. These logs are output in JSON and can be read easily by our logging
-# stack.
-#
-# 2) The second are logs that are outputted when an exception occurs or `puts`
-# is used directly. This is unstructured text. Often this logging is sent to
-# STDOUT directly.
-#
-# We want to differentiate between the two types. To do this, we direct all log
-# statements that would _normally_ go to STDOUT to STDERR. This frees up the "real
-# stdout" for use by our loggers.
-$real_stdout = $stdout.clone
-$stdout.reopen($stderr)
 
 require 'logstasher'
 
 module GovukLogging
   def self.configure
+    # Rails applications have 2 outputs types:
+    #
+    # 1) Structured logging statements like the ones we create with
+    # `Rails.logger.info` and Rails request logging, which we do with the logstasher
+    # gem. These logs are output in JSON and can be read easily by our logging
+    # stack.
+    #
+    # 2) The second are logs that are outputted when an exception occurs or `puts`
+    # is used directly. This is unstructured text. Often this logging is sent to
+    # STDOUT directly.
+    #
+    # We want to differentiate between the two types. To do this, we direct all log
+    # statements that would _normally_ go to STDOUT to STDERR. This frees up the "real
+    # stdout" for use by our loggers.
+    $real_stdout = $stdout.clone
+    $stdout.reopen($stderr)
+
     # Send Rails' logs to STDERR because they're not JSON formatted.
     Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new($stderr, level: Logger::INFO))
 

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/lib/govuk_app_config.rb

@@ -2,6 +2,8 @@ require "govuk_app_config/version"
 require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
 require "govuk_app_config/govuk_logging"
+# This require is deprecated and should be removed on next major version bump
+# and should be required by applications directly.
 require "govuk_app_config/govuk_unicorn"
 require "govuk_app_config/configure"
 require "govuk_app_config/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby