coach 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3258a468d749d86884a028d51d035966dfa925a2
-  data.tar.gz: c04518e139d26372ee97a8450967d4aa32756989
+  metadata.gz: f98b2d520ff9d3365bc21440436f1505c1f691bc
+  data.tar.gz: 0ef36903075d6e1339f028c7e41bed7f9ca96ee5
 SHA512:
-  metadata.gz: 439c250dce80d2ed7f50a69d8c06aaf4d47e01ba3b25f4c368debfc0ab4431c45c8cf470f0f3377cbdb6043e1604c3c731b116e0134903d986865b06f53f9fc2
-  data.tar.gz: 01963b88c9e4886cfd523d0da278958a5db70e08e1f1fb96d2c97ba987c30392fe2581a450a613c9ee0f6427390664ba44f1c4b4b90be10efbb092b360eeb017
+  metadata.gz: 9356101215b2e311132501a81f609a4ace4a76de13d109ee6fb962ba28303edfc65882b0edd26cc6aef19b1296aa5c023f3e834465feeea115a2e8637b2314fa
+  data.tar.gz: 8901071c03b028612902d07b143595bcfc02b187a09da697c5b87c8b4395f9be1fca0105caaa2d2368ade0ae1f07676a1ea4eeee871215c70d01a19b441e242e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coach (0.2.1)
+    coach (0.2.2)
       actionpack (~> 4.2)
       activesupport (~> 4.2)
 
@@ -101,4 +101,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.10.4
+   1.10.5

data/lib/coach/errors.rb

@@ -1,9 +1,22 @@
 module Coach
   module Errors
     class MiddlewareDependencyNotMet < StandardError
-      def initialize(middleware, keys)
-        super("#{middleware.name} requires keys [#{keys.join(',')}] that are not " \
-              "provided by the middleware chain")
+      def initialize(middleware, previous_chain, missing_keys)
+        @middleware = middleware
+        @previous_chain = previous_chain
+        @missing_keys = missing_keys
+
+        super("\n\n#{chain_diagram}\n\n#{missing_keys_message}\n\n")
+      end
+
+      def missing_keys_message
+        "  #{@middleware.name} is missing #{@missing_keys} from above!"
+      end
+
+      def chain_diagram
+        @previous_chain.map do |middleware|
+          "  #{middleware.name} => #{middleware.provided}"
+        end.join("\n")
       end
     end
 

data/lib/coach/handler.rb

@@ -5,6 +5,10 @@ module Coach
     def initialize(middleware)
       @root_item = MiddlewareItem.new(middleware)
       validate!
+    rescue Coach::Errors::MiddlewareDependencyNotMet => error
+      # Remove noise of validation stack trace, reset to the handler callsite
+      error.backtrace.clear.push(*Thread.current.backtrace)
+      raise error
     end
 
     # Run validation on the root of the middleware chain

data/lib/coach/middleware_validator.rb

@@ -2,8 +2,9 @@ require "coach/errors"
 
 module Coach
   class MiddlewareValidator
-    def initialize(middleware, already_provided = [])
+    def initialize(middleware, previous_middlewares = [], already_provided = [])
       @middleware = middleware
+      @previous_middlewares = previous_middlewares.clone
       @already_provided = already_provided
     end
 
@@ -12,7 +13,7 @@ module Coach
     def validated_provides!
       if missing_requirements.any?
         raise Coach::Errors::MiddlewareDependencyNotMet.new(
-          @middleware, missing_requirements
+          @middleware, @previous_middlewares, missing_requirements
         )
       end
 
@@ -21,15 +22,20 @@ module Coach
 
     private
 
+    attr_reader :previous_middlewares
+
     def missing_requirements
       @middleware.requirements - provided_by_chain
     end
 
     def provided_by_chain
-      @provided_by_chain ||=
-        middleware_dependencies.reduce(@already_provided) do |provided, middleware|
-          provided + self.class.new(middleware, provided).validated_provides!
-        end.flatten.uniq
+      @provided_by_chain ||= begin
+        initial = [@already_provided, @previous_middlewares]
+        middleware_dependencies.reduce(initial) do |(provided, previous), middleware|
+          validator = self.class.new(middleware, previous, provided)
+          [provided + validator.validated_provides!, previous + [middleware]]
+        end.first.flatten.uniq
+      end
     end
 
     def middleware_dependencies

data/lib/coach/version.rb

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

data/spec/lib/coach/middleware_validator_spec.rb

@@ -56,7 +56,7 @@ describe Coach::MiddlewareValidator do
       context "at terminal" do
         before { head_middleware.requires :a, :c }
 
-        it { is_expected.to raise_exception(/requires keys \[a,c\]/) }
+        it { is_expected.to raise_exception(/missing \[:a, :c\]/) }
       end
 
       context "from unordered middleware" do
@@ -65,7 +65,7 @@ describe Coach::MiddlewareValidator do
           middleware_b.provides :b
         end
 
-        it { is_expected.to raise_exception(/requires keys \[b\]/) }
+        it { is_expected.to raise_exception(/missing \[:b\]/) }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coach
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 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: []