Implement a better approach to the router

Author: Giorgi Kavrelishvili

README.md

@@ -43,13 +43,15 @@ This project exists due to the fact that Kemal lacks one crucial part of a frame
 
 Add this to your application's `application.cr`:
 
-```ruby
+```crystal
 require "grip"
 
-class IndexController < Grip::Controllers::Http
+class IndexController
+  include Grip::Controllers::HTTP
+
   def get(context : Context) : Context
     context
-      .put_status(200) # Assign the status code to 200 OK.
+      .put_status(200) # Assign the status code as 200 OK.
       .json({"id" => 1}) # Respond with JSON content.
       .halt # Close the connection.
   end
@@ -68,23 +70,30 @@ class IndexController < Grip::Controllers::Http
 end
 
 class Application < Grip::Application
-  def initialize(environment : String)
+  def initialize
     # By default the environment is set to "development".
-    super(environment)
+    super(
+      environment: ENV["ENVIRONMENT"]? || "production"
+      handlers: [
+        Grip::Handlers::Log.new,
+        Grip::Handlers::HTTP.new
+      ] of HTTP::Handler
+    )
+
+    routes()
+  end
 
+  def routes()
     scope "/api" do
       scope "/v1" do
         get "/", IndexController
         get "/:id", IndexController, as: :index
       end
     end
-
-    # Enable request/response logging.
-    router.insert(0, Grip::Handlers::Log.new)
   end
 end
 
-app = Application.new(environment: "development")
+app = Application.new
 app.run
 ```
 
@@ -107,7 +116,7 @@ shards install
 ## API Reference
 
 Documentation can be found on the [official website of the Grip framework](https://grip-framework.github.io/docs/) or
-the [CrystalDoc website](https://crystaldoc.info/github/grip-framework/grip/v2.0.3/index.html).
+the [CrystalDoc website](https://crystaldoc.info/github/grip-framework/grip/v4.0.0/index.html).
 
 ## Contribute
 

shard.yml

@@ -1,5 +1,5 @@
 name: grip
-version: 3.0.2
+version: 4.0.0
 
 authors:
   - Grip and its Contributors <https://github.com/grip-framework/>

spec/context_spec.cr

@@ -3,7 +3,7 @@ require "./spec_helper"
 describe "Context" do
   context "headers" do
     it "sets content type" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/content_type", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.response.headers.merge!({"Content-Type" => "application/json"})
         context
@@ -15,7 +15,7 @@ describe "Context" do
     end
 
     it "parses headers" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/headers", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         name = context.request.headers["name"]
         context.response.print("Hello #{name}")
@@ -30,7 +30,7 @@ describe "Context" do
     end
 
     it "sets response headers" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/response_headers", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.response.headers.add "Accept-Language", "ge"
         context
@@ -45,7 +45,7 @@ describe "Context" do
   context "methods" do
     it "sends a local file" do
       file_path = File.join(__DIR__, "./fixtures/index.html")
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.send_file(file_path).halt
       end
@@ -57,9 +57,9 @@ describe "Context" do
     end
 
     it "has binary() method with octet-stream" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
-        context.binary(10).halt
+        context.binary("10").halt
       end
 
       request = HTTP::Request.new("GET", "/")
@@ -69,7 +69,7 @@ describe "Context" do
     end
 
     it "encodes text in utf-8" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.text("👋🏼 grip").halt
       end
@@ -81,7 +81,7 @@ describe "Context" do
     end
 
     it "encodes html in utf-8" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.html("👋🏼 grip").halt
       end
@@ -95,7 +95,7 @@ describe "Context" do
 
   context "methods" do
     it "allows overriding text() content type" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.text("👋🏼 grip", "text/html").halt
       end
@@ -106,7 +106,7 @@ describe "Context" do
     end
 
     it "allows overriding json() content type" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.json({:message => "👋🏼 grip"}, "application/json").halt
       end
@@ -117,7 +117,7 @@ describe "Context" do
     end
 
     it "allows overriding html() content type" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.html("👋🏼 grip", "text/html").halt
       end
@@ -128,9 +128,9 @@ describe "Context" do
     end
 
     it "allows overriding binary() content type" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
-        context.binary(10, "multipart/encrypted").halt
+        context.binary("10", "multipart/encrypted").halt
       end
 
       request = HTTP::Request.new("GET", "/")
@@ -141,7 +141,7 @@ describe "Context" do
 
   context "cookies" do
     it "sets cookie" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/cookies", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.put_resp_cookie(HTTP::Cookie.new("Foo", "Bar")).halt
       end
@@ -154,7 +154,7 @@ describe "Context" do
     end
 
     it "sets string cookie" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/cookies", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.put_resp_cookie("Foo", "Bar").halt
       end
@@ -167,7 +167,7 @@ describe "Context" do
     end
 
     it "sets multiple cookie" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/cookies", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.put_resp_cookie("Foo", "Bar").put_resp_cookie("Qux", "Baz").halt
       end
@@ -181,7 +181,7 @@ describe "Context" do
     end
 
     it "overrides cookie" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/cookies", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.put_resp_cookie("Foo", "Bar").put_resp_cookie("Foo", "Baz").halt
       end
@@ -194,7 +194,7 @@ describe "Context" do
     end
 
     it "gets correkt cookie" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/get_cookie", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         cookie = context.get_req_cookie("Foo")
         if cookie
@@ -213,7 +213,7 @@ describe "Context" do
     end
 
     it "gets nil for not existing cookie" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/get_cookie", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         cookie = context.get_req_cookie("Baz")
         if cookie
@@ -235,7 +235,7 @@ describe "Context" do
 
   context "redirects" do
     it "redirects to home page when called without arguments" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/redirect_to_home", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.redirect
       end
@@ -248,7 +248,7 @@ describe "Context" do
     end
 
     it "redirects to another url with status code 301 using keyword arguments" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/redirect_to_another_url", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.redirect(url: "/another_url", status_code: 301)
       end
@@ -261,7 +261,7 @@ describe "Context" do
     end
 
     it "redirects to another url with status code 308 using positional arguments" do
-      http_handler = Grip::Routers::Http.new
+      http_handler = Grip::Handlers::HTTP.new
       http_handler.add_route "GET", "/redirect_to_another_url_with_308", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
         context.redirect("/another_url", HTTP::Status::PERMANENT_REDIRECT)
       end

spec/dsl_test.cr spec/dsl_spec.crspec/dsl_test.cr renamed to spec/dsl_spec.cr

@@ -6,17 +6,17 @@ describe "Grip::Handlers::Exception" do
     io = IO::Memory.new
     response = HTTP::Server::Response.new(io)
     context = HTTP::Server::Context.new(request, response)
-    Grip::Handlers::Exception.new(environment: "test").call(context)
+    Grip::Handlers::Exception.new.call(context)
     response.close
     io.rewind
     response = HTTP::Client::Response.from_io(io, decompress: false)
     response.status_code.should eq 404
   end
 
   it "renders custom error" do
-    error_handler = Grip::Handlers::Exception.new(environment: "test")
+    error_handler = Grip::Handlers::Exception.new
     error_handler.handlers[Exceptions::Forbidden.name] = ForbiddenController.new
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
 
     http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       raise Exceptions::Forbidden.new

spec/exception_handler_spec.cr

@@ -1,8 +1,8 @@
 require "./spec_helper"
 
-describe "Grip::Routers::Http" do
+describe "Grip::Handlers::HTTP" do
   it "routes" do
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
     http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       context.response.print("hello")
       context
@@ -16,7 +16,7 @@ describe "Grip::Routers::Http" do
   it "routes with long response body" do
     long_response_body = "string" * 10_000
 
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
     http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       context.response.print(long_response_body)
       context
@@ -28,7 +28,7 @@ describe "Grip::Routers::Http" do
   end
 
   it "routes request with query string" do
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
     http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       context.response.print("hello #{context.fetch_query_params.["message"]}")
       context
@@ -39,7 +39,7 @@ describe "Grip::Routers::Http" do
   end
 
   it "routes request with multiple query strings" do
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
     http_handler.add_route "GET", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       context.response.print("hello #{context.fetch_query_params.["message"]} time #{context.fetch_query_params.["time"]}")
       context
@@ -51,7 +51,7 @@ describe "Grip::Routers::Http" do
   end
 
   it "route parameter has more precedence than query string arguments" do
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
     http_handler.add_route "GET", "/:message", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       context.response.print("hello #{context.fetch_path_params.["message"]}")
       context
@@ -62,7 +62,7 @@ describe "Grip::Routers::Http" do
   end
 
   it "parses simple JSON body" do
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
     http_handler.add_route "POST", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       name = context.fetch_json_params.["name"]
       age = context.fetch_json_params.["age"]
@@ -82,7 +82,7 @@ describe "Grip::Routers::Http" do
   end
 
   it "parses JSON with string array" do
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
     http_handler.add_route "POST", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       skills = context.fetch_json_params.["skills"].as(Array)
       context.response.print("Skills #{skills.each.join(',')}")
@@ -101,7 +101,7 @@ describe "Grip::Routers::Http" do
   end
 
   it "parses JSON with json object array" do
-    http_handler = Grip::Routers::Http.new
+    http_handler = Grip::Handlers::HTTP.new
     http_handler.add_route "POST", "/", ExampleController.new, [:none], ->(context : HTTP::Server::Context) do
       skills = context.fetch_json_params.["skills"].as(Array)
       skills_from_languages = skills.map(&.["language"])

spec/http_router_spec.cr

@@ -14,20 +14,20 @@ describe "ParameterBox" do
   end
 
   it "parses url params" do
-    grip = Grip::Routers::Http.new
-    grip.add_route "POST", "/hello/:name", ExampleController.new, [] of Symbol, nil
+    http_handler = Grip::Handlers::HTTP.new
+    http_handler.add_route "POST", "/hello/:name", ExampleController.new, [] of Symbol, nil
     request = HTTP::Request.new("POST", "/hello/crystal")
-    _context = create_request_and_return_io_and_context(grip, request)[1]
-    url_params = Grip::Parsers::ParameterBox.new(request, grip.find_route(request.method, request.path).params).url
+    _context = create_request_and_return_io_and_context(http_handler, request)[1]
+    url_params = Grip::Parsers::ParameterBox.new(request, http_handler.find_route(request.method, request.path).params).url
     url_params["name"].should eq "crystal"
   end
 
   it "decodes url params" do
-    grip = Grip::Routers::Http.new
-    grip.add_route "POST", "/hello/:email/:money/:spanish", ExampleController.new, [] of Symbol, nil
+    http_handler = Grip::Handlers::HTTP.new
+    http_handler.add_route "POST", "/hello/:email/:money/:spanish", ExampleController.new, [] of Symbol, nil
     request = HTTP::Request.new("POST", "/hello/sam%2Bspec%40gmail.com/%2419.99/a%C3%B1o")
-    _context = create_request_and_return_io_and_context(grip, request)[1]
-    url_params = Grip::Parsers::ParameterBox.new(request, grip.find_route(request.method, request.path).params).url
+    _context = create_request_and_return_io_and_context(http_handler, request)[1]
+    url_params = Grip::Parsers::ParameterBox.new(request, http_handler.find_route(request.method, request.path).params).url
     url_params["email"].should eq "sam+spec@gmail.com"
     url_params["money"].should eq "$19.99"
     url_params["spanish"].should eq "año"