rapporteur 3.6.0 → 3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7f822623e2116b6242b2c03aa79dfdf9dd9de3bf
-  data.tar.gz: '081da8aa11cdc0c58897950ccb92e3628c6ca2dd'
+SHA256:
+  metadata.gz: fc0ef74bb8c678f77be9dbad7aa078ab01e363d0588edd10d310dd7faebd4a14
+  data.tar.gz: cf5d2636d5922c5ca0d9afe2fa23508b1a0866d96890daa069dd1c88919e5bf3
 SHA512:
-  metadata.gz: c466833304272ab37c828c7aac7032f4addaf309c8ecad0b10404212720f0291be2b3b1a773da101bfd1484c9e4559a9bfab1df19a479882a02a666cf9dff89d
-  data.tar.gz: 7f6ac5829be1f11e402f462254e5de17bf478a4f27f8ce79177eae5ec4bc771e7da3fd2871a530c0be002baccabddbd5784a019bc6caed587ec4cc2a1b6f2e6f
+  metadata.gz: 4592348f579f226daac44efc57c5be1351481ee743494531fa7c4dde78db1354b584651e926879c7e275462567f8d77f2c995ec53c5fad7dbc3a91f31063410e
+  data.tar.gz: 06e560141febd75c535f6f61b318b8b4d6e606799809f02a5b91997c69989154156a0e4238bbef31c60269194e8e3b2ecbb3ff8cfa87f37e62e68eea0e888be0

data/Appraisals

@@ -1,15 +1,17 @@
-appraise "rails4.2.x" do
-  gem "railties", "~> 4.2.0"
+# frozen_string_literal: true
+
+appraise 'rails4.2.x' do
+  gem 'railties', '~> 4.2.0'
 end
 
-appraise "rails5.x" do
-  gem "railties", "~> 5.0"
+appraise 'rails5.x' do
+  gem 'railties', '~> 5.0'
 end
 
-appraise "sinatra1.x" do
-  gem "sinatra", "~> 1.4"
+appraise 'sinatra1.x' do
+  gem 'sinatra', '~> 1.4'
 end
 
-appraise "sinatra2.x" do
-  gem "sinatra", "~> 2.0"
+appraise 'sinatra2.x' do
+  gem 'sinatra', '~> 2.0'
 end

data/CHANGELOG.md

@@ -10,6 +10,13 @@
 
 * No significant changes.
 
+## [3.6.1][] / 2018-05-20
+
+* Convert Checker#messages and #errors into Thread-local variables. See
+  [#17](https://github.com/envylabs/rapporteur/issues/17) and
+  [#18](https://github.com/envylabs/rapporteur/issues/18), thanks to
+  [nevinera][].
+
 ## [3.6.0][] / 2017-06-10
 
 * Add `expires_now` to the Rails controller's status response. This ensures the
@@ -20,7 +27,8 @@
 
 * Fix automatic Rapporteur mount detection logic under Rails 4.0 and 4.1. The
   mapper constraints used in 4.2 were not used in 4.0 and 4.1, causing a method
-  reference error. See #15, thanks to [sshaw][].
+  reference error. See [#15](https://github.com/envylabs/rapporteur/issues/15),
+  thanks to [sshaw][].
 
 ## [3.5.0][] / 2016-01-28
 
@@ -31,7 +39,8 @@
   in their Rails application. This adds mount point flexibility at the cost of
   configuration.
 * Change ActiveRecord to use a more database agnostic `select_value` query to
-  determine availability. See #12.
+  determine availability. See
+  [#12](https://github.com/envylabs/rapporteur/issues/12).
 
 ## [3.4.0][] / 2016-01-06
 
@@ -54,7 +63,7 @@
 * Update the Rails route definition to force (and default) a JSON format. The
   intent is to fix an issue where Rails auto-appended a `(.:format)` segment to
   the fixed route and broke `/status.json` route matching. See
-  [envylabs/rapporteur#9](https://github.com/envylabs/rapporteur/issues/9).
+  [#9](https://github.com/envylabs/rapporteur/issues/9).
 
 ## [3.1.0][] / 2014-07-03
 
@@ -145,6 +154,7 @@
 
 
 [lsylvester]: https://github.com/lsylvester
+[nevinera]: https://github.com/nevinera
 [sshaw]: https://github.com/sshaw
 
 [1.0.1]: https://github.com/envylabs/rapporteur/compare/v1.0.0...v1.0.1
@@ -162,4 +172,5 @@
 [3.5.0]: https://github.com/envylabs/rapporteur/compare/v3.4.0...v3.5.0
 [3.5.1]: https://github.com/envylabs/rapporteur/compare/v3.5.0...v3.5.1
 [3.6.0]: https://github.com/envylabs/rapporteur/compare/v3.5.1...v3.6.0
-[HEAD]: https://github.com/envylabs/rapporteur/compare/v3.6.0...master
+[3.6.1]: https://github.com/envylabs/rapporteur/compare/v3.6.0...v3.6.1
+[HEAD]: https://github.com/envylabs/rapporteur/compare/v3.6.1...master

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/app/controllers/rapporteur/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rapporteur
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception

data/app/controllers/rapporteur/statuses_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rapporteur
   class StatusesController < ApplicationController
     def show
@@ -7,7 +9,7 @@ module Rapporteur
           resource = Rapporteur.run
 
           if resource.errors.empty?
-            render({:json => resource})
+            render(json: resource)
           else
             display_errors(resource, :json)
           end
@@ -15,12 +17,10 @@ module Rapporteur
       end
     end
 
-
     private
 
-
     def display_errors(resource, format)
-      render({format => {:errors => resource.errors}, :status => :internal_server_error})
+      render(format => { errors: resource.errors }, :status => :internal_server_error)
     end
   end
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rapporteur"
+require 'bundler/setup'
+require 'rapporteur'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rapporteur"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Rapporteur::Engine.routes.draw do
   get '/(.:format)', to: 'statuses#show', as: :status
 end

data/lib/rapporteur.rb

@@ -1,5 +1,7 @@
-require "rapporteur/engine" if defined?(Rails)
-require "rapporteur/version"
+# frozen_string_literal: true
+
+require 'rapporteur/engine' if defined?(Rails)
+require 'rapporteur/version'
 
 # Rapporteur is a Rails Engine which provides your application with an
 # application status endpoint.
@@ -12,7 +14,6 @@ module Rapporteur
   autoload :MessageList, 'rapporteur/message_list'
   autoload :Revision, 'rapporteur/revision'
 
-
   # Public: Add a pre-built or custom check to your status endpoint. These
   # checks are used to test the state of the world of the application, and
   # need only respond to `#call`.
@@ -30,7 +31,7 @@ module Rapporteur
   # Returns the Checker instance.
   # Raises ArgumentError if the given check does not respond to call.
   #
-  def self.add_check(object_or_nil_with_block=nil, &block)
+  def self.add_check(object_or_nil_with_block = nil, &block)
     checker.add_check(object_or_nil_with_block, &block)
   end
 

data/lib/rapporteur/check_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rapporteur
   # Manages a list of checks.
   #
@@ -13,10 +15,9 @@ module Rapporteur
     # Public: Returns a new, empty CheckList instance.
     #
     def initialize
-      @list = Array.new
+      @list = []
     end
 
-
     # Public: Add a new check to the list.
     #
     # Returns the CheckList instance.

data/lib/rapporteur/checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rapporteur
   # The center of the Rapporteur library, Checker manages holding and running
   # the custom checks, holding any application error messages, and provides the
@@ -6,15 +8,11 @@ module Rapporteur
   class Checker
     extend CheckerDeprecations
 
-
     def initialize
-      @messages = MessageList.new(:messages)
-      @errors = MessageList.new(:errors)
       @check_list = CheckList.new
       reset
     end
 
-
     # Public: Add a pre-built or custom check to your status endpoint. These
     # checks are used to test the state of the world of the application, and
     # need only respond to `#call`.
@@ -32,13 +30,13 @@ module Rapporteur
     # Returns self.
     # Raises ArgumentError if the given check does not respond to call.
     #
-    def add_check(object_or_nil_with_block=nil, &block)
+    def add_check(object_or_nil_with_block = nil, &block)
       if block_given?
-        @check_list.add(block)
+        check_list.add(block)
       elsif object_or_nil_with_block.respond_to?(:call)
-        @check_list.add(object_or_nil_with_block)
+        check_list.add(object_or_nil_with_block)
       else
-        raise ArgumentError, "A check must respond to #call."
+        raise ArgumentError, 'A check must respond to #call.'
       end
       self
     end
@@ -51,7 +49,7 @@ module Rapporteur
     # Returns self.
     #
     def clear
-      @check_list.clear
+      check_list.clear
       self
     end
 
@@ -76,7 +74,7 @@ module Rapporteur
     #
     def run
       reset
-      @check_list.each do |object|
+      check_list.each do |object|
         object.call(self)
         break if @halted
       end
@@ -116,8 +114,8 @@ module Rapporteur
     #
     # Returns self.
     #
-    def add_error(name, message, i18n_options={})
-      @errors.add(name, message, i18n_options)
+    def add_error(name, message, i18n_options = {})
+      errors.add(name, message, i18n_options)
       self
     end
 
@@ -143,42 +141,46 @@ module Rapporteur
     #
     # Returns self.
     #
-    def add_message(name, message, i18n_options={})
-      @messages.add(name, message, i18n_options)
+    def add_message(name, message, i18n_options = {})
+      messages.add(name, message, i18n_options)
       self
     end
 
     ##
     # Internal: Returns a hash of messages suitable for conversion into JSON.
     #
-    def as_json(args={})
-      @messages.to_hash
+    def as_json(_args = {})
+      messages.to_hash
     end
 
     ##
     # Internal: Used by Rails' JSON serialization to render error messages.
     #
     def errors
-      @errors
+      Thread.current[:rapporteur_errors] ||= MessageList.new(:errors)
     end
 
     ##
     # Internal: Used by Rails' JSON serialization.
     #
     def read_attribute_for_serialization(key)
-      @messages[key]
+      messages[key]
     end
 
     alias read_attribute_for_validation read_attribute_for_serialization
 
-
     private
 
+    attr_reader :check_list
+
+    def messages
+      Thread.current[:rapporteur_messages] ||= MessageList.new(:messages)
+    end
 
     def reset
       @halted = false
-      @messages.clear
-      @errors.clear
+      messages.clear
+      errors.clear
     end
   end
 end

data/lib/rapporteur/checker_deprecations.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 require 'active_support/deprecation'
 
 module Rapporteur
   module CheckerDeprecations
     def add_check(*args, &block)
-      ActiveSupport::Deprecation.warn("use Rapporteur.add_check", caller)
+      ActiveSupport::Deprecation.warn('use Rapporteur.add_check', caller)
       Rapporteur.add_check(*args, &block)
     end
 
     def clear
-      ActiveSupport::Deprecation.warn("use Rapporteur.clear_checks", caller)
+      ActiveSupport::Deprecation.warn('use Rapporteur.clear_checks', caller)
       Rapporteur.clear_checks
     end
 
     def run
-      ActiveSupport::Deprecation.warn("use Rapporteur.run", caller)
+      ActiveSupport::Deprecation.warn('use Rapporteur.run', caller)
       Rapporteur.run
     end
   end

data/lib/rapporteur/checks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rapporteur
   module Checks
     autoload :ActiveRecordCheck, 'rapporteur/checks/active_record_check'
@@ -14,7 +16,7 @@ module Rapporteur
     #     time: "2013-06-21T05:18:59Z"
     #   }
     #
-    TimeCheck = lambda { |checker| checker.add_message(:time, Time.now.utc) }
+    TimeCheck = ->(checker) { checker.add_message(:time, Time.now.utc) }
 
     # A check which reports the current revision of the running application.
     #
@@ -26,6 +28,6 @@ module Rapporteur
     #     revision: "c74edd04f64b25ff6691308bcfdefcee149aa4b5"
     #   }
     #
-    RevisionCheck = lambda { |checker| checker.add_message(:revision, Revision.current) }
+    RevisionCheck = ->(checker) { checker.add_message(:revision, Revision.current) }
   end
 end

data/lib/rapporteur/checks/active_record_check.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Rapporteur
   module Checks
     class ActiveRecordCheck
       def self.call(checker)
-        ActiveRecord::Base.connection.select_value("SELECT current_time AS time")
+        ActiveRecord::Base.connection.select_value('SELECT current_time AS time')
       rescue
         checker.add_error(:database, :unavailable)
       end

data/lib/rapporteur/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rapporteur
   class Engine < Rails::Engine
     isolate_namespace Rapporteur

data/lib/rapporteur/message_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'set'
 
@@ -8,11 +10,9 @@ module Rapporteur
   class MessageList
     extend Forwardable
 
-
     def_delegator :@messages, :clear
     def_delegator :@messages, :empty?
 
-
     # Public: Initialize a new MessageList instance.
     #
     # list_type - A Symbol representing the type of this list. This Symbol is
@@ -27,7 +27,6 @@ module Rapporteur
       @messages = Hash.new { |hash, key| hash[key] = Set.new }
     end
 
-
     # Public: Adds a new message to the list for the given attribute.
     #
     # attribute - A Symbol describing the category, attribute, or name to which
@@ -76,9 +75,9 @@ module Rapporteur
     # Returns an Array containing Strings of messages.
     #
     def full_messages
-      @messages.map { |attribute, attribute_messages|
+      @messages.map do |attribute, attribute_messages|
         attribute_messages.collect { |message| "#{attribute} #{message}" }
-      }.flatten
+      end.flatten
     end
 
     # Public: Returns the added attributes and their messages as a Hash, keyed
@@ -96,26 +95,22 @@ module Rapporteur
     # Returns a Hash instance.
     #
     def to_hash
-      hash = Hash.new
+      hash = {}
       @messages.each_pair do |key, value|
-        if value.size == 1
-          hash[key] = value.first
-        else
-          hash[key] = value.to_a
-        end
+        hash[key] = if value.size == 1
+                      value.first
+                    else
+                      value.to_a
+                    end
       end
       hash
     end
 
-
     private
 
-
     def generate_message(key, type, i18n_options)
-      I18n.translate(type, i18n_options.merge({
-        :default => [type, type.to_s],
-        :scope => [:rapporteur, @list_type, key]
-      }))
+      I18n.translate(type, i18n_options.merge(default: [type, type.to_s],
+                                              scope: [:rapporteur, @list_type, key]))
     end
 
     def normalize_message(attribute, message, i18n_options)

data/lib/rapporteur/revision.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rapporteur
   # Manages memoizing and maintaining the current application revision.
   #
@@ -47,7 +49,7 @@ module Rapporteur
       when Proc
         revision.call.to_s
       when NilClass
-        "You must provide a Rapporteur::Revision.current= String or Proc"
+        'You must provide a Rapporteur::Revision.current= String or Proc'
       else
         raise ArgumentError, "Unknown revision type given: #{revision.inspect}"
       end

data/lib/rapporteur/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rapporteur'
 
 shared_examples_for 'a successful status response' do
@@ -63,11 +65,11 @@ RSpec::Matchers.define :include_status_error_message do |attribute, message|
     @body.fetch('errors', {}).fetch(attribute.to_s).match(message)
   end
 
-  failure_message_for_should do |actual|
+  failure_message_for_should do |_actual|
     "expected #{@body.inspect} to include a #{attribute}:#{message.inspect} error message"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_for_should_not do |_actual|
     "expected #{@body.inspect} to not include a #{attribute}:#{message.inspect} error message"
   end
 end
@@ -75,14 +77,14 @@ end
 RSpec::Matchers.define :include_status_message do |name, message|
   match do |response|
     @body = JSON.parse(response.body)
-    @body.has_key?(name) && @body.fetch(name).match(message)
+    @body.key?(name) && @body.fetch(name).match(message)
   end
 
-  failure_message_for_should do |actual|
+  failure_message_for_should do |_actual|
     "expected #{@body.inspect} to include a #{name.inspect}: #{message.inspect} message"
   end
 
-  failure_message_for_should_not do |actual|
+  failure_message_for_should_not do |_actual|
     "expected #{@body.inspect} to not include a #{name.inspect}: #{message.inspect} message"
   end
 end

data/lib/rapporteur/rspec3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rapporteur'
 
 shared_examples_for 'a successful status response' do
@@ -63,7 +65,7 @@ RSpec::Matchers.define :include_status_error_message do |attribute, message|
     @body.fetch('errors', {}).fetch(attribute.to_s).match(message)
   end
 
-  failure_message_when_negated do |actual|
+  failure_message_when_negated do |_actual|
     "expected #{@body.inspect} to not include a #{attribute}:#{message.inspect} error message"
   end
 end
@@ -72,14 +74,14 @@ RSpec::Matchers.define :include_status_message do |name, message|
   match do |response|
     @body = JSON.parse(response.body)
 
-    @body.has_key?(name) && @body.fetch(name).match(message)
+    @body.key?(name) && @body.fetch(name).match(message)
   end
 
-  failure_message do |actual|
+  failure_message do |_actual|
     "expected #{@body.inspect} to include a #{name.inspect}: #{message.inspect} message"
   end
 
-  failure_message_when_negated do |actual|
+  failure_message_when_negated do |_actual|
     "expected #{@body.inspect} to not include a #{name.inspect}: #{message.inspect} message"
   end
 end

data/lib/rapporteur/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rapporteur
-  VERSION = "3.6.0".freeze
+  VERSION = '3.6.1'
 end

data/rapporteur.gemspec

@@ -1,32 +1,34 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rapporteur/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rapporteur"
+  spec.name          = 'rapporteur'
   spec.version       = Rapporteur::VERSION
-  spec.authors       = ["Envy Labs", "Code School"]
-  spec.email         = [""]
-  spec.description   = %q{An engine that provides common status polling endpoint.}
-  spec.summary       = %q{An engine that provides common status polling endpoint.}
-  spec.homepage      = "https://github.com/envylabs/rapporteur"
-  spec.license       = "MIT"
+  spec.authors       = ['Envy Labs', 'Code School']
+  spec.email         = ['']
+  spec.description   = 'An engine that provides common status polling endpoint.'
+  spec.summary       = 'An engine that provides common status polling endpoint.'
+  spec.homepage      = 'https://github.com/envylabs/rapporteur'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'i18n', '~> 0.6'
 
-  spec.add_development_dependency "appraisal", "~> 2.1"
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "combustion", "~> 0.5", ">= 0.5.1"
-  spec.add_development_dependency "rails", ">= 3.1", "< 6"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec-collection_matchers", "~> 1.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.2"
+  spec.add_development_dependency 'appraisal', '~> 2.1'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'combustion', '~> 0.5', '>= 0.5.1'
+  spec.add_development_dependency 'rails', '>= 3.1', '< 6'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapporteur
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.6.1
 platform: ruby
 authors:
 - Envy Labs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-11 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: An engine that provides common status polling endpoint.