tynn 1.0.0.rc2 → 1.0.0.rc3

data/lib/tynn/json.rb

@@ -1,42 +1,46 @@
 require "json"
 
 class Tynn
-  # Adds helper methods for json generation.
+  # Public: Adds helper methods for json generation.
   #
-  # ```
-  # require "tynn"
-  # require "tynn/json"
+  # Examples
   #
-  # Tynn.helpers(Tynn::JSON)
-  # ```
+  #   require "tynn"
+  #   require "tynn/json"
+  #
+  #   Tynn.helpers(Tynn::JSON)
   #
   module JSON
-    JSON_CONTENT_TYPE = "application/json".freeze # :nodoc:
+    CONTENT_TYPE = "application/json".freeze
 
-    # 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`.
-    #
-    # ```
-    # Tynn.define do
-    #   on("hash") do
-    #     json(foo: "bar")
-    #   end
-    #
-    #   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] = JSON_CONTENT_TYPE
+    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
+      #
+      #   Tynn.define do
+      #     on("hash") do
+      #       json(foo: "bar")
+      #     end
+      #
+      #     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.write(data.to_json)
+        res.write(data.to_json)
+      end
     end
   end
 end

data/lib/tynn/matchers.rb

@@ -1,59 +1,61 @@
 class Tynn
-  # Adds extra matchers to Tynn.
+  # Public: Adds extra matchers to Tynn.
   #
-  # ```
-  # require "tynn"
-  # require "tynn/matchers"
+  # Examples
   #
-  # Tynn.helpers(Tynn::Matchers)
-  # ```
+  #   require "tynn"
+  #   require "tynn/matchers"
+  #
+  #   Tynn.helpers(Tynn::Matchers)
   #
   module Matchers
-    # A catch-all matcher.
-    #
-    # ```
-    # Tynn.define do
-    #   authenticated? do
-    #     # ...
-    #   end
-    #
-    #   default do # on true
-    #     # ...
-    #   end
-    # end
-    # ```
-    #
-    # :call-seq: default(&block)
-    #
-    def default
-      yield
+    module InstanceMethods
+      # Public: A catch-all matcher.
+      #
+      # Examples
+      #
+      #   Tynn.define do
+      #     authenticated? do
+      #       # ...
+      #     end
+      #
+      #     default do # on true
+      #       # ...
+      #     end
+      #   end
+      #
+      # :call-seq: default(&block)
+      #
+      def default
+        yield
 
-      halt(res.finish)
-    end
+        halt(res.finish)
+      end
 
-    # Match if the given `key` is present in `req.params`.
-    #
-    # ```
-    # Tynn.define do
-    #   param(:user) do |params|
-    #     user = User.create(params)
-    #
-    #     # ...
-    #   end
-    #
-    #   default do
-    #     res.write("missing user param")
-    #   end
-    # end
-    # ```
-    #
-    # :call-seq: param(key, &block)
-    #
-    def param(key)
-      if (v = req[key]) && !v.empty?
-        yield(v)
+      # Public: Match if the given +key+ is present in +req.params+.
+      #
+      # Examples
+      #
+      #   Tynn.define do
+      #     param(:user) do |params|
+      #       user = User.create(params)
+      #
+      #       # ...
+      #     end
+      #
+      #     default do
+      #       res.write("missing user param")
+      #     end
+      #   end
+      #
+      # :call-seq: param(key, &block)
+      #
+      def param(key)
+        if (v = req[key]) && !v.empty?
+          yield(v)
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
     end
   end

data/lib/tynn/not_found.rb

@@ -1,18 +1,20 @@
 class Tynn
   module NotFound
-    def call(*) # :nodoc:
-      result = super
+    module InstanceMethods
+      def call(*) # :nodoc:
+        result = super
 
-      if result[0] == 404 && result[2].empty?
-        not_found
+        if result[0] == 404 && result[2].empty?
+          not_found
 
-        return res.finish
-      else
-        return result
+          return res.finish
+        else
+          return result
+        end
       end
-    end
 
-    def not_found # :nodoc:
+      def not_found # :nodoc:
+      end
     end
   end
 end

data/lib/tynn/protection.rb

@@ -1,41 +1,52 @@
 require_relative "secure_headers"
 
 class Tynn
-  # Adds security measures against common attacks.
+  # Public: Adds security measures against common attacks.
   #
-  # ```
-  # require "tynn"
-  # require "tynn/protection"
+  # Examples
   #
-  # Tynn.helpers(Tynn::Protection)
-  # ```
+  #   require "tynn"
+  #   require "tynn/protection"
+  #
+  #   Tynn.helpers(Tynn::Protection)
   #
   # If you are using SSL/TLS (HTTPS), it's recommended to set
-  # the `:ssl` option:
+  # the +:ssl+ option:
+  #
+  # Examples
   #
-  # ```
-  # require "tynn"
-  # require "tynn/protection"
+  #   require "tynn"
+  #   require "tynn/protection"
   #
-  # Tynn.helpers(Tynn::Protection, ssl: true)
-  # ```
+  #   Tynn.helpers(Tynn::Protection, ssl: true)
   #
   # By default, it includes the following security helpers:
   #
-  # * Tynn::SecureHeaders
+  # - Tynn::SecureHeaders
   #
-  # If the `:ssl` option is `true`, includes:
+  # If the +:ssl+ option is +true+, includes:
   #
-  # * Tynn::SSL
+  # - Tynn::HSTS
+  #
+  # - Tynn::ForceSSL
   #
   module Protection
-    def self.setup(app, ssl: false, hsts: {}) # :nodoc:
+    # Internal: Configures security related extensions.
+    def self.setup(app, ssl: false, force_ssl: ssl, hsts: {})
       app.helpers(Tynn::SecureHeaders)
 
       if ssl
-        require_relative "ssl"
+        app.settings[:ssl] = true
+
+        require_relative "hsts"
+
+        app.helpers(Tynn::HSTS, hsts)
+      end
+
+      if force_ssl
+        require_relative "force_ssl"
 
-        app.helpers(Tynn::SSL, hsts: hsts)
+        app.helpers(Tynn::ForceSSL)
       end
     end
   end

data/lib/tynn/render.rb

@@ -8,41 +8,42 @@ class Tynn
         views: options.fetch(:views, File.expand_path("views", Dir.pwd)),
         engine: options.fetch(:engine, "erb"),
         engine_opts: {
-          default_encoding: Encoding.default_external,
-          outvar: "@_output"
+          escape_html: true
         }.merge!(options.fetch(:options, {}))
       )
     end
 
-    def render(template, locals = {}, layout = settings[:layout])
-      res.headers[Rack::CONTENT_TYPE] ||= Syro::Response::DEFAULT
+    module InstanceMethods
+      def render(template, locals = {}, layout = settings[:layout])
+        res.headers[Rack::CONTENT_TYPE] ||= Syro::Response::DEFAULT
 
-      res.write(view(template, locals, layout))
-    end
+        res.write(view(template, locals, layout))
+      end
 
-    def view(template, locals = {}, layout = settings[:layout])
-      return partial(layout, locals.merge(content: partial(template, locals)))
-    end
+      def view(template, locals = {}, layout = settings[:layout])
+        return partial(layout, locals.merge(content: partial(template, locals)))
+      end
 
-    def partial(template, locals = {})
-      return tilt(template_path(template), locals, settings[:engine_opts])
-    end
+      def partial(template, locals = {})
+        return tilt(template_path(template), locals, settings[:engine_opts])
+      end
 
-    private
+      private
 
-    def tilt(file, locals = {}, opts = {})
-      return tilt_cache.fetch(file) { Tilt.new(file, 1, opts) }.render(self, locals)
-    end
+      def tilt(file, locals = {}, opts = {})
+        return tilt_cache.fetch(file) { Tilt.new(file, 1, opts) }.render(self, locals)
+      end
 
-    def tilt_cache
-      return Thread.current[:tilt_cache] ||= Tilt::Cache.new
-    end
+      def tilt_cache
+        return Thread.current[:tilt_cache] ||= Tilt::Cache.new
+      end
 
-    def template_path(template)
-      dir = settings[:views]
-      ext = settings[:engine]
+      def template_path(template)
+        dir = settings[:views]
+        ext = settings[:engine]
 
-      return File.join(dir, "#{ template }.#{ ext }")
+        return File.join(dir, "#{ template }.#{ ext }")
+      end
     end
   end
 end

data/lib/tynn/response.rb

@@ -1,185 +1,197 @@
 class Tynn
-  # It provides convenience methods to construct a Rack response.
+  # Public: It provides convenience methods to construct a Rack response.
   #
-  # ```
-  # res = Tynn::Response.new
-  # res.status = 200
-  # res["Content-Type"] = "text/html"
-  # res.write("foo")
-  # ```
+  # Examples
   #
-  # [Tynn::Response#finish][finish] returns a response as per
-  # [Rack's specification][rack-spec].
+  #   res = Tynn::Response.new
   #
-  # ```
-  # res.finish
-  # # => [200, { "Content-Type" => "text/html", "Content-Length" => 3 }, ["foo"]]
-  # ```
+  #   res.status = 200
+  #   res["Content-Type"] = "text/html"
+  #   res.write("foo")
   #
-  # [finish]: #method-i-finish
-  # [rack-spec]: http://www.rubydoc.info/github/rack/rack/master/file/SPEC
+  #   res.finish
+  #   # => [200, { "Content-Type" => "text/html", "Content-Length" => 3 }, ["foo"]]
   #
   class Response < Syro::Response
-    ##
-    # :method: new
-    # :call-seq: new(headers = {})
+    # Public: Initializes a new response object.
     #
-    # Initializes a new response object with the given `headers`.
+    # headers - A Hash of initial headers. Defaults to <tt>{}</tt>.
     #
-    # ```
-    # Tynn::Response.new.headers
-    # # => {}
+    # Examples
     #
-    # Tynn::Response.new("Content-Type" => "text/plain").headers
-    # # => { "Content-Type" => "text/plain" }
-    # ```
+    #   Tynn::Response.new.headers
+    #   # => {}
+    #
+    #   Tynn::Response.new("Content-Type" => "text/plain").headers
+    #   # => { "Content-Type" => "text/plain" }
+    #
+    # Signature
+    #
+    #   new(headers = {})
+    #
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: []
+    # Public: Returns the response header corresponding to +key+.
+    #
+    # key - A String HTTP header field name.
     #
-    # Returns the response header corresponding to `key`.
+    # Examples
     #
     #     res["Content-Type"]   # => "text/html"
     #     res["Content-Length"] # => "42"
+    #
+    # Signature
+    #
+    #   [](key)
+    #
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: []=
-    # :call-seq: []=(value)
+    # 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.
     #
-    # Sets the given `value` with the header corresponding to `key`.
+    # Examples
     #
     #     res["Content-Type"] = "application/json"
     #     res["Content-Type"] # => "application/json"
+    #
+    # Signature
+    #
+    #   []=(key, value)
+    #
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: body
+    # Public: Returns the body of the response.
     #
-    # Returns the body of the response.
+    # Examples
     #
-    #     res.body
-    #     # => []
+    #   res.body
+    #   # => []
     #
-    #     res.write("there is")
-    #     res.write("no try")
+    #   res.write("there is")
+    #   res.write("no try")
     #
-    #     res.body
-    #     # => ["there is", "no try"]
-
-    ##
-    # :method: finish
-    #
-    # 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`.
-    #
-    #     res.status = 200
-    #     res.finish
-    #     # => [200, {}, []]
-    #
-    #     res.status = nil
-    #     res.finish
-    #     # => [404, {}, []]
-    #
-    #     res.status = nil
-    #     res.write("yo")
-    #     res.finish
-    #     # => [200, { "Content-Type" => "text/html", "Content-Length" => 2 }, ["yo"]]
-
-    ##
-    # :method: headers
+    #   res.body
+    #   # => ["there is", "no try"]
+    #
+    # Signature
     #
-    # Returns a hash with the response headers.
+    #   body()
     #
-    #     res.headers
-    #     # => { "Content-Type" => "text/html", "Content-Length" => "42" }
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: redirect
-    # :call-seq: redirect(path, 302)
+    # 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 the `Location` header to `path` and updates the status to
-    # `status`. By default, `status` is `302`.
+    #   res.status = nil
+    #   res.finish
+    #   # => [404, {}, []]
     #
-    #     res.redirect("/path")
+    #   res.status = nil
+    #   res.write("yo")
+    #   res.finish
+    #   # => [200, { "Content-Type" => "text/html", "Content-Length" => 2 }, ["yo"]]
     #
-    #     res["Location"] # => "/path"
-    #     res.status      # => 302
+    # Signature
     #
-    #     res.redirect("http://tynn.ru", 303)
+    #   finish()
     #
-    #     res["Location"] # => "http://tynn.ru"
-    #     res.status      # => 303
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: status
+    # Public: Returns a Hash with the response headers.
     #
-    # Returns the status of the response.
+    # Examples
     #
-    #     res.status # => 200
+    #   res.headers
+    #   # => { "Content-Type" => "text/html", "Content-Length" => "42" }
+    #
+    # Signature
+    #
+    #   headers()
     #
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: status=
-    # :call-seq: status=(status)
+    # 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.ru", 303)
+    #
+    #   res["Location"] # => "http://tynn.ru"
+    #   res.status      # => 303
     #
-    # Sets the status of the response.
+    # Signature
     #
-    #     res.status = 200
+    #   redirect(url, status = 302)
     #
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: write
-    # :call-seq: write(str)
+    # Public: Returns the status of the response.
     #
-    # Appends `str` to `body` and updates the `Content-Length` header.
+    # Examples
     #
-    #     res.body # => []
+    #     res.status # => 200
     #
-    #     res.write("foo")
-    #     res.write("bar")
+    # Signature
     #
-    #     res.body
-    #     # => ["foo", "bar"]
+    #   status()
     #
-    #     res["Content-Length"]
-    #     # => 6
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: set_cookie
-    # :call-seq: set_cookie(key, value)
+    # Public: Sets the status of the response.
     #
-    # Sets a cookie into the response.
+    # status - An Integer HTTP status code.
     #
-    #     res.set_cookie("foo", "bar")
-    #     res["Set-Cookie"] # => "foo=bar"
+    # Examples
     #
-    #     res.set_cookie("foo2", "bar2")
-    #     res["Set-Cookie"] # => "foo=bar\nfoo2=bar2"
+    #   res.status = 200
     #
-    #     res.set_cookie("bar", {
-    #       domain: ".example.com",
-    #       path: "/",
-    #       # max_age: 0,
-    #       # expires: Time.now + 10_000,
-    #       secure: true,
-    #       httponly: true,
-    #       value: "bar"
-    #     })
+    # Signature
     #
-    #     res["Set-Cookie"].split("\n").last
-    #     # => "bar=bar; domain=.example.com; path=/; secure; HttpOnly
+    #   status=(status)
     #
-    # **NOTE:** This method doesn't sign and/or encrypt the value of the cookie.
+    # Inherited by Syro::Response.
 
-    ##
-    # :method: delete_cookie
-    # :call-seq: delete_cookie(key, value = {})
+    # 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
+    #
+    # Signature
     #
-    # Deletes cookie.
+    #   write(str)
     #
-    #     res.set_cookie("foo", "bar")
-    #     res["Set-Cookie"]
-    #     # => "foo=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
+    # Inherited by Syro::Response.
   end
 end