rutter 0.1.0

data/spec/integration/rack_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Rack integration" do
+  let(:router) do
+    Rutter.new do
+      get "/books", to: ->(_env) { [200, {}, ["Books"]] }
+    end
+  end
+
+  def app
+    router.freeze
+  end
+
+  describe "with match" do
+    it "calls the matched endpoint" do
+      get "/books"
+      assert_equal 200, last_response.status
+      assert_equal "Books", last_response.body
+    end
+  end
+
+  describe "with no match" do
+    it "returns 404" do
+      get "/authors"
+      assert_equal 404, last_response.status
+      assert_equal "Route Not Found", last_response.body
+      assert_equal "pass", last_response.headers["X-Cascade"]
+    end
+  end
+end

data/spec/integration/redirect_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Rutter::Builder#redirect" do
+  let(:router) do
+    Rutter.new do
+      get "/legacy-path", to: redirect("/new_path")
+      get "/legacy-path-custom-status", to: redirect("/new_path", status: 301)
+      get "/new_path", to: ->(_env) { [200, {}, ["Redirected"]] }
+    end
+  end
+
+  def app
+    router.freeze
+  end
+
+  it "redirect the request to the new path" do
+    get "/legacy-path"
+    assert_equal 302, last_response.status
+    assert_equal "", last_response.body
+    follow_redirect!
+    assert_equal 200, last_response.status
+    assert_equal "Redirected", last_response.body
+  end
+
+  it "support setting custom status" do
+    get "/legacy-path-custom-status"
+    assert_equal 301, last_response.status
+    follow_redirect!
+    assert_equal 200, last_response.status
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+if ENV["COVERAGE"] == "true"
+  require "simplecov"
+  require "codeclimate-test-reporter"
+
+  SimpleCov.start do
+    command_name "spec"
+    add_filter "spec"
+  end
+end
+
+require "minitest/autorun"
+require "minitest/pride"
+require "rack/test"
+require "mocha/mini_test"
+
+# Require support (helper) modules
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+require "rutter"
+
+class Minitest::Spec
+  include Rack::Test::Methods
+end

data/spec/support/assertions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Minitest::Assertions
+  def assert_file_exist(file)
+    assert File.exist?(file), "Expected #{file} to be a file"
+  end
+end

data/spec/unit/builder_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Rutter
+  describe Builder do
+    let(:router) { Builder.new }
+
+    describe "#add" do
+      it "returns the created route object" do
+        route = router.get "/books", to: ->(env) {}
+        named_route = router.get "/named_books", to: ->(env) {}, as: :books
+        assert_instance_of Route, route
+        assert_instance_of Route, named_route
+      end
+
+      it "adds a route to the collection" do
+        router.get "/books", to: ->(env) {}
+        router.post "/books", to: ->(env) {}
+
+        assert_equal 2, router.flat_map.size
+      end
+
+      it "stores the name of the route" do
+        route = router.add "GET", "/books", as: :books, to: ->(env) {}
+        assert_equal route, router.named_map[:books]
+      end
+
+      it "normalizes route names" do
+        router.get "/books", as: :_bookie__books__, to: ->(env) {}
+        assert router.named_map.key?(:bookie_books)
+      end
+
+      it "raises an error if named route already been defined" do
+        router.get "/books", as: :books, to: ->(env) {}
+
+        err = assert_raises RuntimeError do
+          router.get "/books", as: :books, to: ->(env) {}
+        end
+
+        assert_equal "a route called 'books' has already been defined",
+                     err.message
+      end
+    end
+
+    describe "#root" do
+      it "adds a root path with a root name" do
+        route = router.root to: ->(env) {}
+        assert_equal "/", route.path
+        assert_equal route, router.named_map[:root]
+      end
+    end
+
+    describe "verbs" do
+      Route::VERBS.each do |verb|
+        it "accept the #{verb} verb as method" do
+          router.send verb.downcase, "/", to: ->() {}
+          assert_equal verb, router.flat_map[0].method
+        end
+      end
+    end
+
+    describe "#path" do
+      it "generates a URL path from the arguments" do
+        router.get "/users/:id(/:username)", to: "Users#show", as: :user
+        assert_equal "/users/45/sandelius",
+                     router.path(:user, id: 45, username: "sandelius")
+        assert_equal "/users/45", router.path(:user, id: 45)
+      end
+
+      it "raises an error if route has not been defined" do
+        err = assert_raises ArgumentError do
+          router.path(:user)
+        end
+        assert_equal "no route called 'user'", err.message
+      end
+    end
+
+    describe "#url" do
+      it "generates a full URL" do
+        router.get "/users/:id", to: "Users#show", as: :user
+        assert_equal "http://example.com/users/54", router.url(:user, id: 54)
+      end
+
+      it "allows host scheme and subdomain to be set" do
+        router.get "/users/:id", to: "Users#show", as: :user
+        assert_equal(
+          "https://api.example.com/users/54",
+          router.url(
+            :user,
+            id: 54, _host: "example.com", _scheme: "https", _subdomain: "api"
+          )
+        )
+      end
+
+      it "adds port if no 80 or 433" do
+        router.get "/users/:id", to: "Users#show", as: :user
+        assert_equal(
+          "http://example.com:333/users/54",
+          router.url(:user, id: 54, _port: 333)
+        )
+      end
+    end
+
+    describe "#freeze" do
+      it "freezes all objects" do
+        router.freeze
+
+        assert router.frozen?
+        assert router.flat_map.frozen?
+        assert router.named_map.frozen?
+        assert router.verb_map.frozen?
+      end
+    end
+  end
+end

data/spec/unit/route_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Rutter
+  describe Route do
+    it "raises an error if request method is invalid" do
+      err = assert_raises ArgumentError do
+        Route.new("NONE", "/", ->(env) {})
+      end
+
+      assert_equal "invalid verb: 'NONE'", err.message
+    end
+
+    it "normalizes path" do
+      route = Route.new("GET", "//about////us/", ->(env) {})
+      assert_equal "/about/us", route.path
+    end
+
+    describe "#expand" do
+      it "expand dynamic routes" do
+        route = Route.new("GET", "/books/:id(/:title)", -> {})
+        assert_equal "/books/54/eloquent?include[]=foo",
+                     route.expand(id: 54, title: "eloquent", include: [:foo])
+        assert_equal "/books/54?include[]=foo",
+                     route.expand(id: 54, include: [:foo])
+        assert_equal "/books/54/eloquent",
+                     route.expand(id: 54, title: "eloquent")
+        assert_equal "/books/54", route.expand(id: 54)
+      end
+
+      it "expand static routes" do
+        route = Route.new("GET", "/books", -> {})
+        assert_equal "/books?include[]=foo", route.expand(include: [:foo])
+        assert_equal "/books", route.expand
+      end
+    end
+
+    describe "#match?" do
+      it "matches non regexp" do
+        route = Route.new("GET", "/books", -> {})
+        assert route.match?("/books")
+      end
+
+      it "support named parameters" do
+        route = Route.new("GET", "/pages/:id(/:title)", -> {})
+
+        assert route.match?("/pages/54/eloquent-ruby")
+        assert route.match?("/pages/54")
+        refute route.match?("/pages/54.rb")
+        refute route.match?("/pages")
+      end
+
+      it "support catch-all parameter" do
+        route = Route.new("GET", "/pages/*slug", -> {})
+        assert route.match?("/pages/54/eloquent-ruby")
+        assert route.match?("/pages/54/eloquent-ruby.rb")
+        assert route.match?("/pages/54/eloquent-ruby/with/more/parts")
+        refute route.match?("/pages")
+      end
+    end
+
+    describe "#params" do
+      it "extract params" do
+        route = Route.new("GET", "/pages/:id(/:title)", -> {})
+        assert_equal(
+          { "id" => "54", "title" => "eloquent-ruby" },
+          route.params("/pages/54/eloquent-ruby")
+        )
+
+        assert_equal(
+          { "id" => "54", "title" => nil },
+          route.params("/pages/54")
+        )
+      end
+
+      it "returns nil if no match" do
+        route = Route.new("GET", "/books/:id", -> {})
+        assert_nil route.params("/posts/54")
+      end
+
+      it "returns empty array if no params present" do
+        route = Route.new("GET", "/books", -> {})
+        assert_equal({}, route.params("/books"))
+      end
+    end
+  end
+end

data/spec/unit/routes_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Rutter
+  describe Routes do
+    let(:router) { Builder.new }
+    let(:routes) { Routes.new(router) }
+
+    it "has a *_path helper method" do
+      router.get "/books/:id", to: "Books#show", as: :book
+      assert_equal "/books/54", routes.book_path(id: 54)
+    end
+
+    it "has a *_url helper method" do
+      router.get "/books/:id", to: "Books#show", as: :book
+      assert_equal "http://example.com/books/54",
+                   routes.book_url(id: 54)
+    end
+
+    it "raises ArgumentError if route not found" do
+      assert_raises(ArgumentError) { routes.invalid_path }
+    end
+
+    it "raises NoMethodError if unknown method is called" do
+      assert_raises(NoMethodError) { routes.invalid }
+    end
+  end
+end

data/spec/unit/rutter_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Rutter do
+  it "has a version number" do
+    assert_instance_of String, Rutter::VERSION
+  end
+
+  describe ".new" do
+    it "returns a new Builder object" do
+      assert_instance_of Rutter::Builder, Rutter.new
+    end
+  end
+end

data/spec/unit/scope_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Rutter
+  describe Builder do
+    let(:router) { Builder.new }
+
+    describe "scope" do
+      it "prepends prefixes" do
+        router.scope path: "web", namespace: "Web" do
+          get "/books", to: "Books#index"
+        end
+
+        route = router.flat_map.first
+        assert_equal "/web/books", route.path
+        assert_equal "Web::Books", route.endpoint[:controller]
+      end
+
+      it "recognizes all verbs" do
+        router.scope path: "/admin", namespace: "Secure", as: :koolaid 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
+
+        assert_equal "GET", router.flat_map[0].method
+        assert_equal "POST", router.flat_map[1].method
+        assert_equal "PUT", router.flat_map[2].method
+        assert_equal "PATCH", router.flat_map[3].method
+        assert_equal "DELETE", router.flat_map[4].method
+        assert_equal "OPTIONS", router.flat_map[5].method
+        assert_equal "HEAD", router.flat_map[6].method
+        assert_equal "TRACE", router.flat_map[7].method
+      end
+
+      describe "#root" do
+        it "adds a root path with a root name" do
+          router.scope path: "/admin", namespace: "Secure", as: :koolaid do
+            root to: ->(env) {}
+          end
+
+          assert_equal "/admin", router.flat_map.first.path
+          assert router.named_map.key?(:koolaid_root)
+        end
+      end
+
+      it "support nested scopes" do
+        router.scope path: "animals", namespace: "Species", as: :animals do
+          scope path: "mammals", namespace: "Mammals", as: :mammals do
+            get "/cats", to: "Cats#index", as: :cats
+          end
+        end
+
+        route = router.flat_map.first
+        assert_equal "/animals/mammals/cats", route.path
+        assert_equal "Species::Mammals::Cats", route.endpoint[:controller]
+        assert_equal "index", route.endpoint[:action]
+        assert router.named_map.key?(:animals_mammals_cats)
+      end
+
+      describe "#mount" do
+        it "calls the root mount with path prefix" do
+          app = ->(_env) {}
+          router.expects(:mount).with(app, at: "/admin/books")
+          router.scope(path: "/admin") { mount app, at: "books" }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: rutter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tobias Sandelius
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: minitest
+  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: mocha
+  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: rack-test
+  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: 
+email: tobias@sandeli.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bench/config.ru
+- bench/dynamic_routes
+- bench/expand
+- bench/helper.rb
+- bench/mount
+- bench/routes_helper
+- bench/static_routes
+- lib/rutter.rb
+- lib/rutter/builder.rb
+- lib/rutter/route.rb
+- lib/rutter/routes.rb
+- lib/rutter/scope.rb
+- lib/rutter/version.rb
+- rutter.gemspec
+- spec/integration/mount_spec.rb
+- spec/integration/params_spec.rb
+- spec/integration/rack_spec.rb
+- spec/integration/redirect_spec.rb
+- spec/spec_helper.rb
+- spec/support/assertions.rb
+- spec/unit/builder_spec.rb
+- spec/unit/route_spec.rb
+- spec/unit/routes_spec.rb
+- spec/unit/rutter_spec.rb
+- spec/unit/scope_spec.rb
+homepage: https://github.com/sandelius/rutter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: HTTP router for Rack.
+test_files:
+- spec/integration/mount_spec.rb
+- spec/integration/params_spec.rb
+- spec/integration/rack_spec.rb
+- spec/integration/redirect_spec.rb
+- spec/spec_helper.rb
+- spec/support/assertions.rb
+- spec/unit/builder_spec.rb
+- spec/unit/route_spec.rb
+- spec/unit/routes_spec.rb
+- spec/unit/rutter_spec.rb
+- spec/unit/scope_spec.rb