coach 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 583ecf9273bec38ea336716e04040e1a54963420
-  data.tar.gz: c146e2fae603876b52609e84b9072286ce7ebc7a
+  metadata.gz: 4ebc75727eb21c437f4c87e17c22cfa510cf1099
+  data.tar.gz: 7692f0ca06eda58733aa439d59f199be7cc3006b
 SHA512:
-  metadata.gz: 15a7a7b2c1ceaa01b1517cae1b3092376fcfa21447f100d48323b5140a866d22b41f033091cefa1817824cffe69f98253daa92fa8dac71be9e6116dd2caf1720
-  data.tar.gz: 344e639454c1438bc1621da64580c975f6e1e062d35b9318d808e04d16f933eee5587075b7847bb107a284b78a91027d78ec41d49255b93d8005ff0384b6c3af
+  metadata.gz: 7da80cb20c4ef1540313b237fb1a6ce85eb4568e8e130ececb62c16573edd6aef795bd6b6492c98d4fe8bffb0330ff994e2298b8c5ead69f0a5365662888a944
+  data.tar.gz: fca5266c4df70946d81f497f242a0c7549ea9897975e4b60f570c91fa616c98dbbcb5deb320a3a909982e892a33e80c37e4a5fcfe9c4c4fa6726933463de9e5a

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# 0.4.0 / 2015-12-21
+
+* `Coach::Router.new` now accepts a `ActionDispatch::Routing::Mapper`, rather
+  than a `Rails::Application`. This means that when initialising a
+  `Coach::Router` from within a `routes.draw` block, you may now pass `self` to
+  the router, preserving surrounding context (e.g. block-level scopes).
+
+
+# 0.3.0 / 2015-11-24
+
+* Allow Handler to take a config hash, just like Middleware
+
+
+# 0.2.3 / 2015-08-24
+
+* Allow config values to be inherited
+
+
+# 0.2.2 / 2015-07-17
+
+* Diagramatic errors of missing requirements
+
+
+# 0.2.1 / 2015-06-29
+
+* Logging of metadata with ActiveSupport notifications
+
+
+# 0.2.0 / 2015-06-17
+
+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

@@ -224,20 +224,22 @@ end
 ## Routing
 
 For routes that represent resource actions, Coach provides some syntactic sugar to
-allow concise mapping of endpoint to handler.
+allow concise mapping of endpoint to handler in Rails apps.
 
 ```ruby
-router = Coach::Router.new(Example::Application)
-
-router.draw(Routes::Users,
-            base: "/users",
-            actions: [
-              :index,
-              :show,
-              :create,
-              :update,
-              disable: { method: :post, url: "/:id/actions/disable" }
-            ])
+# 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
 ```
 
 Default actions that conform to standard REST principles can be easily loaded, with the

data/coach.gemspec

@@ -6,7 +6,6 @@ require 'coach/version'
 Gem::Specification.new do |spec|
   spec.name          = 'coach'
   spec.version       = Coach::VERSION
-  spec.date          = '2015-11-24'
   spec.summary       = 'coach middleware'
   spec.description   = 'Controller framework'
   spec.authors       = %w(GoCardless)
@@ -21,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'actionpack', '~> 4.2'
   spec.add_dependency 'activesupport', '~> 4.2'
 
-  spec.add_development_dependency 'rspec', '~> 3.2.0'
-  spec.add_development_dependency 'rspec-its', '~> 1.2.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rubocop'
+  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.32'
 end

data/lib/coach/handler.rb

@@ -2,8 +2,8 @@ require "coach/errors"
 
 module Coach
   class Handler
-    def initialize(middleware)
-      @root_item = MiddlewareItem.new(middleware)
+    def initialize(middleware, config = {})
+      @root_item = MiddlewareItem.new(middleware, config)
       validate!
     rescue Coach::Errors::MiddlewareDependencyNotMet => error
       # Remove noise of validation stack trace, reset to the handler callsite

data/lib/coach/router.rb

@@ -11,8 +11,8 @@ module Coach
       destroy: { method: :delete, url: ':id' }
     }.each_value(&:freeze).freeze
 
-    def initialize(app)
-      @app = app
+    def initialize(mapper)
+      @mapper = mapper
     end
 
     def draw(routes, base: nil, as: nil, constraints: nil, actions: [])
@@ -27,9 +27,7 @@ module Coach
     end
 
     def match(url, **args)
-      @app.routes.draw do
-        match url, args
-      end
+      @mapper.match(url, args)
     end
 
     private

data/lib/coach/version.rb

@@ -1,3 +1,3 @@
 module Coach
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/spec/matchers.rb

@@ -14,11 +14,13 @@ def build_middleware(name)
       config[:callback].call if config.include?(:callback)
       log_metadata(Hash[name.to_sym, true])
 
+      response = [name + config.except(:callback).inspect.to_s]
+
       # Build up a list of middleware called, in the order they were called
       if next_middleware
-        [name + config.except(:callback).inspect.to_s].concat(next_middleware.call)
+        response.concat(next_middleware.call)
       else
-        [name]
+        response
       end
     end
   end

data/spec/lib/coach/handler_spec.rb

@@ -11,7 +11,7 @@ describe Coach::Handler do
   let(:middleware_d) { build_middleware("D") }
 
   let(:terminal_middleware) { build_middleware("Terminal") }
-  let(:handler) { Coach::Handler.new(terminal_middleware) }
+  let(:handler) { Coach::Handler.new(terminal_middleware, handler: true) }
 
   before { Coach::Notifications.unsubscribe! }
 
@@ -26,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{:handler=>true}))
     end
   end
 
@@ -94,7 +94,7 @@ describe Coach::Handler do
 
     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{} B{:b=>true} Terminal))
+        to eq(%w(A{} B{:b=>true} Terminal{}))
     end
 
     context "with inheriting config" do
@@ -103,7 +103,7 @@ describe Coach::Handler do
 
       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))
+          to eq(%w(A{} C{:b=>true} D{} B{:b=>true} Terminal{}))
       end
     end
   end
@@ -123,10 +123,9 @@ describe Coach::Handler do
 
       subject(:coach_events) do
         events = []
-        subscription =
-          ActiveSupport::Notifications.subscribe(/coach/) do |name, *args|
-            events << name
-          end
+        subscription = ActiveSupport::Notifications.subscribe(/coach/) do |name, *args|
+          events << name
+        end
 
         handler.call({})
         ActiveSupport::Notifications.unsubscribe(subscription)

data/spec/lib/coach/router_spec.rb

@@ -4,8 +4,8 @@ require 'coach/router'
 require 'coach/handler'
 
 describe Coach::Router do
-  subject(:router) { described_class.new(app) }
-  let(:app) { double(:rails_app, routes: double(draw: nil)) }
+  subject(:router) { described_class.new(mapper) }
+  let(:mapper) { double(:mapper) }
 
   before do
     allow(Coach::Handler).to receive(:new) { |route| route }
@@ -26,12 +26,12 @@ describe Coach::Router do
     let(:actions) { [action] }
 
     it "correctly mounts url for :#{action}" do
-      expect(router).to receive(:match).with(params[:url], anything)
+      expect(mapper).to receive(:match).with(params[:url], anything)
       draw
     end
 
     it "correctly mounts on method for :#{action}" do
-      expect(router).to receive(:match).
+      expect(mapper).to receive(:match).
         with(anything, hash_including(via: params[:method]))
       draw
     end
@@ -54,7 +54,7 @@ describe Coach::Router do
       context "with no slash" do
         let(:custom_url) { ':id/refund' }
         it "mounts correct url" do
-          expect(router).to receive(:match).with('/resource/:id/refund', anything)
+          expect(mapper).to receive(:match).with('/resource/:id/refund', anything)
           draw
         end
       end
@@ -62,7 +62,7 @@ describe Coach::Router do
       context "with multiple /'s" do
         let(:custom_url) { '//:id/refund' }
         it "mounts correct url" do
-          expect(router).to receive(:match).with('/resource/:id/refund', anything)
+          expect(mapper).to receive(:match).with('/resource/:id/refund', anything)
           draw
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coach
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -44,56 +44,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.32'
 description: Controller framework
 email:
 - developers@gocardless.com
@@ -105,8 +105,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - coach.gemspec
 - lib/coach.rb

data/Gemfile.lock

@@ -1,104 +0,0 @@
-PATH
-  remote: .
-  specs:
-    coach (0.3.0)
-      actionpack (~> 4.2)
-      activesupport (~> 4.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    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.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.2)
-    activesupport (4.2.3)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
-    builder (3.2.2)
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    erubis (2.7.0)
-    i18n (0.7.0)
-    json (1.8.3)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    method_source (0.8.2)
-    mini_portile (0.6.2)
-    minitest (5.8.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    parser (2.2.2.5)
-      ast (>= 1.1, < 3.0)
-    powerpack (0.1.1)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    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.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.2)
-      loofah (~> 2.0)
-    rainbow (2.0.0)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-its (1.2.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.2.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    rubocop (0.32.0)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.2.5, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.7.5)
-    slop (3.6.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  coach!
-  pry
-  rspec (~> 3.2.0)
-  rspec-its (~> 1.2.0)
-  rubocop
-
-BUNDLED WITH
-   1.10.6