govuk_app_config 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f743a622acf54ffad6414762bb3af0ebfc230c40b19b8f57286671f3fe6211
-  data.tar.gz: 4f39093e5358964cae3e587a4841c414b6f2eaf14381b25e6fa909f4a163bcc6
+  metadata.gz: 11f06b82c25ddd23f985b025b26abdcce2a1c4ab772cdbf129907962d8297da8
+  data.tar.gz: aa6e55ea958fd54cf9eb833762cbf3dfc24d310af1e3bf6dd8a010f3ad4d9bc9
 SHA512:
-  metadata.gz: 7fedf54ca7d82cca175148e41fb0a72ca448675a8ccf3346bc5d29c47c7905786e3b0bfc2d0b3f4ffa0abaea786ff98e79b539df789207b1877a076182e7f913
-  data.tar.gz: 6243b62c1b2e679c033525843d527c8fc7c2c6cd2b8ab7df3aa2d6a070dd4c527af32fbfdeeabc0e53e35be2383d21f002b1816e4a8e1ce372b84279029c11b0
+  metadata.gz: c5f01c3eb3f450616bc04577f788a36a4907d690d5694f9e813c89c985b370ad2b94abc53653a3a98885fed96799d7f34085e2e478d545ee15ac9421e846800d
+  data.tar.gz: cbe282314f027a01ed6fd1aae0e490b67b0fcb8425dc802dc7311bab8d97dea60f531b30302879fbe4a11d01f95bd61edda203dda1539c01831ec089d71db278

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  rubocop-govuk:
+    - config/default.yml

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.2.1
+
+* Fix linting issues (https://github.com/alphagov/govuk_app_config/pull/149)
+
 # 2.2.0
 
 * Monkey patch `ActionDispatch::DebugExceptions#log_error` so it logs errors on a single line (https://github.com/alphagov/govuk_app_config/pull/147)

data/Rakefile

@@ -3,4 +3,9 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc "Lint Ruby"
+task :lint do
+  sh "bundle exec rubocop --format clang"
+end
+
+task default: %i[spec lint]

data/govuk_app_config.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "govuk_app_config/version"
@@ -29,10 +27,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "climate_control"
-  spec.add_development_dependency "rack-test", "~> 0.6.3"
+  spec.add_development_dependency "rack-test", "~> 1.1.0"
   spec.add_development_dependency "rails", "~> 6"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9.0"
   spec.add_development_dependency "rspec-its", "~> 1.3.0"
+  spec.add_development_dependency "rubocop-govuk"
   spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config/configure.rb

@@ -1,5 +1,5 @@
 GovukError.configure do |config|
-  config.before_send = Proc.new { |e|
+  config.before_send = proc { |e|
     GovukStatsd.increment("errors_occurred")
     GovukStatsd.increment("error_types.#{e.class.name.demodulize.underscore}")
     e
@@ -43,7 +43,7 @@ GovukError.configure do |config|
   # Rails will raise a ActionView::Template::Error, instead of the original error.
   config.inspect_exception_causes_for_exclusion = true
 
-  config.transport_failure_callback = Proc.new {
+  config.transport_failure_callback = proc {
     GovukStatsd.increment("error_reports_failed")
   }
 end

data/lib/govuk_app_config/govuk_content_security_policy.rb

@@ -9,15 +9,15 @@ module GovukContentSecurityPolicy
   # - https://cspvalidator.org
 
   GOVUK_DOMAINS = [
-    '*.publishing.service.gov.uk',
+    "*.publishing.service.gov.uk",
     "*.#{ENV['GOVUK_APP_DOMAIN_EXTERNAL'] || ENV['GOVUK_APP_DOMAIN'] || 'dev.gov.uk'}",
     "www.gov.uk",
-    "*.dev.gov.uk"
+    "*.dev.gov.uk",
   ].uniq.freeze
 
-  GOOGLE_ANALYTICS_DOMAINS = %w(www.google-analytics.com
+  GOOGLE_ANALYTICS_DOMAINS = %w[www.google-analytics.com
                                 ssl.google-analytics.com
-                                stats.g.doubleclick.net).freeze
+                                stats.g.doubleclick.net].freeze
 
   def self.build_policy(policy)
     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src

data/lib/govuk_app_config/govuk_healthcheck.rb

@@ -13,8 +13,8 @@ module GovukHealthcheck
     proc do
       [
         200,
-        {"Content-Type" => "application/json"},
-        [JSON.dump(healthcheck(checks))]
+        { "Content-Type" => "application/json" },
+        [JSON.dump(healthcheck(checks))],
       ]
     end
   end

data/lib/govuk_app_config/govuk_healthcheck/active_record.rb

@@ -7,7 +7,7 @@ module GovukHealthcheck
     def status
       ::ActiveRecord::Base.connection
       OK
-    rescue StandardError => e
+    rescue StandardError
       CRITICAL
     end
   end

data/lib/govuk_app_config/govuk_healthcheck/checkup.rb

@@ -43,7 +43,7 @@ module GovukHealthcheck
     end
 
     def status?(status)
-      component_statuses.values.any? {|s| s[:status] == status }
+      component_statuses.values.any? { |s| s[:status] == status }
     end
 
     def build_component_status(check)

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_check.rb

@@ -41,7 +41,7 @@ module GovukHealthcheck
             thresholds: {
               critical: critical_threshold(queue: name),
               warning: warning_threshold(queue: name),
-            }.select { |_, val| !(val.to_f.infinite? || val.to_f.nan?) },
+            }.reject { |_, val| val.to_f.infinite? || val.to_f.nan? },
           }
         end,
       }
@@ -51,11 +51,11 @@ module GovukHealthcheck
       raise "This method must be overriden to be a hash of queue names and data."
     end
 
-    def critical_threshold(queue:)
+    def critical_threshold(queue:) # rubocop:disable Lint/UnusedMethodArgument
       raise "This method must be overriden to be the critical threshold."
     end
 
-    def warning_threshold(queue:)
+    def warning_threshold(queue:) # rubocop:disable Lint/UnusedMethodArgument
       raise "This method must be overriden to be the warning threshold."
     end
   end

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb

@@ -6,7 +6,6 @@ module GovukHealthcheck
 
     def status
       Sidekiq.redis_info ? OK : CRITICAL
-
     rescue StandardError
       # One would expect a Redis::BaseConnectionError, but this should be
       # critical if any exception is raised when making a call to redis.

data/lib/govuk_app_config/govuk_logging.rb

@@ -1,6 +1,6 @@
-require 'logstasher'
-require 'action_controller'
-require_relative 'rails_ext/action_dispatch/debug_exceptions'
+require "logstasher"
+require "action_controller"
+require_relative "rails_ext/action_dispatch/debug_exceptions"
 
 module GovukLogging
   def self.configure
@@ -14,8 +14,11 @@ module GovukLogging
     #
     # To resolve this we've directed stdout to stderr, to cover any Rails
     # writing. This frees up the normal stdout for the logstasher logs.
+
+    # rubocop:disable Style/GlobalVars
     $real_stdout = $stdout.clone
     $stdout.reopen($stderr)
+    # rubocop:enable Style/GlobalVars
 
     # Send Rails' logs to STDERR because they're not JSON formatted.
     Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new($stderr, level: Rails.logger.level))
@@ -23,7 +26,7 @@ module GovukLogging
     # Custom that will be added to the Rails request logs
     LogStasher.add_custom_fields do |fields|
       # Mirrors Nginx request logging, e.g GET /path/here HTTP/1.1
-      fields[:request] = "#{request.request_method} #{request.fullpath} #{request.headers["SERVER_PROTOCOL"]}"
+      fields[:request] = "#{request.request_method} #{request.fullpath} #{request.headers['SERVER_PROTOCOL']}"
 
       # Pass request Id to logging
       fields[:govuk_request_id] = request.headers["GOVUK-Request-Id"]
@@ -45,11 +48,11 @@ module GovukLogging
     Rails.application.config.logstasher.job_enabled = false
 
     Rails.application.config.logstasher.logger = Logger.new(
-      $real_stdout,
+      $real_stdout, # rubocop:disable Style/GlobalVars
       level: Rails.logger.level,
       formatter: proc { |_severity, _datetime, _progname, msg|
-        "#{String === msg ? msg : msg.inspect}\n"
-      }
+        "#{msg.is_a?(String) ? msg : msg.inspect}\n"
+      },
     )
     Rails.application.config.logstasher.suppress_app_log = true
 

data/lib/govuk_app_config/govuk_statsd.rb

@@ -4,10 +4,10 @@ require "forwardable"
 module GovukStatsd
   extend SingleForwardable
   def_delegators :client, :increment, :decrement, :count, :time, :timing,
-    :gauge, :set, :batch
+                 :gauge, :set, :batch
 
   def self.client
-    @statsd_client ||= begin
+    @client ||= begin
       statsd_client = ::Statsd.new("localhost")
       statsd_client.namespace = ENV["GOVUK_STATSD_PREFIX"].to_s
       statsd_client

data/lib/govuk_app_config/govuk_unicorn.rb

@@ -9,8 +9,9 @@ module GovukUnicorn
       config.stderr_path "#{ENV['GOVUK_APP_LOGROOT']}/app.err.log"
     end
 
-    config.before_exec do |server|
+    config.before_exec do |_server|
       next unless ENV["GOVUK_APP_ROOT"]
+
       ENV["BUNDLE_GEMFILE"] = "#{ENV['GOVUK_APP_ROOT']}/Gemfile"
     end
 

data/lib/govuk_app_config/rails_ext/action_dispatch/debug_exceptions.rb

@@ -13,22 +13,21 @@ module GovukLogging
         should_monkey_patch = actual_parameters == expected_parameters
 
         unless should_monkey_patch
-          Rails.logger.warn "Refused to monkey patch ::ActionDispatch::DebugExceptions#log_error - " +
-            "signatures do not match. " +
+          Rails.logger.warn "Refused to monkey patch ::ActionDispatch::DebugExceptions#log_error - " \
+            "signatures do not match. " \
             "Expected #{expected_parameters}, but got #{actual_parameters}"
         end
 
         should_monkey_patch
-
-      rescue StandardError => ex
-        Rails.logger.warn "Failed to detect whether to monkey patch " +
-          "::ActionDispatch::DebugExceptions#log_error - #{ex.inspect}"
+      rescue StandardError => e
+        Rails.logger.warn "Failed to detect whether to monkey patch " \
+          "::ActionDispatch::DebugExceptions#log_error - #{e.inspect}"
         false
       end
 
       def self.monkey_patch_log_error(clazz = ::ActionDispatch::DebugExceptions)
         clazz.class_eval do
-          private
+        private
 
           def log_error(request, wrapper)
             logger = logger(request)

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.2.0"
+  VERSION = "2.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -118,14 +118,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +182,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-govuk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +219,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile