tynn 1.4.0 → 2.0.0.alpha

data/lib/tynn/json.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 require "json"
 
 class Tynn
-  # Public: Adds helper methods for json generation.
-  #
-  # Examples
+  # Adds helper methods for JSON generation.
   #
   #   require "tynn"
   #   require "tynn/json"
@@ -11,16 +11,9 @@ class Tynn
   #   Tynn.plugin(Tynn::JSON)
   #
   module JSON
-    CONTENT_TYPE = "application/json".freeze
-
     module InstanceMethods
-      # Public: Calls +to_json+ on +data+ and writes the generated \JSON
-      # object into the response body. Also, It automatically sets the
-      # +Content-Type+ header to +application/json+.
-      #
-      # data - Any object that responds to +to_json+.
-      #
-      # Examples
+      # Generates a JSON document from <tt>data</tt> and writes it to the response body.
+      # It automatically sets the <tt>Content-Type</tt> header to <tt>application/json</tt>.
       #
       #   Tynn.define do
       #     on("hash") do
@@ -30,16 +23,12 @@ class Tynn
       #     on("array") do
       #       json([1, 2, 3])
       #     end
-      #
-      #     on("to_json") do
-      #       json(Model.first)
-      #     end
       #   end
       #
       def json(data)
-        res.headers[Rack::CONTENT_TYPE] = Tynn::JSON::CONTENT_TYPE
+        res.headers["Content-Type"] = "application/json"
 
-        res.write(data.to_json)
+        res.write(::JSON.generate(data))
       end
     end
   end

data/lib/tynn/render.rb

@@ -1,48 +1,52 @@
+# frozen_string_literal: true
+
 require "tilt"
 
 class Tynn
   module Render
     def self.setup(app, options = {}) # :nodoc:
-      app.settings.update(
+      app.set(:render, {
         layout: options.fetch(:layout, "layout"),
         views: options.fetch(:views, File.expand_path("views", Dir.pwd)),
         engine: options.fetch(:engine, "erb"),
         engine_opts: {
           escape_html: true
-        }.merge!(options.fetch(:options, {}))
-      )
+        }.merge(options.fetch(:options, {}))
+      })
     end
 
     module InstanceMethods
-      def render(template, locals = {}, layout = self.class.settings[:layout])
+      def render(template, locals = {}, layout = self.class.settings.dig(:render, :layout))
         res.headers[Rack::CONTENT_TYPE] ||= Syro::Response::DEFAULT
 
         res.write(view(template, locals, layout))
       end
 
-      def view(template, locals = {}, layout = self.class.settings[:layout])
-        return partial(layout, locals.merge(content: partial(template, locals)))
+      def view(template, locals = {}, layout = self.class.settings.dig(:render, :layout))
+        partial(layout, locals.merge(content: partial(template, locals)))
       end
 
       def partial(template, locals = {})
-        return tilt(template_path(template), locals, self.class.settings[:engine_opts])
+        tilt(template_path(template), locals, self.class.settings.dig(:render, :engine_opts))
       end
 
       private
 
       def tilt(file, locals = {}, opts = {})
-        return tilt_cache.fetch(file) { Tilt.new(file, 1, opts) }.render(self, locals)
+        tilt_cache.fetch(file) {
+          Tilt.new(file, 1, opts)
+        }.render(self, locals.merge(app: self))
       end
 
       def tilt_cache
-        return Thread.current[:tilt_cache] ||= Tilt::Cache.new
+        Thread.current[:tilt_cache] ||= Tilt::Cache.new
       end
 
       def template_path(template)
-        dir = self.class.settings[:views]
-        ext = self.class.settings[:engine]
+        dir = self.class.settings.dig(:render, :views)
+        ext = self.class.settings.dig(:render, :engine)
 
-        return File.join(dir, "#{ template }.#{ ext }")
+        File.join(dir, "#{ template }.#{ ext }")
       end
     end
   end

data/lib/tynn/request.rb

@@ -1,11 +1,10 @@
+# frozen_string_literal: true
+
 class Tynn
-  # Public: It provides convenience methods for pulling out information
-  # from a request.
-  #
-  # Examples
+  # It provides convenience methods for pulling out information from a request.
   #
   #   env = {
-  #     "REQUEST_METHOD" => "GET"
+  #     "REQUEST_METHOD" => "GET",
   #     "QUERY_STRING"   => "email=me@tynn.xyz"
   #   }
   #
@@ -13,41 +12,58 @@ class Tynn
   #
   #   req.get?  # => true
   #   req.post? # => false
-  #
   #   req.params  # => { "email" => "me@tynn.xyz" }
-  #   req[:email] # => "me@tynn.xyz"
   #
   class Request < Rack::Request
-    # Public: Returns the value of the +key+ param.
-    #
-    # key - Any object that responds to +to_s+.
-    #
-    # Examples
-    #
-    #   req.params
-    #   # => { "username" => "bob" }
-    #
-    #   req[:username]  # => "bob"
-    #   req["username"] # => "bob"
-    #
-    # Signature
-    #
-    #   [](key)
-    #
-    # Inherited by Rack::Request.
-
-    # Public: Returns a Hash of parameters. Includes data from the query
-    # string and the response body.
-    #
-    # Examples
-    #
-    #   req.params
-    #   # => { "user" => { "username" => "bob" } }
-    #
-    # Signature
-    #
-    #   params()
-    #
-    # Inherited by Rack::Request.
+    class Headers
+      CGI_VARIABLES = Set.new(%w(
+        AUTH_TYPE
+        CONTENT_LENGTH
+        CONTENT_TYPE
+        GATEWAY_INTERFACE
+        HTTPS
+        PATH_INFO
+        PATH_TRANSLATED
+        QUERY_STRING
+        REMOTE_ADDR
+        REMOTE_HOST
+        REMOTE_IDENT
+        REMOTE_USER
+        REQUEST_METHOD
+        SCRIPT_NAME
+        SERVER_NAME
+        SERVER_PORT
+        SERVER_PROTOCOL
+        SERVER_SOFTWARE
+      )).freeze
+
+      def initialize(req)
+        @req = req
+      end
+
+      def [](key)
+        @req.env[transform_key(key)]
+      end
+
+      def fetch(key, *args, &block)
+        @req.env.fetch(transform_key(key), *args, &block)
+      end
+
+      def key?(key)
+        @req.env.key?(transform_key(key))
+      end
+
+      private
+
+      def transform_key(key)
+        key = key.upcase.tr("-", "_")
+        key = "HTTP_" + key unless CGI_VARIABLES.include?(key)
+        key
+      end
+    end
+
+    def headers
+      @headers ||= Headers.new(self)
+    end
   end
 end

data/lib/tynn/response.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 class Tynn
-  # Public: It provides convenience methods to construct a Rack response.
-  #
-  # Examples
+  # It provides convenience methods to construct a Rack response.
   #
   #   res = Tynn::Response.new
   #
@@ -13,185 +13,45 @@ class Tynn
   #   # => [200, { "Content-Type" => "text/html", "Content-Length" => 3 }, ["foo"]]
   #
   class Response < Syro::Response
-    # Public: Initializes a new response object.
-    #
-    # headers - A Hash of initial headers. Defaults to <tt>{}</tt>.
-    #
-    # Examples
-    #
-    #   Tynn::Response.new.headers
-    #   # => {}
-    #
-    #   Tynn::Response.new("Content-Type" => "text/plain").headers
-    #   # => { "Content-Type" => "text/plain" }
-    #
-    # Signature
-    #
-    #   new(headers = {})
-    #
-    # Inherited by Syro::Response.
-
-    # Public: Returns the response header corresponding to +key+.
-    #
-    # key - A String HTTP header field name.
-    #
-    # Examples
-    #
-    #     res["Content-Type"]   # => "text/html"
-    #     res["Content-Length"] # => "42"
-    #
-    # Signature
-    #
-    #   [](key)
-    #
-    # Inherited by Syro::Response.
-
-    # Public: Sets the given +value+ with the header corresponding to +key+.
-    #
-    # key   - A String HTTP header field name.
-    # value - A String HTTP header field value.
-    #
-    # Examples
-    #
-    #     res["Content-Type"] = "application/json"
-    #     res["Content-Type"] # => "application/json"
-    #
-    # Signature
-    #
-    #   []=(key, value)
-    #
-    # Inherited by Syro::Response.
-
-    # Public: Returns the body of the response.
-    #
-    # Examples
-    #
-    #   res.body
-    #   # => []
-    #
-    #   res.write("there is")
-    #   res.write("no try")
-    #
-    #   res.body
-    #   # => ["there is", "no try"]
-    #
-    # Signature
-    #
-    #   body()
-    #
-    # Inherited by Syro::Response.
-
-    # Public: Returns an Array with three elements: the status, headers
-    # and body. If the status is not set, the status is set to +404+ if
-    # empty body, otherwise the status is set to +200+ and updates the
-    # +Content-Type+ header to +text/html+.
-    #
-    # Examples
-    #
-    #   res.status = 200
-    #   res.finish
-    #   # => [200, {}, []]
+    # Sets a cookie into the response.
     #
-    #   res.status = nil
-    #   res.finish
-    #   # => [404, {}, []]
+    #   res.set_cookie("foo", "bar")
+    #   res["Set-Cookie"] # => "foo=bar"
     #
-    #   res.status = nil
-    #   res.write("yo")
-    #   res.finish
-    #   # => [200, { "Content-Type" => "text/html", "Content-Length" => 2 }, ["yo"]]
+    #   res.set_cookie("foo2", "bar2")
+    #   res["Set-Cookie"] # => "foo=bar\nfoo2=bar2"
     #
-    # Signature
+    #   res.set_cookie("bar", "bar", {
+    #     domain: ".example.com",
+    #     path: "/",
+    #     # max_age: 0,
+    #     # expires: Time.now + 10_000,
+    #     secure: true,
+    #     httponly: true,
+    #     same_site: :Lax
+    #   })
     #
-    #   finish()
+    #   res["Set-Cookie"].split("\n").last
+    #   # => "bar=bar; domain=.example.com; path=/; secure; HttpOnly; SameSite=Lax
     #
-    # Inherited by Syro::Response.
-
-    # Public: Returns a Hash with the response headers.
-    #
-    # Examples
-    #
-    #   res.headers
-    #   # => { "Content-Type" => "text/html", "Content-Length" => "42" }
-    #
-    # Signature
-    #
-    #   headers()
-    #
-    # Inherited by Syro::Response.
-
-    # Public: Sets the +Location+ header to +url+ and updates the status
-    # to +status+.
-    #
-    # url    - A String URL (relative or absolute) to redirect to.
-    # status - An Integer status code. Defaults to +302+.
-    #
-    # Examples
-    #
-    #   res.redirect("/path")
-    #
-    #   res["Location"] # => "/path"
-    #   res.status      # => 302
-    #
-    #   res.redirect("http://tynn.xyz", 303)
-    #
-    #   res["Location"] # => "http://tynn.xyz"
-    #   res.status      # => 303
-    #
-    # Signature
-    #
-    #   redirect(url, status = 302)
-    #
-    # Inherited by Syro::Response.
-
-    # Public: Returns the status of the response.
+    # *NOTE.* This method doesn't sign and/or encrypt the value of the cookie.
     #
-    # Examples
-    #
-    #     res.status # => 200
-    #
-    # Signature
-    #
-    #   status()
-    #
-    # Inherited by Syro::Response.
+    def set_cookie(key, value, options = {})
+      Rack::Utils.set_cookie_header!(headers, key, options.merge(value: value))
+    end
 
-    # Public: Sets the status of the response.
-    #
-    # status - An Integer HTTP status code.
-    #
-    # Examples
-    #
-    #   res.status = 200
-    #
-    # Signature
-    #
-    #   status=(status)
-    #
-    # Inherited by Syro::Response.
-
-    # Public: Appends +str+ to the response body and updates the
-    # +Content-Length+ header.
-    #
-    # str - Any object that responds to +to_s+.
-    #
-    # Examples
-    #
-    #   res.body # => []
-    #
-    #   res.write("foo")
-    #   res.write("bar")
-    #
-    #   res.body
-    #   # => ["foo", "bar"]
-    #
-    #   res["Content-Length"]
-    #   # => 6
+    # Deletes cookie by <tt>key</tt>.
     #
-    # Signature
+    #   res.set_cookie("foo", "bar")
+    #   res["Set-Cookie"]
+    #   # => "foo=bar"
     #
-    #   write(str)
+    #   res.delete_cookie("foo")
+    #   res["Set-Cookie"]
+    #   # => "foo=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
     #
-    # Inherited by Syro::Response.
+    def delete_cookie(key, options = {})
+      Rack::Utils.delete_cookie_header!(headers, options)
+    end
   end
 end

data/lib/tynn/secure_headers.rb

@@ -1,44 +1,41 @@
+# frozen_string_literal: true
+
 class Tynn
-  # Public: Adds security related HTTP headers.
+  # Adds the following security related HTTP headers:
   #
-  # Examples
+  # [X-Content-Type-Options]
+  #   Prevents IE and Chrome from {content type sniffing}[https://msdn.microsoft.com/library/gg622941(v=vs.85).aspx].
+  #   Defaults to <tt>"nosniff"</tt>.
   #
-  #   require "tynn"
-  #   require "tynn/secure_headers"
-  #
-  #   Tynn.plugin(Tynn::SecureHeaders)
-  #
-  # This plugin applies the following headers:
-  #
-  # *X-Content-Type-Options:* <tt>"nosniff"</tt>
+  # [X-Frame-Options]
+  #   Provides {Clickjacking}[https://www.owasp.org/index.php/Clickjacking]
+  #   protection. Defaults to <tt>"SAMEORIGIN"</tt>.
   #
-  # Prevents IE and Chrome from
-  # {content type sniffing}[https://msdn.microsoft.com/library/gg622941(v=vs.85).aspx]
+  # [X-Permitted-Cross-Domain-Policies]
+  #   Restricts Adobe Flash Player's access to data. Defaults to <tt>"none"</tt>.
   #
-  # *X-Frame-Options:* <tt>"SAMEORIGIN"</tt>
+  # [X-XSS-Protection]
+  #   Enables the XSS protection filter built into IE, Chrome and Safari.
+  #   This filter is usually enabled by default, the use of this header is to
+  #   re-enable it if it was turned off by the user. Defaults to <tt>"1; mode=block"</tt>.
   #
-  # Provides {Clickjacking}[https://www.owasp.org/index.php/Clickjacking]
-  # protection.
+  # <tt></tt>
   #
-  # *X-Permitted-Cross-Domain-Policies:* <tt>"none"</tt>
-  #
-  # Restricts Adobe Flash Player's access to data.
-  #
-  # *X-XSS-Protection:* <tt>"1; mode=block"</tt>
+  #   require "tynn"
+  #   require "tynn/secure_headers"
   #
-  # Enables the XSS protection filter built into IE, Chrome and Safari.
-  # This filter is usually enabled by default, the use of this header
-  # is to re-enable it if it was turned off by the user.
+  #   Tynn.plugin(Tynn::SecureHeaders)
   #
   module SecureHeaders
-    # Internal: Sets the default HTTP secure headers.
-    def self.setup(app)
-      app.settings[:default_headers].update(
-        "X-Content-Type-Options" => "nosniff",
-        "X-Frame-Options" => "SAMEORIGIN",
-        "X-Permitted-Cross-Domain-Policies" => "none",
-        "X-XSS-Protection" => "1; mode=block"
-      )
+    HEADERS = {
+      "X-Content-Type-Options" => "nosniff",
+      "X-Frame-Options" => "SAMEORIGIN",
+      "X-Permitted-Cross-Domain-Policies" => "none",
+      "X-XSS-Protection" => "1; mode=block"
+    }.freeze # :nodoc:
+
+    def self.setup(app) # :nodoc:
+      app.set!(:default_headers, HEADERS.merge(app.default_headers))
     end
   end
 end