tynn 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4778b186382c25ab99b1687323ec3562c045a0ee
-  data.tar.gz: 3b8c8d0c9a80cf5cce5cfb235e27be3b34093197
+  metadata.gz: 5991d5053c18550ff9e4640a0fb6ce8877e2e8d9
+  data.tar.gz: 546da7cc32f33b70f95abb79557fb05a1045bc01
 SHA512:
-  metadata.gz: ef2895b73ebb6b9180e747a28499de003fb430a6e6eaee6027f7d7ae5c2569c9161347aed31aacb25552ce010dff48a01ebdbdf39af026f61702316c38ac3036
-  data.tar.gz: 47e3ccf946f417ba6c444d4197d511eef8df1c987e83468214a5949d3ffa6c46a89e891da13d032e077bdd6b1781ec64313a60a3a399e5eb259ced0513fe6869
+  metadata.gz: 73682ff6496225b2fee11bdf76bf262ded91308c5db2b7c4bd4442a5b152247b5a8ea5a23d57b7f96acc96f67e180eca4165518a38f5bb7b2feb9f84481e0b1a
+  data.tar.gz: 0a4b872f14749623d88aaac9e6ade93a787a67ac1ee5eb93350028845ba5d55f217923dd8f5d62aed61b2bfd4b40c29d238763659dec36cb4778570a20495d3f

data/README.md

@@ -1,7 +1,7 @@
 tynn [![Gem Version](https://badge.fury.io/rb/tynn.svg)](https://rubygems.org/gems/tynn)
 ====
 
-Simple library to create [Rack][rack] applications.
+A thin library for web development.
 
 Description
 -----------

data/lib/tynn.rb

@@ -28,7 +28,7 @@ class Tynn
   # ```
   #
   def self.define(&block)
-    @syro = Syro.new(self, &block)
+    build_app(Syro.new(self, &block))
   end
 
   # Adds given Rack `middleware` to the stack.
@@ -46,16 +46,14 @@ class Tynn
   end
 
   def self.call(env) # :nodoc:
-    return to_app.call(env)
+    return @app.call(env)
   end
 
-  def self.to_app # :nodoc:
-    fail("Missing application handler. Try #{ self }.define") unless @syro
-
+  def self.build_app(syro) # :nodoc:
     if __middleware.empty?
-      return @syro
+      @app = syro
     else
-      return __middleware.reverse.inject(@syro) { |a, m| m.call(a) }
+      @app = __middleware.reverse.inject(syro) { |a, m| m.call(a) }
     end
   end
 
@@ -64,7 +62,7 @@ class Tynn
   end
 
   def self.reset! # :nodoc:
-    @syro = nil
+    @app = nil
     @middleware = []
   end
 
@@ -73,7 +71,7 @@ class Tynn
   # ```
   # module AppName
   #   def self.setup(app, name)
-  #     app.settings[:app_name] = name
+  #     app.set(:app_name, name)
   #   end
   #
   #   def app_name
@@ -81,10 +79,6 @@ class Tynn
   #   end
   #
   #   module ClassMethods
-  #     def app_name=(new_name)
-  #       settings[:app_name] = new_name
-  #     end
-  #
   #     def app_name
   #       return settings[:app_name]
   #     end
@@ -95,7 +89,7 @@ class Tynn
   #
   # Tynn.app_name # => "MyApplication"
   #
-  # Tynn.app_name = "MyGreatestApp"
+  # Tynn.set(:app_name, "MyGreatestApp")
   # Tynn.app_name # => "MyGreatestApp"
   #
   # Tynn.define do
@@ -107,7 +101,7 @@ class Tynn
   #
   # Check the [helpers][examples] that come with tynn for more examples.
   #
-  # [examples]: https://github.com/harmoni/tynn/tree/master/lib/tynn
+  # [examples]: https://github.com/frodsan/tynn/tree/master/lib/tynn
   #
   def self.helpers(helper, *args, &block)
     self.include(helper)
@@ -121,6 +115,10 @@ class Tynn
     end
   end
 
+  def self.set(key, value)
+    settings[key] = value
+  end
+
   def request_class # :nodoc:
     return Tynn::Request
   end
@@ -128,4 +126,40 @@ class Tynn
   def response_class # :nodoc:
     return Tynn::Response
   end
+
+  ##
+  # :method: halt(response)
+  #
+  # Immediately stops the request and returns `response` as per
+  # Rack's specification.
+  #
+  # ```
+  # halt([200, { "Content-Type" => "text/html" }, ["hello"]])
+  # halt([res.status, res.headers, res.body])
+  # halt(res.finish)
+  # ```
+
+  ##
+  # :method: req
+  #
+  # Returns the incoming request object. This object is an instance
+  # of Tynn::Request.
+  #
+  # ```
+  # req.post?      # => true
+  # req.params     # => { "username" => "bob", "password" => "secret" }
+  # req[:username] # => "bob"
+  # ```
+
+  ##
+  # :method: res
+  #
+  # Returns the current response object. This object is an instance
+  # of Tynn::Response.
+  #
+  # ```
+  # res.status = 200
+  # res["Content-Type"] = "text/html"
+  # res.write("<h1>Welcome back!</h1>")
+  # ```
 end

data/lib/tynn/all_methods.rb

@@ -1,17 +1,19 @@
-module Tynn::AllMethods
-  def head
-    if root? && req.head?
-      yield
+class Tynn
+  module AllMethods
+    def head
+      if root? && req.head?
+        yield
 
-      halt(res.finish)
+        halt(res.finish)
+      end
     end
-  end
 
-  def options
-    if root? && req.options?
-      yield
+    def options
+      if root? && req.options?
+        yield
 
-      halt(res.finish)
+        halt(res.finish)
+      end
     end
   end
 end

data/lib/tynn/environment.rb

@@ -1,44 +1,46 @@
-# Adds helper methods to get and check the current environment.
-#
-# ```
-# require "tynn"
-# require "tynn/environment"
-#
-# Tynn.helpers(Tynn::Environment)
-#
-# Tynn.environment  # => :development
-#
-# Tynn.development? # => true
-# Tynn.production?  # => false
-# Tynn.test?        # => false
-# ```
-#
-# By default, the environment is based on `ENV["RACK_ENV"]`.
-#
-# ```
-# Tynn.helpers(Tynn::Environment, env: ENV["RACK_ENV"])
-# ```
-#
-module Tynn::Environment
-  def self.setup(app, env: ENV["RACK_ENV"]) # :nodoc:
-    app.settings[:environment] = (env || :development).to_sym
-  end
-
-  module ClassMethods # :nodoc:
-    def environment
-      return settings[:environment]
+class Tynn
+  # Adds helper methods to get and check the current environment.
+  #
+  # ```
+  # require "tynn"
+  # require "tynn/environment"
+  #
+  # Tynn.helpers(Tynn::Environment)
+  #
+  # Tynn.environment  # => :development
+  #
+  # Tynn.development? # => true
+  # Tynn.production?  # => false
+  # Tynn.test?        # => false
+  # ```
+  #
+  # By default, the environment is based on `ENV["RACK_ENV"]`.
+  #
+  # ```
+  # Tynn.helpers(Tynn::Environment, env: ENV["RACK_ENV"])
+  # ```
+  #
+  module Environment
+    def self.setup(app, env: ENV["RACK_ENV"]) # :nodoc:
+      app.set(:environment, (env || :development).to_sym)
     end
 
-    def development?
-      return environment == :development
-    end
+    module ClassMethods # :nodoc:
+      def environment
+        return settings[:environment]
+      end
 
-    def test?
-      return environment == :test
-    end
+      def development?
+        return environment == :development
+      end
+
+      def test?
+        return environment == :test
+      end
 
-    def production?
-      return environment == :production
+      def production?
+        return environment == :production
+      end
     end
   end
 end

data/lib/tynn/erubis.rb

@@ -1,15 +1,17 @@
 require "erubis"
 require_relative "render"
 
-module Tynn::Erubis
-  def self.setup(app, options = {}) # :nodoc:
-    options = options.dup
+class Tynn
+  module Erubis
+    def self.setup(app, options = {}) # :nodoc:
+      options = options.dup
 
-    options[:options] ||= {}
-    options[:options] = {
-      escape_html: true
-    }.merge!(options[:options])
+      options[:options] ||= {}
+      options[:options] = {
+        escape_html: true
+      }.merge!(options[:options])
 
-    app.helpers(Tynn::Render, options)
+      app.helpers(Tynn::Render, options)
+    end
   end
 end

data/lib/tynn/json.rb

@@ -1,11 +1,42 @@
 require "json"
 
-module Tynn::JSON
-  JSON_CONTENT_TYPE = "application/json".freeze # :nodoc:
+class Tynn
+  # Adds helper methods for json generation.
+  #
+  # ```
+  # require "tynn"
+  # require "tynn/json"
+  #
+  # Tynn.helpers(Tynn::JSON)
+  # ```
+  #
+  module JSON
+    JSON_CONTENT_TYPE = "application/json".freeze # :nodoc:
 
-  def json(data)
-    res.headers[Rack::CONTENT_TYPE] = JSON_CONTENT_TYPE
+    # 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
 
-    res.write(data.to_json)
+      res.write(data.to_json)
+    end
   end
 end

data/lib/tynn/matchers.rb

@@ -1,58 +1,60 @@
-# Adds extra matchers to Tynn.
-#
-# ```
-# require "tynn"
-# require "tynn/matchers"
-#
-# Tynn.helpers(Tynn::Matchers)
-# ```
-#
-module Tynn::Matchers
-  # A catch-all matcher.
+class Tynn
+  # Adds extra matchers to Tynn.
   #
   # ```
-  # Tynn.define do
-  #   authenticated? do
-  #     # ...
-  #   end
+  # require "tynn"
+  # require "tynn/matchers"
   #
-  #   default do # on true
-  #     # ...
-  #   end
-  # end
+  # Tynn.helpers(Tynn::Matchers)
   # ```
   #
-  # :call-seq: default(&block)
-  #
-  def default
-    yield
+  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
 
-    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 param")
-  #   end
-  # end
-  # ```
-  #
-  # :call-seq: param(key, &block)
-  #
-  def param(key)
-    if (v = req[key]) && !v.empty?
-      yield(v)
+    # 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)
 
-      halt(res.finish)
+        halt(res.finish)
+      end
     end
   end
 end

data/lib/tynn/not_found.rb

@@ -1,16 +1,18 @@
-module Tynn::NotFound
-  def call(*) # :nodoc:
-    result = super
+class Tynn
+  module NotFound
+    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