coach 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c085b582900931acb9b56a21ee03e9b8b1695e8b9e36c23b5286acb8cc949868
-  data.tar.gz: ab1dd0c12bfcbad8b93832649f96fa3699cc036d392129f4b6e1e8aca36bb72e
+  metadata.gz: 9fbde870cfebdaad825256983d4ef36b9b413e9f22495a16ba09be11ff17f61b
+  data.tar.gz: ddb38d9c732b21937cd5a9f6ad7c3693531d8973b49939250771b251976054ba
 SHA512:
-  metadata.gz: 94525ce01d5c1b0dc75314c47f2901bdd33946fbe63ae847bf0ce6f1a1099e57c1db72f1c146199d0f77462eca826f47d0784aa21eeab41fb8b30aee3aa3dc0c
-  data.tar.gz: ccd13d3dcb3623c01f6650ce6efb842c892663afaaffa30db8e8781380a8ffcdbc9be809b0d171c224d7c494448cabf7b38d9dae989af1a0c5256bee1a949758
+  metadata.gz: eac833c21c43ba291a7e68506d1378d22b64dbc2aeeb2899f02db9ae68b6a9390e7231598ed4197465807f5958decfd3403c02db01526f48d8978366ae279d2d
+  data.tar.gz: 8a4b8dbd37680569451d321219e3b157fc202d72a368e9855b477997c8fc42f17a026ca7fe1ce445766f8af55a77f79d1e8a81b1384855b954de15b463e38bf0

data/.circleci/config.yml

@@ -1,68 +1,64 @@
-version: 2
+---
+version: 2.1
 
 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 -v 1.11.2
-
-    - run: bundle install --path vendor/bundle
+  bundle_install: &bundle_install
+    run:
+      name: Bundle
+      command: |
+        gem install bundler --no-document && \
+        bundle config set no-cache 'true' && \
+        bundle config set jobs '4' && \
+        bundle config set retry '3' && \
+        bundle install
 
-    - type: cache-save
-      key: coach-bundler-{{ checksum "coach.gemspec" }}-{{ checksum "~/RAILS_VERSION.txt" }}
+  cache_bundle: &cache_bundle
+    save_cache:
+      key: bundle-<< parameters.ruby_version >>-<< parameters.rails_version >>-{{ checksum "coach.gemspec" }}-{{ checksum "Gemfile" }}
       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
+  restore_bundle: &restore_bundle
+    restore_cache:
+      key: bundle-<< parameters.ruby_version >>-<< parameters.rails_version >>-{{ checksum "coach.gemspec" }}-{{ checksum "Gemfile" }}
 
-    - run: bundle exec rubocop
 jobs:
-  build-ruby24-rails515:
+  rspec:
+    working_directory: /mnt/ramdisk
+    parameters:
+      ruby_version:
+        type: string
+      rails_version:
+        type: string
     docker:
-      - image: ruby:2.4
+      - image: cimg/ruby:<< parameters.ruby_version >>
         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
+          CIRCLE_TEST_REPORTS: /tmp/circle_artifacts/
+    steps:
+      - add_ssh_keys
+      - checkout
+      - *restore_bundle
+      - *bundle_install
+      - *cache_bundle
+      - run:
+          name: Run specs
+          command: |
+            bundle exec rspec $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings) --profile --format progress --format RspecJunitFormatter -o /tmp/circle_artifacts/rspec.xml
+      - run:
+          name: "Rubocop"
+          command: bundle exec rubocop --extra-details --display-style-guide --parallel --force-exclusion
+      - store_artifacts:
+          path: /tmp/circle_artifacts/
+      - store_test_results:
+          path: /tmp/circle_artifacts/
 
 workflows:
   version: 2
   tests:
     jobs:
-      - build-ruby24-rails515
-      - build-ruby24-rails4210
-      - build-ruby25-rails515
-      - build-ruby25-rails4210
+      - rspec:
+          matrix:
+            parameters:
+              ruby_version: ["2.6", "2.7", "3.0"]
+              rails_version: ["5.2.6", "6.0.4", "6.1.4"]
+

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_gem:
   gc_ruboconfig: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.0
 
 Metrics/MethodLength:
   Max: 15
@@ -26,3 +26,6 @@ Naming/MethodParameterName:
     # These are some custom names that we want to allow, since they aren't
     # uncommunicative - they're actually rather meaningful!
     - as
+
+Gemspec/RequiredRubyVersion:
+  Enabled: False

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/CHANGELOG.md

@@ -2,9 +2,27 @@
 
 # Unreleased
 
-No unreleased changes.
+# 3.0.0 / 2021-09-09
 
-# 2.2.0 / 2019-01-08
+* [#105](https://github.com/gocardless/coach/pull/105) Add support for module/class names to be
+  passed to `Handler.new` and `Router#draw` to allow routes to be defined without loading the routes
+  constants, which makes using Zeitwerk much easier.
+
+* Add Ruby 3 support
+
+## Breaking changes
+
+* Remove Ruby 2.4 and 2.5 support
+
+# 2.3.0 / 2020-04-29
+
+* [#90](https://github.com/gocardless/coach/pull/90) Instrument status `0` instead of `500` when Coach::Handler catches an exception
+
+# 2.2.1 / 2020-02-06
+
+* [#85](https://github.com/gocardless/coach/pull/85) Uses [commander](https://github.com/commander-rb/commander) for CLI option parsing
+
+# 2.2.0 / 2020-01-08
 
 * [#68](https://github.com/gocardless/coach/pull/68) Add `coach` CLI and add
   documentation to README
@@ -135,4 +153,3 @@ consistent with other libraries. The previous names will work for now, but will
 
 Initial public release. This library is in beta until it hits 1.0, so backwards
 incompatible changes may be made in minor version releases.
-

data/README.md

@@ -23,7 +23,7 @@ To get started, just add Coach to your `Gemfile`, and then run `bundle`:
 gem 'coach'
 ```
 
-Coach works with Ruby versions 2.4 and onwards.
+Coach works with Ruby versions 2.6 and onwards.
 
 ## Coach by example
 
@@ -59,6 +59,21 @@ Once you've booted Rails locally, the following should return `'hello world'`:
 $ curl -XGET http://localhost:3000/hello_world
 ```
 
+### Zeitwerk
+
+The new default autoloader in Rails 6+ is [Zeitwerk](https://github.com/fxn/zeitwerk), which removes
+support for autoloading constants during app boot, which that example would do - either you have to
+`require "hello_world"` in your routes file, or avoid referencing the `HelloWorld` constant until
+the app has booted. To avoid that, you can instead pass the module or middleware _name_ to
+`Handler.new`, for example:
+
+```ruby
+Example::Application.routes.draw do
+  match "/hello_world",
+        to: Coach::Handler.new("HelloWorld"),
+        via: :get
+```
+
 ### Building chains
 
 Suppose we didn't want just anybody to see our `HelloWorld` endpoint. In fact, we'd like
@@ -136,14 +151,15 @@ end
 # Inside config/routes.rb
 Example::Application.routes.draw do
   match "/hello_user",
-        to: Coach::Handler.new(HelloUser),
+        to: Coach::Handler.new("HelloUser"),
         via: :get
 end
 ```
 
-Coach analyses your middleware chains whenever a new `Handler` is created. If any
-middleware `requires :x` when its chain does not provide `:x`, we'll error out before the
-app even starts with the error:
+Coach analyses your middleware chains whenever a new `Handler` is created, or when the handler is
+first used if the route is being lazy-loaded (i.e., if you're passing a string name, instead of the
+route itself). If any middleware `requires :x` when its chain does not provide `:x`, we'll error out
+before the app even starts with the error:
 
 ```ruby
 Coach::Errors::MiddlewareDependencyNotMet: HelloUser requires keys [user] that are not provided by the middleware chain
@@ -270,6 +286,25 @@ users resource being mapped to:
 | `PUT`  | `/users/:id`                 | Update user details                            |
 | `POST` | `/users/:id/actions/disable` | Custom action routed to the given path suffix  |
 
+If you're using Zeitwerk, you can pass the name of the module to `#draw`, instead of the module
+itself.
+
+```ruby
+# config/routes.rb
+Example::Application.routes.draw do
+  router = Coach::Router.new(self)
+  router.draw("Routes::Users",
+              base: "/users",
+              actions: [
+                :index,
+                :show,
+                :create,
+                :update,
+                disable: { method: :post, url: "/:id/actions/disable" }
+              ])
+end
+```
+
 ## Rendering
 
 By now you'll probably agree that the rack response format isn't the nicest way to render

data/bin/coach

@@ -1,57 +1,96 @@
 #!/usr/bin/env ruby
 
-require "slop"
 require "coach/cli/provider_finder"
+require "coach/version"
+require "commander"
 
-begin
-  require File.join(Dir.pwd, "config/environment")
-rescue LoadError
-  puts <<~EOS
-    Could not load your Rails app
-    =============================
+module Coach
+  class CLI
+    extend Commander::Methods
 
-    Currently the coach CLI assumes you have a config/environment.rb file that
-    we can load. We believe this is true of Rails apps in general.
+    class << self
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def run
+        program :version, Coach::VERSION
+        program :description,
+                "Coach's CLI to help understand the provide/require graph made up of " \
+                "all the middleware chains you've built using Coach.\n" \
+                "  More information at: https://github.com/gocardless/coach#coach-cli."
+        program :help_formatter, :compact
 
-    Please raise an issue if that's not the case!
+        never_trace!
 
-    https://github.com/gocardless/coach/issues
-  EOS
-  exit 1
-end
+        command "find-provider" do |c|
+          c.syntax = "bundle exec coach find-provider"
+          c.description =
+            "Given the name of a Coach middleware and a value that it requires, it " \
+            "outputs the name of the middleware that provides it."
 
-Slop.parse do
-  command "find-provider" do
-    run do |_, args|
-      middleware_name, value_name = *args
-      raise ArgumentError, "middleware_name and value_name required" unless middleware_name && value_name
+          c.action do |args, _|
+            load_config_environment
 
-      result = Coach::Cli::ProviderFinder.new(args[0], args[1]).find_provider
+            middleware_name, value_name = *args
+            raise ArgumentError, "middleware_name and value_name required" unless middleware_name && value_name
 
-      puts "Value `#{value_name}` is provided to `#{middleware_name}` by:\n\n"
-      puts result.to_a.join("\n")
-    end
-  end
+            result = Coach::Cli::ProviderFinder.new(args[0], args[1]).find_provider
+
+            puts "Value `#{value_name}` is provided to `#{middleware_name}` by:\n\n"
+            puts result.to_a.join("\n")
+          end
+        end
+
+        command "find-chain" do |c|
+          c.syntax = "bundle exec coach find-chain"
+          c.description =
+            "Given the name of a Coach middleware and a value it requires, " \
+            "it outputs the chains of middleware between the specified middleware " \
+            "and the one that provides the required value."
+
+          c.action do |args, _|
+            load_config_environment
+
+            middleware_name, value_name = *args
+            raise ArgumentError, "middleware_name and value_name required" unless middleware_name && value_name
 
-  command "find-chain" do
-    run do |_, args|
-      middleware_name, value_name = *args
-      raise ArgumentError, "middleware_name and value_name required" unless middleware_name && value_name
+            chains = Coach::Cli::ProviderFinder.new(middleware_name, value_name).find_chain
 
-      chains = Coach::Cli::ProviderFinder.new(middleware_name, value_name).find_chain
+            if chains.size > 1
+              puts "Value `#{value_name}` is provided to `#{middleware_name}` " \
+                "by multiple middleware chains:\n\n"
+            else
+              puts "Value `#{value_name}` is provided to `#{middleware_name}` by:\n\n"
+            end
 
-      if chains.size > 1
-        puts "Value `#{value_name}` is provided to `#{middleware_name}` " \
-          "by multiple middleware chains:\n\n"
-      else
-        puts "Value `#{value_name}` is provided to `#{middleware_name}` by:\n\n"
+            formatted_chains = chains.map do |chain|
+              chain.join(" -> ")
+            end.join("\n---\n")
+
+            puts formatted_chains
+          end
+        end
+
+        run!
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+      def load_config_environment
+        require File.join(Dir.pwd, "config/environment")
+      rescue LoadError
+        puts <<~ERR
+          Could not load your Rails app
+          =============================
 
-      formatted_chains = chains.map do |chain|
-        chain.join(" -> ")
-      end.join("\n---\n")
+          Currently the coach CLI assumes you have a config/environment.rb file that
+          we can load. We believe this is true of Rails apps in general.
 
-      puts formatted_chains
+          Please raise an issue if that's not the case!
+
+          https://github.com/gocardless/coach/issues
+        ERR
+        exit 1
+      end
     end
   end
 end
+
+Coach::CLI.run

data/coach.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/gocardless/coach"
   spec.email         = %w[developers@gocardless.com]
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.4"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^spec/})
@@ -21,13 +21,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "actionpack", ">= 4.2"
   spec.add_dependency "activesupport", ">= 4.2"
-  # TODO: Find another CLI parser that supports subcommands
-  # Slop v4 got rid of them :(
-  spec.add_dependency "slop", "~> 3.6"
+  spec.add_dependency "commander", "~> 4.5"
 
-  spec.add_development_dependency "gc_ruboconfig", "= 2.9.0"
+  spec.add_development_dependency "gc_ruboconfig", "~> 2.18.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.4.0"
+  spec.add_development_dependency "rubocop", "~> 1.12"
 end

data/lib/coach/handler.rb

@@ -5,19 +5,22 @@ require "active_support/core_ext/object/try"
 
 module Coach
   class Handler
-    STATUS_CODE_FOR_EXCEPTIONS = 500
+    STATUS_CODE_FOR_EXCEPTIONS = 0
+
+    attr_reader :name
 
     def initialize(middleware, config = {})
-      @root_item = MiddlewareItem.new(middleware, config)
-      validate!
-    rescue Coach::Errors::MiddlewareDependencyNotMet => e
-      # Remove noise of validation stack trace, reset to the handler callsite
-      e.backtrace.clear.concat(Thread.current.backtrace)
-      raise e
+      @config = config
+      if middleware.is_a?(String)
+        @name = middleware
+      else
+        @middleware = middleware
+        @name = middleware.name
+        # This triggers validation of the middleware chain, to raise any errors early on.
+        root_item
+      end
     end
 
-    # Run validation on the root of the middleware chain
-    delegate :validate!, to: :@root_item
     delegate :publish, :instrument, :notifier, to: ActiveSupport::Notifications
 
     # The Rack interface to handler - builds a middleware chain based on
@@ -25,28 +28,31 @@ module Coach
     # rubocop:disable Metrics/MethodLength
     def call(env)
       context = { request: ActionDispatch::Request.new(env) }
-      sequence = build_sequence(@root_item, context)
+      sequence = build_sequence(root_item, context)
       chain = build_request_chain(sequence, context)
 
       event = build_event(context)
 
       publish("start_handler.coach", event.dup)
       instrument("finish_handler.coach", event) do
-        begin
-          response = chain.instrument.call
-        ensure
-          # We want to populate the response and metadata fields after the middleware
-          # chain has completed so that the end of the instrumentation can see them. The
-          # 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 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, {}),
-          )
-        end
+        response = chain.instrument.call
+      rescue StandardError => e
+        raise
+      ensure
+        # We want to populate the response and metadata fields after the middleware
+        # chain has completed so that the end of the instrumentation can see them. The
+        # 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 finish_handler.coach event will have all the details.
+        status = response.try(:first) || STATUS_CODE_FOR_EXCEPTIONS
+        event.merge!(
+          response: {
+            status: status,
+            exception: e,
+          }.compact,
+          metadata: context.fetch(:_metadata, {}),
+        )
       end
     end
     # rubocop:enable Metrics/MethodLength
@@ -71,11 +77,25 @@ module Coach
     end
 
     def inspect
-      "#<Coach::Handler[#{@root_item.middleware.name}]>"
+      "#<Coach::Handler[#{name}]>"
     end
 
     private
 
+    attr_reader :config
+
+    def root_item
+      @root_item ||= MiddlewareItem.new(middleware, config).tap(&:validate!)
+    rescue Coach::Errors::MiddlewareDependencyNotMet => e
+      # Remove noise of validation stack trace, reset to the handler callsite
+      e.backtrace.clear.concat(Thread.current.backtrace)
+      raise e
+    end
+
+    def middleware
+      @middleware ||= ActiveSupport::Dependencies.constantize(name)
+    end
+
     # Remove middleware that have been included multiple times with the same
     # config, leaving only the first instance
     def dedup_sequence(sequence)
@@ -84,10 +104,7 @@ module Coach
 
     # Event to send with notifications
     def build_event(context)
-      {
-        middleware: @root_item.middleware.name,
-        request: context[:request],
-      }
+      { middleware: name, request: context[:request] }
     end
   end
 end

data/lib/coach/request_serializer.rb

@@ -64,7 +64,7 @@ module Coach
       header_value_pairs = @request.filtered_env.map do |key, value|
         key = if RACK_UNPREFIXED_HEADERS.include?(key)
                 "http_#{key.downcase}"
-              elsif key.match?(/^HTTP_/)
+              elsif key.start_with?("HTTP_")
                 key.downcase
               end
 

data/lib/coach/router.rb

@@ -17,14 +17,11 @@ module Coach
       @mapper = mapper
     end
 
-    def draw(routes, base: nil, as: nil, constraints: nil, actions: [])
+    def draw(namespace, base: nil, as: nil, constraints: nil, actions: [])
       action_traits(actions).each do |action, traits|
-        # Passing false to const_get prevents it searching ancestors until a
-        # match is found. Without this, globally defined constants such as
-        # `Process` will be picked up before consts that need to be autoloaded.
-        route = routes.const_get(camel(action), false)
+        handler = build_handler(namespace, action)
         match(action_url(base, traits),
-              to: Handler.new(route),
+              to: handler,
               via: traits[:method],
               as: as,
               constraints: constraints)
@@ -37,6 +34,20 @@ module Coach
 
     private
 
+    def build_handler(namespace, action)
+      action_name = camel(action)
+
+      if namespace.is_a?(String)
+        route_name = "#{namespace}::#{action_name}"
+        Handler.new(route_name)
+      else
+        # Passing false to const_get prevents it searching ancestors until a
+        # match is found. Without this, globally defined constants such as
+        # `Process` will be picked up before consts that need to be autoloaded.
+        Handler.new(namespace.const_get(action_name, false))
+      end
+    end
+
     # Receives an array of symbols that represent actions for which the default traits
     # should be used, and then lastly an optional trait configuration.
     #
@@ -60,7 +71,7 @@ module Coach
 
     # Applies trait url to base, removing duplicate /'s
     def action_url(base, traits)
-      [base, traits[:url]].compact.join("/").gsub(%r{/+}, "/")
+      [base, traits[:url]].compact.join("/").squeeze("/")
     end
 
     # Turns a snake_case string/symbol into a CamelCase

data/lib/coach/rspec.rb

@@ -15,7 +15,7 @@ def build_middleware(name)
 
     def call
       config[:callback].call if config.include?(:callback)
-      log_metadata(Hash[name.to_sym, true])
+      log_metadata(**{ name.to_sym => true })
 
       response = [name + config.except(:callback).inspect.to_s]
 

data/lib/coach/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coach
-  VERSION = "2.2.0"
+  VERSION = "3.0.0"
 end

data/spec/lib/coach/cli/provider_finder_spec.rb

@@ -201,7 +201,7 @@ describe Coach::Cli::ProviderFinder do
         expect(provider_finder.find_chain).
           to eq([
             %w[FirstProvidingMiddleware FirstIntermediateMiddleware RequiringMiddleware],
-            %w[SecondProvidingMiddleware SecondIntermediateMiddleware RequiringMiddleware], # rubocop:disable Metrics/LineLength
+            %w[SecondProvidingMiddleware SecondIntermediateMiddleware RequiringMiddleware], # rubocop:disable Layout/LineLength
           ].to_set)
       end
     end

data/spec/lib/coach/handler_spec.rb

@@ -19,19 +19,132 @@ describe Coach::Handler do
   before { Coach::Notifications.unsubscribe! }
 
   describe "#call" do
-    let(:a_double) { double }
-    let(:b_double) { double }
+    context "with multiple middleware" do
+      let(:a_double) { double.as_null_object }
+      let(:b_double) { double.as_null_object }
 
-    before do
-      terminal_middleware.uses(middleware_a, callback: a_double)
-      terminal_middleware.uses(middleware_b, callback: b_double)
+      before do
+        terminal_middleware.uses(middleware_a, callback: a_double)
+        terminal_middleware.uses(middleware_b, callback: b_double)
+      end
+
+      it "invokes all middleware in the chain" do
+        expect(a_double).to receive(:call)
+        expect(b_double).to receive(:call)
+        result = handler.call({})
+        expect(result).to eq(%w[A{} B{} Terminal{:handler=>true}])
+      end
+
+      context "with an invalid chain" do
+        before { terminal_middleware.requires(:not_available) }
+
+        it "raises an error" do
+          expect { handler }.to raise_error(Coach::Errors::MiddlewareDependencyNotMet)
+        end
+      end
+
+      context "lazy-loading the middleware" do
+        subject(:handler) { described_class.new(terminal_middleware.name, handler: true) }
+
+        before do
+          allow(ActiveSupport::Dependencies).to receive(:constantize).and_call_original
+          allow(ActiveSupport::Dependencies).to receive(:constantize).
+            with(terminal_middleware.name).
+            and_return(terminal_middleware)
+        end
+
+        it "does not load the route when initialized" do
+          expect(ActiveSupport::Dependencies).
+            to_not receive(:constantize).with(terminal_middleware.name)
+
+          handler
+        end
+
+        it "calls through the middleware chain" do
+          expect(a_double).to receive(:call)
+          expect(b_double).to receive(:call)
+
+          result = handler.call({})
+
+          expect(result).to eq(%w[A{} B{} Terminal{:handler=>true}])
+        end
+
+        context "with an invalid chain" do
+          before { terminal_middleware.requires(:not_available) }
+
+          it "does not raise on initialize" do
+            expect { handler }.to_not raise_error
+          end
+
+          it "raises on first call" do
+            expect { handler.call({}) }.
+              to raise_error(Coach::Errors::MiddlewareDependencyNotMet)
+          end
+        end
+      end
     end
 
-    it "invokes all middleware in the chain" do
-      expect(a_double).to receive(:call)
-      expect(b_double).to receive(:call)
-      result = handler.call({})
-      expect(result).to eq(%w[A{} B{} Terminal{:handler=>true}])
+    describe "notifications" do
+      subject(:coach_events) do
+        events = []
+        subscription = ActiveSupport::Notifications.
+          subscribe(/\.coach$/) { |name, *_args| events << name }
+
+        handler.call({})
+        ActiveSupport::Notifications.unsubscribe(subscription)
+        events
+      end
+
+      before do
+        terminal_middleware.uses(middleware_a)
+
+        Coach::Notifications.subscribe!
+
+        # Prevent RequestSerializer from erroring due to insufficient request mock
+        allow(Coach::RequestSerializer).
+          to receive(:new).
+          and_return(instance_double("Coach::RequestSerializer", serialize: {}))
+      end
+
+      it { is_expected.to include("start_handler.coach") }
+      it { is_expected.to include("start_middleware.coach") }
+      it { is_expected.to include("request.coach") }
+      it { is_expected.to include("finish_middleware.coach") }
+      it { is_expected.to include("finish_handler.coach") }
+
+      context "when an exception is raised in the chain" do
+        subject(:coach_events) do
+          events = []
+          subscription = ActiveSupport::Notifications.
+            subscribe(/\.coach$/) do |name, *args|
+            events << [name, args.last]
+          end
+
+          begin
+            handler.call({})
+          rescue StandardError
+            :continue_anyway
+          end
+          ActiveSupport::Notifications.unsubscribe(subscription)
+          events
+        end
+
+        let(:explosive_action) { -> { raise "AH" } }
+
+        before { terminal_middleware.uses(middleware_a, callback: explosive_action) }
+
+        it "captures the error event with the metadata and nil status" do
+          expect(coach_events).
+            to include(["finish_handler.coach", hash_including(
+              response: { status: 0, exception: instance_of(RuntimeError) },
+              metadata: { A: true },
+            )])
+        end
+
+        it "bubbles the error to the next handler" do
+          expect { handler.call({}) }.to raise_error(StandardError, "AH")
+        end
+      end
     end
   end
 
@@ -121,71 +234,6 @@ describe Coach::Handler do
     end
   end
 
-  describe "#call" do
-    before { terminal_middleware.uses(middleware_a) }
-
-    describe "notifications" do
-      subject(:coach_events) do
-        events = []
-        subscription = ActiveSupport::Notifications.
-          subscribe(/\.coach$/) { |name, *_args| events << name }
-
-        handler.call({})
-        ActiveSupport::Notifications.unsubscribe(subscription)
-        events
-      end
-
-      before do
-        Coach::Notifications.subscribe!
-
-        # Prevent RequestSerializer from erroring due to insufficient request mock
-        allow(Coach::RequestSerializer).
-          to receive(:new).
-          and_return(instance_double("Coach::RequestSerializer", serialize: {}))
-      end
-
-      it { is_expected.to include("start_handler.coach") }
-      it { is_expected.to include("start_middleware.coach") }
-      it { is_expected.to include("request.coach") }
-      it { is_expected.to include("finish_middleware.coach") }
-      it { is_expected.to include("finish_handler.coach") }
-
-      context "when an exception is raised in the chain" do
-        subject(:coach_events) do
-          events = []
-          subscription = ActiveSupport::Notifications.
-            subscribe(/\.coach$/) do |name, *args|
-            events << [name, args.last]
-          end
-
-          begin
-            handler.call({})
-          rescue StandardError
-            :continue_anyway
-          end
-          ActiveSupport::Notifications.unsubscribe(subscription)
-          events
-        end
-
-        let(:explosive_action) { -> { raise "AH" } }
-
-        before { terminal_middleware.uses(middleware_a, callback: explosive_action) }
-
-        it "captures the error event with the metadata" do
-          expect(coach_events).
-            to include(["finish_handler.coach", hash_including(
-              response: { status: 500 },
-              metadata: { A: true },
-            )])
-        end
-
-        it "bubbles the error to the next handler" do
-          expect { handler.call({}) }.to raise_error(StandardError, "AH")
-        end
-      end
-    end
-  end
-
   describe "#inspect" do
     its(:inspect) { is_expected.to eql("#<Coach::Handler[Terminal]>") }
   end

data/spec/lib/coach/router_spec.rb

@@ -10,13 +10,8 @@ describe Coach::Router do
 
   let(:mapper) { instance_double("ActionDispatch::Routing::Mapper") }
 
-  let(:resource_routes) do
-    routes_module = Module.new
-    %i[Index Show Create Update Destroy Refund].each do |class_name|
-      routes_module.const_set(class_name, Class.new)
-    end
-    routes_module
-  end
+  let(:routes) { %i[Index Show Create Update Destroy Refund] }
+  let(:resource_routes) { Routes::Thing }
 
   before do
     allow(Coach::Handler).to receive(:new) { |route| route }
@@ -84,6 +79,27 @@ describe Coach::Router do
       it "raises NameError" do
         expect { draw }.to raise_error(NameError)
       end
+
+      context "when passing a string for the namespace" do
+        subject(:router) { described_class.new(mapper) }
+
+        let(:resource_routes) { Routes::Thing.name }
+
+        before do
+          allow(ActiveSupport::Dependencies).to receive(:constantize).and_call_original
+
+          routes.each do |class_name|
+            allow(ActiveSupport::Dependencies).to receive(:constantize).
+              with("Routes::Thing::#{class_name}").
+              and_return(Routes::Thing.const_get(class_name))
+          end
+        end
+
+        it "does not raise an error" do
+          expect(mapper).to receive(:match).with("/resource/:id/process", anything)
+          expect { draw }.to_not raise_error
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,10 @@ require "pry"
 require "coach"
 require "coach/rspec"
 
+Dir[Pathname(__FILE__).dirname.join("support", "**", "*.rb")].
+  sort.
+  each { |path| require path }
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

data/spec/support/routes.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Routes
+  module Thing
+    class Index < Coach::Middleware
+      def call
+        [200, {}, []]
+      end
+    end
+
+    class Show < Coach::Middleware
+      def call
+        [200, {}, []]
+      end
+    end
+
+    class Create < Coach::Middleware
+      def call
+        [200, {}, []]
+      end
+    end
+
+    class Update < Coach::Middleware
+      def call
+        [200, {}, []]
+      end
+    end
+
+    class Destroy < Coach::Middleware
+      def call
+        [200, {}, []]
+      end
+    end
+
+    class Refund < Coach::Middleware
+      def call
+        [200, {}, []]
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coach
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - GoCardless
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: gc_ruboconfig
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
-description: 
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description:
 email:
 - developers@gocardless.com
 executables:
@@ -131,10 +145,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -166,11 +182,12 @@ files:
 - spec/lib/coach/request_serializer_spec.rb
 - spec/lib/coach/router_spec.rb
 - spec/spec_helper.rb
+- spec/support/routes.rb
 homepage: https://github.com/gocardless/coach
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,15 +195,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Alternative controllers built with middleware
 test_files:
@@ -199,3 +216,4 @@ test_files:
 - spec/lib/coach/request_serializer_spec.rb
 - spec/lib/coach/router_spec.rb
 - spec/spec_helper.rb
+- spec/support/routes.rb