hanami-router 2.0.0.alpha1 → 2.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa833cfc2bc3e9d0f796738dc3c8c649f001afdee01662094f387aabc3afa496
-  data.tar.gz: c7f7314b65e6ab36fee40e4a8d2037b4086c0f5a6ae9ddf5002e4d42007826b9
+  metadata.gz: '078b6fde8c274fe1d60ae480f8b9aec21e3c765daf8ba58f10b1b30a2d0c2135'
+  data.tar.gz: 941ad1968db99f130f18ef37ba12798e882e80b84aeb9974780edeabd446dcfb
 SHA512:
-  metadata.gz: fd5ca50885e99302376c13c8d0ccdc48db6e59b97d64ca8c3740f976ecfdf0687c6c2f841273286b92af16d880051216e8888353ef24e92285f918c31d67a65f
-  data.tar.gz: b9107bc2be7289893809d2837c37fb5cc6642715239b6c510b76af47a86c71daa186f167f8890a2f7b59292be1eeadaf0aca90bb358e2951563b0414c17245c7
+  metadata.gz: 9091771edcea709bf395654175c7a4f8c1f961d85d66f553db6591d7e1c6675cea38cfdc393e5438e219edb75c75965d4a37727e2da69cdbe1d57ce6756523b7
+  data.tar.gz: 130e577dd27732b4b74acc147a9fbaa444b682546092acd6ed849347c94edcbd779193917b66f4444dd4faf1d7f35ae5dc6755eada2b783ba5d62aa0b7d9c004

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Hanami::Router
 Rack compatible HTTP router for Ruby
 
+## v2.0.0.alpha2 - 2020-02-19
+### Added
+- [Luca Guidi] Block syntax. Routes definition accept a block which returning value is the body of the Rack response.
+- [Luca Guidi] Added `resolver:` option to `Hanami::Router#initialize` to provide your own strategy to load endpoints.
+
+### Changed
+- [Luca Guidi] Removed `Hanami::Router#resource` and `#resources`.
+- [Luca Guidi] Removed loading of routes endpoints.
+- [Luca Guidi] Removed `inflector:` from `Hanami::Router#initialize`
+- [Luca Guidi] Removed `scheme:`, `host:`, `port:` from `Hanami::Router#initialize`, use `base_url:` instead.
+
 ## v2.0.0.alpha1 - 2019-01-30
 ### Added
 - [Luca Guidi] Introduce `Hanami::Router#scope` to support single routing tier for Hanami
@@ -17,6 +28,11 @@ Rack compatible HTTP router for Ruby
 - [Luca Guidi] All the code base respects the frozen string pragma
 - [Luca Guidi] `Hanami::Router#initialize` requires `configuration:` option if routes endpoints are `Hanami::Action` subclasses
 
+## v1.3.2 - 2019-02-13
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 2.7
+- [Luca Guidi] Support `rack` 2.1
+
 ## v1.3.1 - 2019-01-18
 ### Added
 - [Luca Guidi] Official support for Ruby: MRI 2.6

data/README.md

@@ -5,7 +5,7 @@ Rack compatible, lightweight and fast HTTP Router for Ruby and [Hanami](http://h
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/hanami-router.svg)](https://badge.fury.io/rb/hanami-router)
-[![TravisCI](https://travis-ci.org/hanami/router.svg?branch=master)](https://travis-ci.org/hanami/router)
+[![Build Status](https://ci.hanamirb.org/api/badges/hanami/router/status.svg)](https://ci.hanamirb.org/hanami/router)
 [![CircleCI](https://circleci.com/gh/hanami/router/tree/master.svg?style=svg)](https://circleci.com/gh/hanami/router/tree/master)
 [![Test Coverage](https://codecov.io/gh/hanami/router/branch/master/graph/badge.svg)](https://codecov.io/gh/hanami/router)
 [![Depfu](https://badges.depfu.com/badges/5f6b8e8fa3b0d082539f0b0f84d55960/overview.svg)](https://depfu.com/github/hanami/router?project=Bundler)
@@ -30,7 +30,7 @@ __Hanami::Router__ supports Ruby (MRI) 2.5+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'hanami-router'
+gem "hanami-router"
 ```
 
 And then execute:
@@ -81,41 +81,17 @@ Hanami::Router.new do
   get "/lambda",      to: ->(env) { [200, {}, ["World"]] }
   get "/dashboard",   to: Dashboard::Index
   get "/rack-app",    to: RackApp.new
-  get "/flowers",     to: "flowers#index"
-  get "/flowers/:id", to: "flowers#show"
 
   redirect "/legacy", to: "/"
 
   mount Api::App, at: "/api"
 
-  prefix "admin" do
+  scope "admin" do
     get "/users", to: Users::Index
   end
-
-  resource "identity" do
-    member do
-      get "/avatar"
-    end
-
-    collection do
-      get "/api_keys"
-    end
-  end
-
-  resources "robots" do
-    member do
-      patch "/activate"
-    end
-
-    collection do
-      get "/search"
-    end
-  end
 end
 ```
 
-
-
 ### Fixed string matching:
 
 ```ruby
@@ -124,8 +100,6 @@ Hanami::Router.new do
 end
 ```
 
-
-
 ### String matching with variables:
 
 ```ruby
@@ -134,8 +108,6 @@ Hanami::Router.new do
 end
 ```
 
-
-
 ### Variables Constraints:
 
 ```ruby
@@ -144,8 +116,6 @@ Hanami::Router.new do
 end
 ```
 
-
-
 ### String matching with globbing:
 
 ```ruby
@@ -154,8 +124,6 @@ Hanami::Router.new do
 end
 ```
 
-
-
 ### String matching with optional tokens:
 
 ```ruby
@@ -164,8 +132,6 @@ Hanami::Router.new do
 end
 ```
 
-
-
 ### Support for the most common HTTP methods:
 
 ```ruby
@@ -182,8 +148,6 @@ Hanami::Router.new do
 end
 ```
 
-
-
 ### Root:
 
 ```ruby
@@ -192,8 +156,6 @@ Hanami::Router.new do
 end
 ```
 
-
-
 ### Redirect:
 
 ```ruby
@@ -203,8 +165,6 @@ Hanami::Router.new do
 end
 ```
 
-
-
 ### Named routes:
 
 ```ruby
@@ -217,13 +177,12 @@ router.url(:hanami)  # => "https://hanamirb.org/hanami"
 ```
 
 
-
-### Prefixed routes:
+### Scopes:
 
 ```ruby
 router = Hanami::Router.new do
-  prefix "animals" do
-    prefix "mammals" do
+  scope "animals" do
+    scope "mammals" do
       get "/cats", to: ->(env) { [200, {}, ["Meow!"]] }, as: :cats
     end
   end
@@ -238,24 +197,15 @@ router.path(:animals_mammals_cats) # => "/animals/mammals/cats"
 
 ### Mount Rack applications:
 
+Mounting a Rack application will forward all kind of HTTP requests to the app,
+when the request path matches the `at:` path.
+
 ```ruby
 Hanami::Router.new do
-  mount RackOne,                            at: "/rack1"
-  mount RackTwo,                            at: "/rack2"
-  mount RackThree.new,                      at: "/rack3"
-  mount ->(env) {[200, {}, ["Rack Four"]]}, at: "/rack4"
-  mount "dashboard#index",                  at: "/dashboard"
+  mount MyRackApp.new, at: "/foo"
 end
 ```
 
-1. `RackOne` is used as it is (class), because it respond to `.call`
-2. `RackTwo` is initialized, because it respond to `#call`
-3. `RackThree` is used as it is (object), because it respond to `#call`
-4. That Proc is used as it is, because it respond to `#call`
-5. That string is resolved as `Dashboard::Index` ([Hanami::Controller](https://github.com/hanami/controller) integration)
-
-
-
 ### Duck typed endpoints:
 
 Everything that responds to `#call` is invoked as it is:
@@ -263,45 +213,11 @@ Everything that responds to `#call` is invoked as it is:
 ```ruby
 Hanami::Router.new do
   get "/hanami",     to: ->(env) { [200, {}, ["Hello from Hanami!"]] }
-  get "/middleware", to: Middleware
   get "/rack-app",   to: RackApp.new
   get "/method",     to: ActionControllerSubclass.action(:new)
 end
 ```
 
-
-If it's a string, it tries to instantiate a class from it:
-
-```ruby
-class RackApp
-  def call(env)
-    # ...
-  end
-end
-
-Hanami::Router.new do
-  get "/hanami", to: "rack_app" # it will map to RackApp.new
-end
-```
-
-It also supports Controller + Action syntax:
-
-```ruby
-module Flowers
-  class Index < Hanami::Action
-    def handle(*)
-      # ...
-    end
-  end
-end
-
-Hanami::Router.new do
-  get "/flowers", to: "flowers#index" # it will map to Flowers::Index.new
-end
-```
-
-
-
 ### Implicit Not Found (404):
 
 ```ruby
@@ -309,312 +225,6 @@ router = Hanami::Router.new
 router.call(Rack::MockRequest.env_for("/unknown")).status # => 404
 ```
 
-### Controllers:
-
-`Hanami::Router` has a special convention for controllers naming.
-It allows to declare an action as an endpoint, with a special syntax: `<controller>#<action>`.
-
-```ruby
-Hanami::Router.new do
-  get "/", to: "welcome#index"
-end
-```
-
-In the example above, the router will look for the `Welcome::Index` action.
-
-#### Namespaces
-
-In applications where for maintainability or technical reasons, this convention
-can't work, `Hanami::Router` can accept a `:namespace` option, which defines the
-Ruby namespace where to look for actions.
-
-For instance, given a Hanami full stack application called `Bookshelf`, the
-controllers are available under `Bookshelf::Controllers`.
-
-```ruby
-Hanami::Router.new(namespace: Bookshelf::Controllers) do
-  get "/", to: "welcome#index"
-end
-```
-
-In the example above, the router will look for the `Bookshelf::Controllers::Welcome::Index` action.
-
-### RESTful Resource:
-
-```ruby
-Hanami::Router.new do
-  resource "identity"
-end
-```
-
-It will map:
-
-<table>
-  <tr>
-    <th>Verb</th>
-    <th>Path</th>
-    <th>Action</th>
-    <th>Name</th>
-    <th>Named Route</th>
-  </tr>
-  <tr>
-    <td>GET</td>
-    <td>/identity</td>
-    <td>Identity::Show</td>
-    <td>:show</td>
-    <td>:identity</td>
-  </tr>
-  <tr>
-    <td>GET</td>
-    <td>/identity/new</td>
-    <td>Identity::New</td>
-    <td>:new</td>
-    <td>:new_identity</td>
-  </tr>
-  <tr>
-    <td>POST</td>
-    <td>/identity</td>
-    <td>Identity::Create</td>
-    <td>:create</td>
-    <td>:identity</td>
-  </tr>
-  <tr>
-    <td>GET</td>
-    <td>/identity/edit</td>
-    <td>Identity::Edit</td>
-    <td>:edit</td>
-    <td>:edit_identity</td>
-  </tr>
-  <tr>
-    <td>PATCH</td>
-    <td>/identity</td>
-    <td>Identity::Update</td>
-    <td>:update</td>
-    <td>:identity</td>
-  </tr>
-  <tr>
-    <td>DELETE</td>
-    <td>/identity</td>
-    <td>Identity::Destroy</td>
-    <td>:destroy</td>
-    <td>:identity</td>
-  </tr>
-</table>
-
-If you don't need all the default endpoints, just do:
-
-```ruby
-Hanami::Router.new do
-  resource "identity", only: [:edit, :update]
-end
-
-#### which is equivalent to:
-
-Hanami::Router.new do
-  resource "identity", except: [:show, :new, :create, :destroy]
-end
-```
-
-
-If you need extra endpoints:
-
-```ruby
-router = Hanami::Router.new do
-           resource "identity" do
-             member do
-               get "avatar"           # maps to Identity::Avatar
-             end
-
-             collection do
-               get "authorizations"   # maps to Identity::Authorizations
-             end
-           end
-         end
-
-router.path(:avatar_identity)         # => "/identity/avatar"
-router.path(:authorizations_identity) # => "/identity/authorizations"
-```
-
-
-Configure controller:
-
-```ruby
-router = Hanami::Router.new do
-  resource "profile", controller: "identity"
-end
-
-router.path(:profile) # => "/profile" # Will route to Identity::Show
-```
-
-#### Nested Resources
-
-We can nest resource(s):
-
-```ruby
-router = Hanami::Router.new do
-           resource :identity do
-             resource  :avatar
-             resources :api_keys
-           end
-         end
-
-router.path(:identity_avatar)       # => "/identity/avatar"
-router.path(:new_identity_avatar)   # => "/identity/avatar/new"
-router.path(:edit_identity_avatar)  # => "/identity/avatar/new"
-
-router.path(:identity_api_keys)            # => "/identity/api_keys"
-router.path(:identity_api_key, id: 1)      # => "/identity/api_keys/:id"
-router.path(:new_identity_api_key)         # => "/identity/api_keys/new"
-router.path(:edit_identity_api_key, id: 1) # => "/identity/api_keys/:id/edit"
-```
-
-
-
-### RESTful Resources:
-
-```ruby
-Hanami::Router.new do
-  resources "flowers"
-end
-```
-
-It will map:
-
-<table>
-  <tr>
-    <th>Verb</th>
-    <th>Path</th>
-    <th>Action</th>
-    <th>Name</th>
-    <th>Named Route</th>
-  </tr>
-  <tr>
-    <td>GET</td>
-    <td>/flowers</td>
-    <td>Flowers::Index</td>
-    <td>:index</td>
-    <td>:flowers</td>
-  </tr>
-  <tr>
-    <td>GET</td>
-    <td>/flowers/:id</td>
-    <td>Flowers::Show</td>
-    <td>:show</td>
-    <td>:flower</td>
-  </tr>
-  <tr>
-    <td>GET</td>
-    <td>/flowers/new</td>
-    <td>Flowers::New</td>
-    <td>:new</td>
-    <td>:new_flower</td>
-  </tr>
-  <tr>
-    <td>POST</td>
-    <td>/flowers</td>
-    <td>Flowers::Create</td>
-    <td>:create</td>
-    <td>:flowers</td>
-  </tr>
-  <tr>
-    <td>GET</td>
-    <td>/flowers/:id/edit</td>
-    <td>Flowers::Edit</td>
-    <td>:edit</td>
-    <td>:edit_flower</td>
-  </tr>
-  <tr>
-    <td>PATCH</td>
-    <td>/flowers/:id</td>
-    <td>Flowers::Update</td>
-    <td>:update</td>
-    <td>:flower</td>
-  </tr>
-  <tr>
-    <td>DELETE</td>
-    <td>/flowers/:id</td>
-    <td>Flowers::Destroy</td>
-    <td>:destroy</td>
-    <td>:flower</td>
-  </tr>
-</table>
-
-
-```ruby
-router.path(:flowers)             # => "/flowers"
-router.path(:flower, id: 23)      # => "/flowers/23"
-router.path(:edit_flower, id: 23) # => "/flowers/23/edit"
-```
-
-
-
-If you don't need all the default endpoints, just do:
-
-```ruby
-Hanami::Router.new do
-  resources "flowers", only: [:new, :create, :show]
-end
-
-#### which is equivalent to:
-
-Hanami::Router.new do
-  resources "flowers", except: [:index, :edit, :update, :destroy]
-end
-```
-
-
-If you need extra endpoints:
-
-```ruby
-router = Hanami::Router.new do
-           resources "flowers" do
-             member do
-               get "toggle" # maps to Flowers::Toggle
-             end
-
-             collection do
-               get "search" # maps to Flowers::Search
-             end
-           end
-         end
-
-router.path(:toggle_flower, id: 23) # => "/flowers/23/toggle"
-router.path(:search_flowers)        # => "/flowers/search"
-```
-
-
-Configure controller:
-
-```ruby
-router = Hanami::Router.new do
-           resources "blossoms", controller: "flowers"
-         end
-
-router.path(:blossom, id: 23) # => "/blossoms/23" # Will route to Flowers::Show
-```
-
-#### Nested Resources
-
-We can nest resource(s):
-
-```ruby
-router = Hanami::Router.new do
-           resources :users do
-             resource  :avatar
-             resources :favorites
-           end
-         end
-
-router.path(:user_avatar,      user_id: 1)  # => "/users/1/avatar"
-router.path(:new_user_avatar,  user_id: 1)  # => "/users/1/avatar/new"
-router.path(:edit_user_avatar, user_id: 1)  # => "/users/1/avatar/edit"
-
-router.path(:user_favorites, user_id: 1)             # => "/users/1/favorites"
-router.path(:user_favorite, user_id: 1, id: 2)       # => "/users/1/favorites/2"
-router.path(:new_user_favorites, user_id: 1)         # => "/users/1/favorites/new"
-router.path(:edit_user_favorites, user_id: 1, id: 2) # => "/users/1/favorites/2/edit"
-```
-
 ### Body Parsers
 
 Rack ignores request bodies unless they come from a form submission.
@@ -745,6 +355,6 @@ __Hanami::Router__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2019 Luca Guidi – Released under MIT License
+Copyright © 2014-2020 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-router`).