coach 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f98b2d520ff9d3365bc21440436f1505c1f691bc
-  data.tar.gz: 0ef36903075d6e1339f028c7e41bed7f9ca96ee5
+  metadata.gz: 0032ec1d54bbe5de07362959a0e534824bc9913c
+  data.tar.gz: 1ce0cc458cc9529ccd90f5c915258a7192c97ca6
 SHA512:
-  metadata.gz: 9356101215b2e311132501a81f609a4ace4a76de13d109ee6fb962ba28303edfc65882b0edd26cc6aef19b1296aa5c023f3e834465feeea115a2e8637b2314fa
-  data.tar.gz: 8901071c03b028612902d07b143595bcfc02b187a09da697c5b87c8b4395f9be1fca0105caaa2d2368ade0ae1f07676a1ea4eeee871215c70d01a19b441e242e
+  metadata.gz: 3f3869bbafb466fb9f20437de88b0ed1ec194ace97bd71705e8822ca1ec06b4b675d787191d137e64b9aa1081332094441a53799ac25c322722d9275d91734cd
+  data.tar.gz: e358f26406181bda45c1569d1fc6c5e05ef5723c81f9510199c2fa2fcdfedc8f32651446cc7edc1925e6ca7f932f46fc1d026a6cdec2518a316fad3c3091c329

data/Gemfile.lock

@@ -1,27 +1,27 @@
 PATH
   remote: .
   specs:
-    coach (0.2.2)
+    coach (0.2.3)
       actionpack (~> 4.2)
       activesupport (~> 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (4.2.1)
-      actionview (= 4.2.1)
-      activesupport (= 4.2.1)
+    actionpack (4.2.3)
+      actionview (= 4.2.3)
+      activesupport (= 4.2.3)
       rack (~> 1.6)
       rack-test (~> 0.6.2)
       rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.1)
-    actionview (4.2.1)
-      activesupport (= 4.2.1)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.3)
+      activesupport (= 4.2.3)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.1)
-    activesupport (4.2.1)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activesupport (4.2.3)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -36,11 +36,11 @@ GEM
     erubis (2.7.0)
     i18n (0.7.0)
     json (1.8.3)
-    loofah (2.0.2)
+    loofah (2.0.3)
       nokogiri (>= 1.5.9)
     method_source (0.8.2)
     mini_portile (0.6.2)
-    minitest (5.7.0)
+    minitest (5.8.0)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     parser (2.2.2.5)
@@ -50,12 +50,12 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.6.1)
+    rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
     rails-deprecated_sanitizer (1.0.3)
       activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.6)
+    rails-dom-testing (1.0.7)
       activesupport (>= 4.2.0.beta, < 5.0)
       nokogiri (~> 1.6.0)
       rails-deprecated_sanitizer (>= 1.0.1)
@@ -101,4 +101,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.10.5
+   1.10.6

data/README.md

@@ -142,6 +142,34 @@ running code before hitting controller methods. It allows you to be confident th
 data you require has been loaded, and makes tracing the origin of that data as simple as
 looking up the chain.
 
+## Configuring middlewares
+
+By making use of middleware config hashes, you can build generalised middlewares that can
+be configured specifically for the chain that they are used in.
+
+```ruby
+class Logger < Coach::Middleware
+  def call
+    # Logs the incoming request path, with a configured prefix
+    Rails.logger.info("[#{config[:prefix]}] - #{request.path}")
+  end
+end
+
+class HelloUser < Coach::Middleware
+  uses Logger, prefix: 'HelloUser'
+  uses Authentication
+
+  def call
+    ...
+  end
+end
+```
+
+The above configures a `Logger` middleware to prefix it's log entries with `'HelloUser'`.
+This is a contrived example, but at GoCardless we've created middlewares that can act as
+generalised resource endpoints (show, index, etc) when given the model class and some
+extra configuration.
+
 ## Testing
 
 The basic strategy is to test each middleware in isolation, covering all the edge cases,

data/lib/coach/handler.rb

@@ -40,21 +40,18 @@ module Coach
     # Traverse the middlware tree to build a linear middleware sequence,
     # containing only middlewares that apply to this request.
     def build_sequence(item, context)
-      sub_sequence = item.middleware.middleware_dependencies
-      filtered_sub_sequence = filter_sequence(sub_sequence, context)
-      flattened_sub_sequence = filtered_sub_sequence.flat_map do |child_item|
-        build_sequence(child_item, context)
+      sequence = item.middleware.middleware_dependencies.map do |child_item|
+        build_sequence(child_item.set_parent(item), context)
       end
 
-      dedup_sequence(flattened_sub_sequence + [item])
+      dedup_sequence([*sequence, item].flatten)
     end
 
     # Given a middleware sequence, filter out items not applicable to the
     # current request, and set up a chain of instantiated middleware objects,
     # ready to serve a request.
     def build_request_chain(sequence, context)
-      chain_items = filter_sequence(sequence, context)
-      chain_items.reverse.reduce(nil) do |successor, item|
+      sequence.reverse.reduce(nil) do |successor, item|
         item.build_middleware(context, successor)
       end
     end
@@ -72,12 +69,6 @@ module Coach
       sequence.uniq { |item| [item.class, item.middleware, item.config] }
     end
 
-    # Filter out middleware items that don't apply to this request - i.e. those
-    # that have defined an `if` condition that doesn't match this context.
-    def filter_sequence(sequence, context)
-      sequence.select { |item| item.use_with_context?(context) }
-    end
-
     # Event to send for start of handler
     def start_event(context)
       {

data/lib/coach/middleware_item.rb

@@ -3,23 +3,18 @@ require "coach/middleware_validator"
 
 module Coach
   class MiddlewareItem
-    attr_accessor :middleware, :config
+    attr_accessor :middleware, :parent
 
     def initialize(middleware, config = {})
       @middleware = middleware
-      @config = config
+      @config_value = config
     end
 
     def build_middleware(context, successor)
-      @middleware.new(context, successor && successor.instrument, @config)
-    end
-
-    # Requires tweaking to make it run methods by symbol on the class from which the
-    # `uses` call is made.
-    def use_with_context?(context)
-      return true if @config[:if].nil?
-      return @config[:if].call(context) if @config[:if].respond_to?(:call)
-      middleware.send(@config[:if], context)
+      @middleware.
+        new(context,
+            successor && successor.instrument,
+            config)
     end
 
     # Runs validation against the middleware chain, raising if any unmet dependencies are
@@ -27,5 +22,25 @@ module Coach
     def validate!
       MiddlewareValidator.new(middleware).validated_provides!
     end
+
+    # Assigns the parent for this middleware, allowing config inheritance
+    def set_parent(parent)
+      @parent = parent
+
+      self
+    end
+
+    # Generates config by either cloning our given config (if it's a hash) else if a
+    # lambda value, then will compute the config by calling the lambda with this
+    # middlewares parent config.
+    def config
+      @config ||= lambda_config? ? @config_value.call(parent.config) : @config_value.clone
+    end
+
+    private
+
+    def lambda_config?
+      @config_value.respond_to?(:call)
+    end
   end
 end

data/lib/coach/version.rb

@@ -1,3 +1,3 @@
 module Coach
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/spec/matchers.rb

@@ -16,7 +16,7 @@ def build_middleware(name)
 
       # Build up a list of middleware called, in the order they were called
       if next_middleware
-        [name].concat(next_middleware.call)
+        [name + config.except(:callback).inspect.to_s].concat(next_middleware.call)
       else
         [name]
       end

data/spec/lib/coach/handler_spec.rb

@@ -8,6 +8,7 @@ describe Coach::Handler do
   let(:middleware_a) { build_middleware("A") }
   let(:middleware_b) { build_middleware("B") }
   let(:middleware_c) { build_middleware("C") }
+  let(:middleware_d) { build_middleware("D") }
 
   let(:terminal_middleware) { build_middleware("Terminal") }
   let(:handler) { Coach::Handler.new(terminal_middleware) }
@@ -25,7 +26,7 @@ describe Coach::Handler do
       result = handler.call({})
       expect(a_spy).to have_received(:call)
       expect(b_spy).to have_received(:call)
-      expect(result).to eq(%w(A B Terminal))
+      expect(result).to eq(%w(A{} B{} Terminal))
     end
   end
 
@@ -79,27 +80,31 @@ describe Coach::Handler do
 
   describe "#build_request_chain" do
     before { terminal_middleware.uses(middleware_a) }
-    before { terminal_middleware.uses(middleware_b, if: ->(ctx) { false }) }
-    before { terminal_middleware.uses(middleware_c) }
+    before { terminal_middleware.uses(middleware_b, b: true) }
 
     let(:root_item) { Coach::MiddlewareItem.new(terminal_middleware) }
     let(:sequence) { handler.build_sequence(root_item, {}) }
 
     it "instantiates all matching middleware items in the sequence" do
       expect(middleware_a).to receive(:new)
-      expect(middleware_c).to receive(:new)
+      expect(middleware_b).to receive(:new)
       expect(terminal_middleware).to receive(:new)
       handler.build_request_chain(sequence, {})
     end
 
-    it "doesn't instantiate non-matching middleware items" do
-      expect(middleware_b).not_to receive(:new)
-      handler.build_request_chain(sequence, {})
-    end
-
     it "sets up the chain correctly, calling each item in the correct order" do
       expect(handler.build_request_chain(sequence, {}).call).
-        to eq(%w(A C Terminal))
+        to eq(%w(A{} B{:b=>true} Terminal))
+    end
+
+    context "with inheriting config" do
+      before { middleware_b.uses(middleware_c, ->(config) { config.slice(:b) }) }
+      before { middleware_b.uses(middleware_d) }
+
+      it "calls lambda with parent middlewares config" do
+        expect(handler.build_request_chain(sequence, {}).call).
+          to eq(%w(A{} C{:b=>true} D{} B{:b=>true} Terminal))
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coach
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - GoCardless
@@ -14,84 +14,84 @@ dependencies:
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: pry
   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: rubocop
   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'
 description: Controller framework
@@ -101,10 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -139,12 +139,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -162,3 +162,4 @@ test_files:
 - spec/lib/coach/request_serializer_spec.rb
 - spec/lib/coach/router_spec.rb
 - spec/spec_helper.rb
+has_rdoc: