rutter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2abaca05bb6b82020f84e94bad340f3b36b878f8
+  data.tar.gz: a9ef1e6084c8ed5ac55b4fc531ddb5a72ee2ad90
+SHA512:
+  metadata.gz: 36fe83976abbe7c9b8e1f2a19af118ad6d3f261b2c48d0bae3bfaf63888ffc45ecf27ea83f9b5d859a1ff2722a4cd027fa32ef24af777d6e169f0fa43636ba5c
+  data.tar.gz: cac8e0f2e0f2797f91f92309a69214f6e3023fd3773f6636f17188efefae64cdaef3da82b4d77c1f0c09a45f1cdf21304eaee99976f329752663fbf7efcaa313

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+/doc

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+  Exclude: []
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*"
+
+ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+script: "bundle exec rake spec:coverage"
+cache: bundler
+before_install:
+  - rvm @global do gem uninstall bundler -a -x
+  - rvm @global do gem install bundler -v 1.15.0
+after_script:
+  - "CODECLIMATE_REPO_TOKEN=d8f51b92273019156d95fcf54adf51bee10c42f9419101eae0d638f1c94075aa bundle exec codeclimate-test-reporter"
+rvm:
+  - 2.4.2
+  - 2.4.0
+  - ruby-head
+  - jruby-9.1.13.0
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: jruby-9.1.13.0
+    - rvm: ruby-head
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+-m markdown

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "codeclimate-test-reporter"
+gem "simplecov"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# Rutter
+
+HTTP router for Rack.
+
+## Status
+
+[![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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rutter"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rutter
+
+## Usage
+
+Basic usage
+
+```ruby
+require "rutter"
+
+router = Rutter.new do
+  get "/", to: ->(env) { [200, {}, ["Hello World"]] }
+end
+
+run router.freeze
+```
+
+### HTTP verbs
+
+The router supports most of the verbs available.
+
+```ruby
+require "rutter"
+
+Rutter.new do
+  get "/", to: ->(env) {}
+  post "/", to: ->(env) {}
+  put "/", to: ->(env) {}
+  patch "/", to: ->(env) {}
+  delete "/", to: ->(env) {}
+  options "/", to: ->(env) {}
+  head "/", to: ->(env) {}
+  trace "/", to: ->(env) {}
+end
+```
+
+### Named parameters
+
+In the example `:title` is a *named parameter*. The values are accessible via `env["rutter.params"]` and it contains a `Hash<String => String>`.
+
+```ruby
+require "rutter"
+
+Rutter.new do
+  get "/books/:title", to: ->(env) {}
+end
+```
+
+Named parameters only match a single path segment:
+
+```
+/books/eloquent-ruby          match
+/books/confident-ruby         match
+/books/confident-ruby.rb      no match
+/books/eloquent-ruby/reviews  no match
+/books/                       no match
+```
+
+### Catch-All parameters
+
+*catch-all* parameters have the form `*title`. Like the name suggests, they match everything, event new `/` segments. Therefore they must always be at the end of the pattern.
+
+```ruby
+require "rutter"
+
+Rutter.new do
+  get "/books/*title", to: ->(env) {}
+end
+```
+
+```
+/books/eloquent-ruby          match
+/books/confident-ruby         match
+/books/confident-ruby.rb      match
+/books/eloquent-ruby/reviews  match
+/books/                       no match
+```
+
+### Optional segments
+
+Support for optional segments have the form `(i-am-optional)`.
+
+```ruby
+require "rutter"
+
+Rutter.new do
+  get "/books(/:title)", to: ->(env) {}
+end
+```
+
+```
+/books/eloquent-ruby          match
+/books/confident-ruby         match
+/books/confident-ruby.rb      no match
+/books/eloquent-ruby/reviews  no match
+/books                        match
+```
+
+### Redirects
+
+Make legacy paths point to a new destination.
+
+```ruby
+require "rutter"
+
+Rutter.new do
+  get "/legacy-path", to: redirect("/new_path")
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sandelius/skeletor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.libs.push "spec"
+end
+
+namespace :spec do
+  task :coverage do
+    ENV["COVERAGE"] = "true"
+    Rake::Task["spec"].invoke
+  end
+end
+
+task default: :spec

data/bench/config.ru

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# $ puma -e production -t 16:16
+# $ wrk -t 2 http://localhost:9292/
+
+require "rack"
+require_relative "../lib/rutter"
+
+router = Rutter.new do
+  root to: lambda { |env|
+    [200, { "Content-Type" => "text/html" }, ["Hello World"]]
+  }
+end
+
+run router.freeze

data/bench/dynamic_routes

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby -W0
+
+require_relative "helper"
+
+router = Rutter.new
+app = Rack::MockRequest.new(router)
+
+Benchmark.bm(50) do |b|
+  b.report "generating routes" do
+    DICT.each do |route|
+      router.get "#{route}/:id", to: $endpoint
+    end
+  end
+
+  b.report "recognizing routes" do
+    TIMES.times do
+      app.get("#{DICT.sample}/54")
+    end
+  end
+end

data/bench/expand

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby -W0
+
+require_relative "helper"
+
+router = Rutter.new
+
+Benchmark.bm(50) do |b|
+  b.report "generating routes" do
+    DICT.each do |route|
+      router.get "#{route}/:id", to: $endpoint, as: route
+    end
+  end
+
+  b.report "expand routes" do
+    TIMES.times do
+      router.path(DICT.sample.to_sym, id: 54, key: "value")
+    end
+  end
+end

data/bench/helper.rb

@@ -0,0 +1,19 @@
+require "benchmark"
+require "rack"
+require_relative "../lib/rutter"
+
+BATCH_SIZE = 1000
+TIMES = 100000
+DICT = IO.foreach("/usr/share/dict/words")
+         .lazy
+         .map { |word| word.chomp.downcase }
+         .uniq
+         .take(BATCH_SIZE)
+         .sort_by(&:length)
+         .reverse
+
+$endpoint = ->(env) { [200, {}, ["Hello World"]] }
+
+puts "Loading #{BATCH_SIZE} routes, calling them #{TIMES} times...\n"
+
+GC.disable

data/bench/mount

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby -W0
+
+require_relative "helper"
+
+router = Rutter.new
+app = Rack::MockRequest.new(router)
+
+DICT.each do |route|
+  router.mount $endpoint, at: route
+end
+
+builder = Rack::Builder.app do
+  DICT.each do |route|
+    map("/#{route}") { run $endpoint }
+  end
+end
+
+rack_app = Rack::MockRequest.new(builder)
+
+Benchmark.bm(50) do |b|
+  b.report "recognizing mounts" do
+    TIMES.times do
+      app.get("/#{DICT.sample}/sub/path")
+    end
+  end
+
+  b.report "recognizing rack map" do
+    TIMES.times do
+      rack_app.get("/#{DICT.sample}/sub/path")
+    end
+  end
+end

data/bench/routes_helper

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby -W0
+
+require_relative "helper"
+
+router = Rutter.new
+routes = Rutter::Routes.new(router)
+
+DICT.each do |route|
+  router.get "#{route}/:id", to: $endpoint, as: route
+end
+
+Benchmark.bm(50) do |b|
+  b.report "dynamic *_path" do
+    TIMES.times do
+      routes.public_send "#{DICT.sample}_path", id: 54, key: "value"
+    end
+  end
+
+  b.report "dynamic *_url" do
+    TIMES.times do
+      routes.public_send "#{DICT.sample}_url", id: 54, key: "value"
+    end
+  end
+end

data/bench/static_routes

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby -W0
+
+require_relative "helper"
+
+router = Rutter.new
+app = Rack::MockRequest.new(router)
+
+Benchmark.bm(50) do |b|
+  b.report "generating routes" do
+    DICT.each do |route|
+      router.get route, to: $endpoint
+    end
+  end
+
+  b.report "recognizing routes" do
+    TIMES.times do
+      app.get(DICT.sample)
+    end
+  end
+end