rutter 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68f5fb5ae85793cb16d135928e3a26cf043a3eda09338f8c2a03117a16985b2d
-  data.tar.gz: c9766d83b10a8b6f103f26cc100ca753ecace464770fb739eccd4ecb2f2a876e
+  metadata.gz: aaf97ec12f6052df590a9a37d2979397122d416baffd31e60e18d12f932c6fff
+  data.tar.gz: 01ce145fe6f40151da57c92d4d7cf8acabb55e17c6b49ff82fdde2469f7838d2
 SHA512:
-  metadata.gz: 1b0bcaae9355facffd058bf84021a4d62d1365312c254fd4e2ead08b6d907c68791572f47dc3451d35fcda32fb777ff3c94c5785b270cc290187aef3ce3e3260
-  data.tar.gz: 10e3b47288658c8dd7068447339fa54981684e225542c4c05ac7440dc2fa3f2112c8461ac849b855e16c740e4357d0f7e673a49eabac946a762c21b028882d3a
+  metadata.gz: db521004f7e73d85d4c2f83482248a596dc3d4627bd1155c384c6d463c249547c1608053af0fdd8e9902c3ca168d822f33d9f84645f47ce349e049f24336d26c
+  data.tar.gz: a405208deab4e117809969d66d3e370d00fef1a505f8e53708d66f2f5ebb1d388d43cf46ed5a17bf03756f8cfe2965ec6070b1d39995c13132e850b4b48eae0e

data/.rubocop.yml

@@ -1,8 +1,7 @@
-require:
-  - rubocop-performance
-
+require: rubocop-performance
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
   DisplayCopNames: true
   Exclude:
     - "*.gemspec"
@@ -14,6 +13,9 @@ Performance:
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/ClassAndModuleChildren:
+  Enabled: false
+
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
@@ -27,9 +29,3 @@ Metrics/BlockLength:
 Metrics/ModuleLength:
   Exclude:
     - "spec/**/*"
-
-ClassAndModuleChildren:
-  Enabled: false
-
-Naming/UncommunicativeMethodParamName:
-  MinNameLength: 2

data/.travis.yml

@@ -3,20 +3,15 @@ script: "bundle exec rake spec:coverage"
 cache: bundler
 env:
   global:
-    - CC_TEST_REPORTER_ID=c1b17cd36cd4d025298f11b2a3ee678e4977c3969986f9ee497d6984a2c82c56
+    - CODECOV_TOKEN="21653af2-874b-4597-942d-14ddc7c2f8fa"
 before_install:
   - "gem update --system"
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 rvm:
+  - 2.7.0
   - 2.6.0
   - 2.5.0
-  - jruby-9.2.0.0
   - ruby-head
+  - jruby
   - jruby-head
   - truffleruby
 matrix:

data/Gemfile

@@ -3,8 +3,8 @@
 source "https://rubygems.org"
 gemspec
 
-unless ENV["CI"]
-  gem "byebug", platform: :mri
-end
+gem "rubocop"
+gem "rubocop-performance"
 
 gem "simplecov"
+gem 'codecov', require: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Tobias Sandelius
+Copyright (c) 2019-2020 Tobias Sandelius
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,13 +1,9 @@
 # Rutter
 
-HTTP router for Rack.
-
-## Status
-
-Under development, not ready for prime-time just yet.
+HTTP router for Ramverk and Rack.
 
 [![Build Status](https://travis-ci.org/sandelius/rutter.svg?branch=master)](https://travis-ci.org/sandelius/rutter)
-[![Test Coverage](https://codeclimate.com/github/sandelius/rutter/badges/coverage.svg)](https://codeclimate.com/github/sandelius/rutter/coverage)
+[![codecov](https://codecov.io/gh/sandelius/rutter/branch/master/graph/badge.svg)](https://codecov.io/gh/sandelius/rutter)
 [![Inline docs](http://inch-ci.org/github/sandelius/rutter.svg?branch=master)](http://inch-ci.org/github/sandelius/rutter)
 
 ## Installation

data/bench/config.ru

@@ -10,7 +10,7 @@ router = Rutter.new do
   get "/", to: ->(_) { [200, {}, ["Hello World"]] }
 
   # wrk -t 2 http://localhost:9292/ruby
-  get "/:lang", to: ->(env) { [200, {}, [env["rutter.params"]["lang"]]] }
+  get "/:lang", to: ->(env) { [200, {}, [env["router.params"]["lang"]]] }
 end.freeze
 
 run router

data/lib/rutter.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
-require_relative "rutter/version"
-require_relative "rutter/builder"
-
 # HTTP router for Rack.
 module Rutter
+  # Supported request verbs.
+  #
+  # @return [Array]
+  VERBS = %w[GET POST PUT PATCH DELETE OPTIONS].freeze
+
+  require_relative "rutter/version"
+  require_relative "rutter/builder"
+
   # Factory method for creating a new builder object.
   #
   # @param base [String]

data/lib/rutter/builder.rb

@@ -3,7 +3,6 @@
 require "uri"
 
 require_relative "naming"
-require_relative "verbs"
 require_relative "route"
 require_relative "mount"
 require_relative "scope"
@@ -40,7 +39,7 @@ module Rutter
     def initialize(base: "http://localhost:9292", &block)
       @uri = URI(base).freeze
       @flat_map = []
-      @verb_map = Hash.new { |h, k| h[k] = [] }
+      @verb_map = VERBS.map { |v| [v, []] }.to_h
       @named_map = {}
 
       instance_eval(&block) if block_given?
@@ -91,10 +90,12 @@ module Rutter
     #   Application to mount.
     # @param at [String]
     #   Path prefix to match.
+    # @param host [Regexp]
+    #   Match the given host pattern.
     #
     # @return [Rutter::Mount]
-    def mount(app, at:)
-      route = Mount.new(at, app)
+    def mount(app, at:, host: nil)
+      route = Mount.new(at, app, host: host)
       @flat_map << route
       VERBS.each { |verb| @verb_map[verb] << route }
       route
@@ -131,12 +132,12 @@ module Rutter
     #     # => "/login?return_to=/"
     #   router.path(:book, id: 82)
     #     # => "/books/82"
-    def path(name, *args)
+    def path(name, **args)
       unless (route = @named_map[name])
         raise "No route called '#{name}' was found"
       end
 
-      route.expand(*args)
+      route.expand(**args)
     end
 
     # Generates a full URL from the given arguments.
@@ -178,7 +179,7 @@ module Rutter
       host += "#{args.delete(:subdomain)}." if args.key?(:subdomain)
       host += @uri.host
       host += ":#{@uri.port}" if @uri.port != 80 && @uri.port != 443
-      host + path(name, args)
+      host + path(name, **args)
     end
 
     # Add a new, frozen, route to the map.
@@ -193,14 +194,23 @@ module Rutter
     #   Route name/identifier.
     # @param constraints [Hash]
     #   Route segment constraints.
+    # @param &block [Proc]
+    #   Endpoint as a block.
+    # @yieldparam env [Hash]
+    #   Rack's environment hash.
     #
     # @return [Rutter::Route]
     #
     # @raise [ArgumentError]
     #   If verb is unsupported.
+    # @raise [ArgumentError]
+    #   If endpoint is missing.
     #
     # @private
-    def add(verb, path, to:, as: nil, constraints: nil)
+    def add(verb, path, to: nil, as: nil, constraints: nil, &block)
+      to = block if block_given?
+      raise "Missing endpoint" unless to
+
       verb = verb.to_s.upcase
 
       unless VERBS.include?(verb)
@@ -229,8 +239,8 @@ module Rutter
 
     # @see #add
     VERBS.each do |verb|
-      define_method verb.downcase do |path, to:, as: nil, constraints: nil|
-        add verb, path, to: to, as: as, constraints: constraints
+      define_method verb.downcase do |path, to: nil, as: nil, constraints: nil, &block|
+        add verb, path, to: to, as: as, constraints: constraints, &block
       end
     end
 

data/lib/rutter/mount.rb

@@ -7,6 +7,15 @@ module Rutter
   #
   # @private
   class Mount < Route
+    # @see Rutter::Route#initialize
+    #
+    # @private
+    def initialize(path, endpoint, constraints = nil, host: nil)
+      @host = host
+
+      super(path, endpoint, constraints)
+    end
+
     # Matches the app pattern against environment.
     #
     # @param env [Hash]
@@ -15,7 +24,22 @@ module Rutter
     # @return [nil, String]
     #   Returns the matching substring or nil on no match.
     def match?(env)
+      return if @host && !@host.match?(host(env))
+
       @pattern.peek(env["PATH_INFO"])
     end
+
+    private
+
+    # @private
+    def host(env)
+      env["rutter.parsed_host"] ||= begin
+        if (forwarded = env["HTTP_X_FORWARDED_HOST"])
+          forwarded.split(/,\s?/).last
+        else
+          env["HTTP_HOST"] || env["SERVER_NAME"] || env["SERVER_ADDR"]
+        end
+      end
+    end
   end
 end

data/lib/rutter/route.rb

@@ -71,7 +71,7 @@ module Rutter
     #
     # @return [Hash]
     def params(path)
-      @pattern.params(path)
+      @pattern.params(path) || {}
     end
 
     # Calls the endpoint.
@@ -84,8 +84,8 @@ module Rutter
     #
     # @private
     def call(env)
-      env["rutter.params"] ||= {}
-      env["rutter.params"].merge!(params(env["PATH_INFO"]))
+      env["router.params"] ||= {}
+      env["router.params"].merge!(params(env["PATH_INFO"]))
       env["rutter.action"] = @endpoint[:action]
 
       ctrl = @endpoint[:controller]

data/lib/rutter/routes.rb

@@ -53,10 +53,11 @@ module Rutter
     protected
 
     # @private
-    def method_missing(method_name, *args)
+    def method_missing(method_name, **args)
       named_route, type = method_name.to_s.split(/\_(path|url)\z/)
       return super unless type
-      @router.public_send(type, named_route.to_sym, *args)
+
+      @router.public_send(type, named_route.to_sym, **args)
     end
 
     # @private

data/lib/rutter/scope.rb

@@ -34,8 +34,8 @@ module Rutter
     end
 
     # @see Rutter::Builder#mount
-    def mount(app, at:)
-      @router.mount app, at: Naming.join(@path, at)
+    def mount(app, at:, host: nil)
+      @router.mount app, at: Naming.join(@path, at), host: host
     end
 
     # @see Rutter::Builder#scope
@@ -49,18 +49,18 @@ module Rutter
     end
 
     # @see Rutter::Builder#add
-    def add(verb, path, to:, as: nil, constraints: nil)
+    def add(verb, path, to: nil, as: nil, constraints: nil, &block)
       path = Naming.join(@path, path)
       to = Naming.join(@namespace, to) if to.is_a?(String)
       as = Naming.join(@as, as) if as
 
-      @router.add verb, path, to: to, as: as, constraints: constraints
+      @router.add verb, path, to: to, as: as, constraints: constraints, &block
     end
 
     # @see Rutter::Builder#add
     VERBS.each do |verb|
-      define_method verb.downcase do |path, to:, as: nil, constraints: nil|
-        add verb, path, to: to, as: as, constraints: constraints
+      define_method verb.downcase do |path, to: nil, as: nil, constraints: nil, &block|
+        add verb, path, to: to, as: as, constraints: constraints, &block
       end
     end
   end

data/lib/rutter/version.rb

@@ -2,5 +2,5 @@
 
 module Rutter
   # Current version number.
-  VERSION = "0.2.0"
+  VERSION = "0.3.3"
 end

data/rutter.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "mustermann", "~> 1.0"
+  spec.add_runtime_dependency "mustermann", "~> 1.1"
   spec.add_runtime_dependency "rack", "~> 2.0"
 
   spec.add_development_dependency "bundler"

data/spec/integration/rack_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe "Rack compatible", type: :request do
   let :router do
     Rutter.new do
       get "/say/:message", to: (lambda do |env|
-        [200, {}, ["I say, #{env['rutter.params']['message']}"]]
+        [200, {}, ["I say, #{env['router.params']['message']}"]]
       end)
     end
   end
@@ -21,8 +21,6 @@ RSpec.describe "Rack compatible", type: :request do
         .to eq(200)
       expect(last_response.body)
         .to eq("I say, hello-world")
-      expect(last_response.headers["Content-Length"])
-        .to eq("18")
     end
   end
 

data/spec/spec_helper.rb

@@ -2,10 +2,6 @@
 
 require "bundler/setup"
 
-unless ENV["CI"]
-  require "byebug"
-end
-
 if ENV["COVERAGE"] == "true"
   require "simplecov"
 
@@ -13,6 +9,11 @@ if ENV["COVERAGE"] == "true"
     command_name "spec"
     add_filter "spec"
   end
+
+  if ENV["CODECOV_TOKEN"]
+    require "codecov"
+    SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  end
 end
 
 # Require support (helper) modules

data/spec/unit/builder_spec.rb

@@ -18,6 +18,23 @@ module Rutter
         expect(route.match?(env_for("/admin/books")))
           .to eq("/admin")
       end
+
+      it "matches host if given" do
+        route = router.mount endpoint, at: "/v1", host: /\Aapi\./
+
+        expect(route.match?(env_for("http://example.com/v1/books")))
+          .to be_nil
+        expect(route.match?(env_for("http://api.example.com/v1/books")))
+          .to eq("/v1")
+      end
+
+      it "HTTP_X_FORWARDED_HOST are supported" do
+        route = router.mount endpoint, at: "/v1", host: /\Aapi\./
+        env = env_for("/v1/books", "HTTP_X_FORWARDED_HOST" => "api.example.com")
+
+        expect(route.match?(env))
+          .to eq("/v1")
+      end
     end
 
     describe "#path" do
@@ -90,6 +107,24 @@ module Rutter
         expect(route.match?(env_for("/books/pickaxe")))
           .to be(false)
       end
+
+      it "support block as endpoint" do
+        router.get "/" do |env|
+          [200, {}, [env["message"]]]
+        end
+
+        _, _, body = router.call("REQUEST_METHOD" => "GET",
+                                 "PATH_INFO" => "/",
+                                 "message" => "Hello World")
+
+        expect(body.join)
+          .to eq("Hello World")
+      end
+
+      it "raises an error if no endpoint is given" do
+        expect { router.get "/" }
+          .to raise_error("Missing endpoint")
+      end
     end
 
     describe "verbs" do

data/spec/unit/route_spec.rb

@@ -59,6 +59,13 @@ module Rutter
         expect(route.params("/pages/54"))
           .to eq("id" => "54", "title" => nil)
       end
+
+      it "returns always return a hash" do
+        route = Route.new("/pages", endpoint)
+
+        expect(route.params("/pages"))
+          .to eq({})
+      end
     end
   end
 end

data/spec/unit/scope_spec.rb

@@ -34,6 +34,20 @@ module Rutter
         expect(route.match?(env_for("/books/pickaxe")))
           .to be(false)
       end
+
+      it "support block as endpoint" do
+        scope = router.scope path: "/books"
+        scope.get "/" do |env|
+          [200, {}, [env["message"]]]
+        end
+
+        _, _, body = router.call("REQUEST_METHOD" => "GET",
+                                 "PATH_INFO" => "/books",
+                                 "message" => "Hello World")
+
+        expect(body.join)
+          .to eq("Hello World")
+      end
     end
 
     describe "#mount" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rutter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Tobias Sandelius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustermann
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +117,6 @@ files:
 - lib/rutter/route.rb
 - lib/rutter/routes.rb
 - lib/rutter/scope.rb
-- lib/rutter/verbs.rb
 - lib/rutter/version.rb
 - rutter.gemspec
 - spec/integration/rack_spec.rb

data/lib/rutter/verbs.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Rutter
-  # Supported request verbs.
-  #
-  # @return [Array]
-  VERBS = %w[GET POST PUT PATCH DELETE OPTIONS].freeze
-end