coach 0.5.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 55ee934083e8a8e015a13a1bab92877e1643475e
-  data.tar.gz: c54472da279b95b157b4c446d611be3fdaa5127b
+SHA256:
+  metadata.gz: 6f4c3a75e36f5a68ae2833e84b8bc6ccc45acbde8a137644fad05960620ae1d9
+  data.tar.gz: fcb6e844520cd5d19bcab21acc7b3e50b02708c3f750eb078dd52f844d09c3ae
 SHA512:
-  metadata.gz: f3d692848efe36f3a591af122a3f8393a9dddae02f6cd38c122f80b37d8dc4b49512ae00b9700734b15f5be72b4f731aa49486d09185975590b1bf894631e6c2
-  data.tar.gz: 9fde65cf951062595231bee30227b44d083543fd84435f21b034f4a87877290918de21bce3b0cb2ff0598028d6def49696da53eeb313cac7fbfeb23cd5590d91
+  metadata.gz: c98ecef9fe5dc20158a6285c8d7f0c4c7bf0c9d7e1529c5c4a8c639cbab57a1cd17f3a43164eaffbd33c81441203904b899d282bebb55b280c3e544c2c9d4284
+  data.tar.gz: ef8d52b4fb9596707ee21f7e6908ed7bc2b47a242e7452b507e0c90efa84d5ce8b25b0f6b61a9722636d801b368c5318c06617ae796c65dfd619a599e461692c

data/.circleci/config.yml

@@ -0,0 +1,96 @@
+version: 2
+
+references:
+  steps: &steps
+    - checkout
+
+    - type: shell
+      name: Write RAILS_VERSION to a file so we can use it for caching purposes
+      command: echo "$RAILS_VERSION" > ~/RAILS_VERSION.txt
+
+    - type: cache-restore
+      key: coach-bundler-{{ checksum "coach.gemspec" }}-{{ checksum "~/RAILS_VERSION.txt" }}
+
+    - run: gem install bundler
+
+    - run: bundle install --path vendor/bundle
+
+    - type: cache-save
+      key: coach-bundler-{{ checksum "coach.gemspec" }}-{{ checksum "~/RAILS_VERSION.txt" }}
+      paths:
+        - vendor/bundle
+
+    - type: shell
+      command: |
+        bundle exec rspec --profile 10 \
+                          --format RspecJunitFormatter \
+                          --out /tmp/test-results/rspec.xml \
+                          --format progress \
+                          spec
+
+    - type: store_test_results
+      path: /tmp/test-results
+
+    - run: bundle exec rubocop
+jobs:
+  build-ruby22-rails515:
+    docker:
+      - image: ruby:2.2
+        environment:
+          - RAILS_VERSION=5.1.5
+    steps: *steps
+  build-ruby22-rails4210:
+    docker:
+      - image: ruby:2.2
+        environment:
+          - RAILS_VERSION=4.2.10
+    steps: *steps
+  build-ruby23-rails515:
+    docker:
+      - image: ruby:2.3
+        environment:
+          - RAILS_VERSION=5.1.5
+    steps: *steps
+  build-ruby23-rails4210:
+    docker:
+      - image: ruby:2.3
+        environment:
+          - RAILS_VERSION=4.2.10
+    steps: *steps
+  build-ruby24-rails515:
+    docker:
+      - image: ruby:2.4
+        environment:
+          - RAILS_VERSION=5.1.5
+    steps: *steps
+  build-ruby24-rails4210:
+    docker:
+      - image: ruby:2.4
+        environment:
+          - RAILS_VERSION=4.2.10
+    steps: *steps
+  build-ruby25-rails515:
+    docker:
+      - image: ruby:2.5
+        environment:
+          - RAILS_VERSION=5.1.5
+    steps: *steps
+  build-ruby25-rails4210:
+    docker:
+      - image: ruby:2.5
+        environment:
+          - RAILS_VERSION=4.2.10
+    steps: *steps
+
+workflows:
+  version: 2
+  tests:
+    jobs:
+      - build-ruby22-rails515
+      - build-ruby22-rails4210
+      - build-ruby23-rails515
+      - build-ruby23-rails4210
+      - build-ruby24-rails515
+      - build-ruby24-rails4210
+      - build-ruby25-rails515
+      - build-ruby25-rails4210

data/.rubocop.yml

@@ -1,117 +1,20 @@
-# For all options see https://github.com/bbatsov/rubocop/tree/master/config
+inherit_from: .rubocop_todo.yml
 
-# Limit lines to 90 characters.
-LineLength:
-  Max: 90
+inherit_gem:
+  gc_ruboconfig: rubocop.yml
 
-# Avoid methods longer than 30 lines of code
-MethodLength:
-  CountComments: false  # count full line comments?
-  Max: 16
+AllCops:
+  TargetRubyVersion: 2.2
 
-StringLiterals:
-  Enabled: false
-
-# Wants underscores in all large numbers. Pain in the ass for things like
-# unix timestamps.
-NumericLiterals:
-  Enabled: false
-
-# Wants you to use the same argument names for every reduce. This seems kinda
-# naff compared to naming them semantically
-SingleLineBlockParams:
-  Enabled: false
-
-Style/SignalException:
-  EnforcedStyle: 'only_raise'
-
-# Use trailing rather than leading dots on multi-line call chains
-Layout/DotPosition:
-  EnforcedStyle: trailing
-
-Lint/NestedMethodDefinition:
-  Enabled: false
-
-Lint/UnusedBlockArgument:
-  Enabled: false
-
-Metrics/AbcSize:
-  Max: 61
-
-Metrics/CyclomaticComplexity:
-  Max: 10
-
-Metrics/PerceivedComplexity:
-  Max: 10
-
-Naming/AccessorMethodName:
-  Enabled: false
-
-# Allow non-ASCII characters (e.g. £) in comments
-Style/AsciiComments:
-  Enabled: false
-
-# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
-Layout/AlignHash:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
-Style/BlockDelimiters:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Layout/ClosingParenthesisIndentation:
-  Enabled: false
-
-# Configuration parameters: Keywords.
-Style/CommentAnnotation:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Layout/IndentHash:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Layout/MultilineOperationIndentation:
-  Enabled: false
-
-# Configuration parameters: NamePrefix, NamePrefixBlacklist.
-Naming/PredicateName:
-  Enabled: false
-
-Style/RedundantSelf:
-  Enabled: false
-
-Layout/SpaceBeforeFirstArg:
-  Enabled: false
-
-# Configuration parameters: MultiSpaceAllowedForOperators.
-Layout/SpaceAroundOperators:
-  Enabled: false
-
-# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
-Style/TrivialAccessors:
-  Enabled: false
-
-Metrics/BlockLength:
+Style/RescueStandardError:
   Exclude:
-    - "**/*_spec.rb"
-
-Lint/RescueWithoutErrorClass:
-  Enabled: false
+    - "*/**/*_spec.rb"
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    # These are the default allowed names, set by Rubocop
+    - io
+    - id
+    # These are some custom names that we want to allow, since they aren't
+    # uncommunicative - they're actually rather meaningful!
+    - as

data/.rubocop_todo.yml

@@ -0,0 +1,27 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-03-08 12:21:23 +0000 using RuboCop version 0.53.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/lib/coach/notifications_spec.rb'
+
+# Offense count: 5
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 3
+
+# Offense count: 12
+# Configuration parameters: Max.
+RSpec/NestedGroups:
+  Exclude:
+    - 'spec/lib/coach/handler_spec.rb'
+    - 'spec/lib/coach/middleware_validator_spec.rb'
+    - 'spec/lib/coach/request_serializer_spec.rb'
+    - 'spec/lib/coach/router_spec.rb'

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 # CHANGELOG
 
-* [#29](https://github.com/gocardless/coach/pull/29) Replace Coach.require_matchers! with actual require
+# 1.0.0 / 2018-04-19
+
+## Breaking changes
+
+* [#41](https://github.com/gocardless/coach/pull/41) Ruby versions before 2.1 are no
+longer supported.
+* [#29](https://github.com/gocardless/coach/pull/29) To use Coach's included matchers
+in RSpec, you should now `require coach/rspec`. `Coach.require_matchers!` is deprecated
+and will be removed in a future version.
+* [#47](https://github.com/gocardless/coach/pull/47) If you're using Coach's support for
+[instrumentation](https://github.com/gocardless/coach#instrumentation) with
+`ActiveSupport::Notifications`, the event names Coach publishes have changed to be more
+consistent with other libraries. The previous names will work for now, but will be removed in a future version. The changes are as follows:
+
+| Before                  | After                   |
+| ----------------------- | ------------------------|
+| coach.handler.start     | start_handler.coach     |
+| coach.middleware.start  | start_middleware.coach  |
+| coach.middleware.finish | finish_middleware.coach |
+| coach.handler.finish    | finish_handler.coach    |
+| coach.request           | request.coach           |
 
 # 0.5.1 / 2017-08-21
 

data/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem "gc_ruboconfig", "~> 2.3.4"
 gem "rails", "~> #{ENV['RAILS_VERSION']}" if ENV["RAILS_VERSION"]

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 GoCardless
+Copyright (c) 2018 GoCardless
 
 MIT License
 

data/README.md

@@ -13,6 +13,16 @@ Coach improves your controller code by encouraging:
 - **Testability** - Test each middleware in isolation, with effortless mocking of test
   data and natural RSpec matchers.
 
+# Installation
+
+To get started, just add Coach to your `Gemfile`, and then run `bundle`:
+
+```ruby
+gem 'coach'
+```
+
+Coach works with Ruby versions 2.2 and onwards.
+
 ## Coach by example
 
 The best way to see the benefits of Coach is with a demonstration.
@@ -284,19 +294,33 @@ Information for how to use `ActiveSupport`s notifications can be found
 
 | Event                         | Arguments                                              |
 |-------------------------------|------------------------------------------------------- |
-| `coach.handler.start`     | `event(:middleware, :request)`                         |
-| `coach.middleware.start`  | `event(:middleware, :request)`                         |
-| `coach.middleware.finish` | `start`, `finish`, `id`, `event(:middleware, :request)`|
-| `coach.handler.finish`    | `start`, `finish`, `id`, `event(:middleware, :request)`|
-| `coach.request`           | `event` containing request data and benchmarking       |
+| `start_handler.coach`     | `event(:middleware, :request)`                         |
+| `start_middleware.coach`  | `event(:middleware, :request)`                         |
+| `finish_middleware.coach` | `start`, `finish`, `id`, `event(:middleware, :request)`|
+| `finish_handler.coach`    | `start`, `finish`, `id`, `event(:middleware, :request)`|
+| `request.coach`           | `event` containing request data and benchmarking       |
 
-Of special interest is `coach.request`, which publishes statistics on an entire
+Of special interest is `request.coach`, which publishes statistics on an entire
 middleware chain and request. This data is particularly useful for logging, and is our
 solution to Rails `process_action.action_controller` event emitted on controller requests.
 
 The benchmarking data includes information on how long each middleware took to process,
 along with the total duration of the chain.
 
+You can add additional metadata to the notifications published by Coach by calling the
+`log_metadata` method from inside your Coach middlewares.
+
+```
+class Tracking < Coach::Middleware
+  requires :user
+
+  def call
+    log_metadata(user_id: user.id)
+    next_middleware.call
+  end
+end
+```
+
 # License & Contributing
 
 * Coach is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/coach.gemspec

@@ -1,25 +1,26 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'coach/version'
+require "coach/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'coach'
+  spec.name          = "coach"
   spec.version       = Coach::VERSION
-  spec.summary       = 'Alternative controllers built with middleware'
+  spec.summary       = "Alternative controllers built with middleware"
   spec.authors       = %w[GoCardless]
   spec.homepage      = "https://github.com/gocardless/coach"
   spec.email         = %w[developers@gocardless.com]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.2"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'actionpack', '>= 4.2'
-  spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_dependency "actionpack", ">= 4.2"
+  spec.add_dependency "activesupport", ">= 4.2"
 
-  spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rubocop', '~> 0.50.0'
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
 end

data/lib/coach.rb

@@ -1,21 +1,21 @@
-require 'active_support'
-require 'action_dispatch'
+require "active_support"
+require "action_dispatch"
 
-require_relative 'coach/errors'
-require_relative 'coach/handler'
-require_relative 'coach/middleware'
-require_relative 'coach/middleware_item'
-require_relative 'coach/middleware_validator'
-require_relative 'coach/notifications'
-require_relative 'coach/request_benchmark'
-require_relative 'coach/request_serializer'
-require_relative 'coach/router'
-require_relative 'coach/version'
+require_relative "coach/errors"
+require_relative "coach/handler"
+require_relative "coach/middleware"
+require_relative "coach/middleware_item"
+require_relative "coach/middleware_validator"
+require_relative "coach/notifications"
+require_relative "coach/request_benchmark"
+require_relative "coach/request_serializer"
+require_relative "coach/router"
+require_relative "coach/version"
 
 module Coach
   def self.require_matchers!
     puts "Calling Coach.require_matchers! is deprecated, " \
          "please use `require 'coach/rspec'` instead"
-    require_relative 'coach/rspec'
+    require_relative "coach/rspec"
   end
 end

data/lib/coach/handler.rb

@@ -1,4 +1,5 @@
 require "coach/errors"
+require "active_support/core_ext/object/try"
 
 module Coach
   class Handler
@@ -15,10 +16,11 @@ module Coach
 
     # Run validation on the root of the middleware chain
     delegate :validate!, to: :@root_item
-    delegate :publish, :instrument, to: ActiveSupport::Notifications
+    delegate :publish, :instrument, :notifier, to: ActiveSupport::Notifications
 
     # The Rack interface to handler - builds a middleware chain based on
     # the current request, and invokes it.
+    # rubocop:disable Metrics/MethodLength
     def call(env)
       context = { request: ActionDispatch::Request.new(env) }
       sequence = build_sequence(@root_item, context)
@@ -26,8 +28,8 @@ module Coach
 
       event = build_event(context)
 
-      publish('coach.handler.start', event.dup)
-      instrument('coach.handler.finish', event) do
+      publish_start(event.dup)
+      instrumented_call(event) do
         begin
           response = chain.instrument.call
         ensure
@@ -36,15 +38,16 @@ module Coach
           # simplest way to do this is pass the event by reference to ActiveSupport, then
           # modify the hash to contain this detail before the instrumentation completes.
           #
-          # This way, the last coach.handler.finish event will have all the details.
+          # This way, the last finish_handler.coach event will have all the details.
           status = response.try(:first) || STATUS_CODE_FOR_EXCEPTIONS
           event.merge!(
             response: { status: status },
-            metadata: context.fetch(:_metadata, {})
+            metadata: context.fetch(:_metadata, {}),
           )
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Traverse the middlware tree to build a linear middleware sequence,
     # containing only middlewares that apply to this request.
@@ -81,8 +84,31 @@ module Coach
     def build_event(context)
       {
         middleware: @root_item.middleware.name,
-        request: context[:request]
+        request: context[:request],
       }
     end
+
+    def publish_start(event)
+      if notifier.listening?("coach.handler.start")
+        ActiveSupport::Deprecation.warn("The 'coach.handler.start' event has been " \
+          "renamed to 'start_handler.coach' and the old name will be removed in a " \
+          "future version.")
+        publish("coach.handler.start", event)
+      end
+      publish("start_handler.coach", event)
+    end
+
+    def instrumented_call(event, &block)
+      if notifier.listening?("coach.handler.finish")
+        ActiveSupport::Deprecation.warn("The 'coach.handler.find' event has been " \
+          "renamed to 'finish_handler.coach' and the old name will be removed in a " \
+          "future version.")
+        instrument("coach.handler.finish", event) do
+          instrument("finish_handler.coach", event, &block)
+        end
+      else
+        instrument("finish_handler.coach", event, &block)
+      end
+    end
   end
 end