tynn 1.0.0.rc3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e2fe7081578c608775773d67ab5e4dc92a33414
-  data.tar.gz: 96e869a9ec51ed45ab5baf116cd8126c32c4b597
+  metadata.gz: d821049145b6aac7727124929f21acbc7596502a
+  data.tar.gz: 9766f2492ecba5bc81cf6630d517d3f3a1245d48
 SHA512:
-  metadata.gz: dd4c49a2f298af29cefebca3650c488ab2bbb527299f700e9a72964e01a4fc1352fa7da6ef2264b25be24cedaaf6272ac53b5a603619da19c3d24a1b207235e4
-  data.tar.gz: 4ba63a68c74cbc71463b0e010ae985b8dab7d34d55e2043f1ed776774c8de93b4e07a33d7b08724fb1bacfd9e3156fa70bde9a37fe0912c214ecff1c159f6779
+  metadata.gz: b39573bfd1b8d61d9963a74f51dd27ba04da957f834f34fd08a8d0c0ec6038e8a33a6e03d4f99083592238171f0c305a18e2c32545658cbccddb377892aeea8b
+  data.tar.gz: 5aa36b7ab17f017c45028c43f0ecacaa0614e5ff040ebff7fb47ca6f46d8a64075395e3f6b74e3cefe48c6fa38b36dca99aa5ce3736694484131d603224f85c5

data/README.md

@@ -48,6 +48,6 @@ Contributing
 You can install the gems globally, but we recommend [gs][gs] (or
 [gst][gst] if you're using chruby) to keep things isolated.
 
-[syro]: https://github.com/soveran/syro
+[syro]: http://soveran.github.io/syro/
 [gs]: https://github.com/soveran/gs
 [gst]: https://github.com/tonchis/gst

data/lib/tynn/all_methods.rb

@@ -1,6 +1,25 @@
 class Tynn
+  # Public: Adds method for HTTP's +HEAD+ and +OPTIONS+.
+  #
+  # Examples
+  #
+  #   require "tynn"
+  #   require "tynn/all_methods"
+  #
+  #   Tynn.helpers(Tynn::AllMethods)
+  #
   module AllMethods
     module InstanceMethods
+      # Public: Executes the given block if the request method is +HEAD+.
+      #
+      # Examples
+      #
+      #   Tynn.define do
+      #     head do
+      #       res.status = 201
+      #     end
+      #   end
+      #
       def head
         if root? && req.head?
           yield
@@ -9,6 +28,16 @@ class Tynn
         end
       end
 
+      # Public: Executes the given block if the request method is +OPTIONS+.
+      #
+      # Examples
+      #
+      #   Tynn.define do
+      #     options do
+      #       res.status = 405
+      #     end
+      #   end
+      #
       def options
         if root? && req.options?
           yield

data/lib/tynn/environment.rb

@@ -21,23 +21,69 @@ class Tynn
   #   Tynn.helpers(Tynn::Environment, env: ENV["RACK_ENV"])
   #
   module Environment
-    def self.setup(app, env: ENV["RACK_ENV"]) # :nodoc:
+    # Internal: Configures current environment.
+    def self.setup(app, env: ENV["RACK_ENV"])
       app.set(:environment, (env || :development).to_sym)
     end
 
-    module ClassMethods # :nodoc:
+    module ClassMethods
+      # Public: Returns current environment.
+      #
+      # Examples
+      #
+      #   Tynn.environment
+      #   # => :development
+      #
+      #   Tynn.set(:environment, :test)
+      #
+      #   Tynn.environment
+      #   # => :test
+      #
       def environment
         return settings[:environment]
       end
 
+      # Public: Returns +true+ if the current environment is +:development+.
+      # Otherwise returns +false+.
+      #
+      # Examples
+      #
+      #   Tynn.set(:environment, :test)
+      #   Tynn.development? # => false
+      #
+      #   Tynn.set(:environment, :development)
+      #   Tynn.development? # => true
+      #
       def development?
         return environment == :development
       end
 
+      # Public: Returns +true+ if the current environment is +:test+.
+      # Otherwise returns +false+.
+      #
+      # Examples
+      #
+      #   Tynn.set(:environment, :development)
+      #   Tynn.test? # => false
+      #
+      #   Tynn.set(:environment, :test)
+      #   Tynn.test? # => true
+      #
       def test?
         return environment == :test
       end
 
+      # Public: Returns +true+ if the current environment is +:production+.
+      # Otherwise returns +false+.
+      #
+      # Examples
+      #
+      #   Tynn.set(:environment, :development)
+      #   Tynn.production? # => false
+      #
+      #   Tynn.set(:environment, :production)
+      #   Tynn.production? # => true
+      #
       def production?
         return environment == :production
       end

data/lib/tynn/force_ssl.rb

@@ -13,10 +13,10 @@ class Tynn
   #   Tynn.define { }
   #
   #   app = Tynn::Test.new
-  #   app.get("/", {}, "HTTP_HOST" => "tynn.ru")
+  #   app.get("/", {}, "HTTP_HOST" => "tynn.xyz")
   #
   #   app.res.headers["Location"]
-  #   # => "https://tynn.ru/"
+  #   # => "https://tynn.xyz/"
   #
   module ForceSSL
     # Internal: Sets the HTTPS redirect middleware.

data/lib/tynn/hmote.rb

@@ -10,13 +10,13 @@ class Tynn
     module InstanceMethods
       include ::HMote::Helpers
 
-      def render(template, locals = {}, layout = settings[:layout])
+      def render(template, locals = {}, layout = self.class.settings[:layout])
         res.headers[Rack::CONTENT_TYPE] ||= Syro::Response::DEFAULT
 
         res.write(view(template, locals, layout))
       end
 
-      def view(template, locals = {}, layout = settings[:layout])
+      def view(template, locals = {}, layout = self.class.settings[:layout])
         return partial(layout, locals.merge(content: partial(template, locals)))
       end
 
@@ -27,7 +27,7 @@ class Tynn
       private
 
       def template_path(template)
-        return File.join(settings[:views], "#{ template }.mote")
+        return File.join(self.class.settings[:views], "#{ template }.mote")
       end
     end
   end

data/lib/tynn/matchers.rb

@@ -10,7 +10,7 @@ class Tynn
   #
   module Matchers
     module InstanceMethods
-      # Public: A catch-all matcher.
+      # Public: A catch-all matcher. Always executes the given block.
       #
       # Examples
       #
@@ -24,15 +24,15 @@ class Tynn
       #     end
       #   end
       #
-      # :call-seq: default(&block)
-      #
       def default
         yield
 
         halt(res.finish)
       end
 
-      # Public: Match if the given +key+ is present in +req.params+.
+      # Public: Executes the given block if +key+ is present in +req.params+.
+      #
+      # key - Any object that responds to +to_s+.
       #
       # Examples
       #
@@ -44,12 +44,10 @@ class Tynn
       #     end
       #
       #     default do
-      #       res.write("missing user param")
+      #       res.write("missing [user] param")
       #     end
       #   end
       #
-      # :call-seq: param(key, &block)
-      #
       def param(key)
         if (v = req[key]) && !v.empty?
           yield(v)

data/lib/tynn/protection.rb

@@ -31,7 +31,7 @@ class Tynn
   # - Tynn::ForceSSL
   #
   module Protection
-    # Internal: Configures security related extensions.
+    # Internal: Configures security related helpers.
     def self.setup(app, ssl: false, force_ssl: ssl, hsts: {})
       app.helpers(Tynn::SecureHeaders)
 

data/lib/tynn/render.rb

@@ -14,18 +14,18 @@ class Tynn
     end
 
     module InstanceMethods
-      def render(template, locals = {}, layout = settings[:layout])
+      def render(template, locals = {}, layout = self.class.settings[:layout])
         res.headers[Rack::CONTENT_TYPE] ||= Syro::Response::DEFAULT
 
         res.write(view(template, locals, layout))
       end
 
-      def view(template, locals = {}, layout = settings[:layout])
+      def view(template, locals = {}, layout = self.class.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])
+        return tilt(template_path(template), locals, self.class.settings[:engine_opts])
       end
 
       private
@@ -39,8 +39,8 @@ class Tynn
       end
 
       def template_path(template)
-        dir = settings[:views]
-        ext = settings[:engine]
+        dir = self.class.settings[:views]
+        ext = self.class.settings[:engine]
 
         return File.join(dir, "#{ template }.#{ ext }")
       end

data/lib/tynn/request.rb

@@ -1,6 +1,53 @@
 class Tynn
-  # It provides convenience methods for pulling out information
+  # Public: It provides convenience methods for pulling out information
   # from a request.
+  #
+  # Examples
+  #
+  #   env = {
+  #     "REQUEST_METHOD" => "GET"
+  #     "QUERY_STRING"   => "email=me@tynn.xyz"
+  #   }
+  #
+  #   req = Tynn::Request.new(env)
+  #
+  #   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.
   end
 end

data/lib/tynn/response.rb

@@ -133,9 +133,9 @@ class Tynn
     #   res["Location"] # => "/path"
     #   res.status      # => 302
     #
-    #   res.redirect("http://tynn.ru", 303)
+    #   res.redirect("http://tynn.xyz", 303)
     #
-    #   res["Location"] # => "http://tynn.ru"
+    #   res["Location"] # => "http://tynn.xyz"
     #   res.status      # => 303
     #
     # Signature

data/lib/tynn/secure_headers.rb

@@ -28,7 +28,7 @@ class Tynn
   #
   # 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 disabled by the user.
+  # is to re-enable it if it was turned off by the user.
   #
   module SecureHeaders
     # Internal: Sets the default HTTP secure headers.

data/lib/tynn/settings.rb

@@ -1,5 +1,30 @@
 class Tynn
-  module Settings # :nodoc: all
+  # Public: It provides a settings API for applications. This helper is
+  # included by default.
+  #
+  # Examples
+  #
+  #   require "tynn"
+  #
+  #   module AppName
+  #     def self.setup(app, app_name)
+  #       app.settings[:app_name] = app_name
+  #     end
+  #
+  #     module ClassMethods
+  #       def app_name
+  #         return settings[:app_name]
+  #       end
+  #     end
+  #   end
+  #
+  #   Tynn.helpers(AppName, "MyApp")
+  #
+  #   Tynn.app_name
+  #   # => "MyApp"
+  #
+  module Settings
+    # Internal: Returns a deep copy of a Hash.
     def self.deepclone(hash)
       default_proc, hash.default_proc = hash.default_proc, nil
 
@@ -8,18 +33,23 @@ class Tynn
       hash.default_proc = default_proc
     end
 
-    module InstanceMethods # :nodoc: all
-      def settings
-        return self.class.settings
-      end
-    end
-
-    module ClassMethods # :nodoc: all
+    module ClassMethods
+      # Internal: Copies settings into the subclass.
+      # If a setting is not found, checks parent's settings.
       def inherited(subclass)
         subclass.settings.replace(Tynn::Settings.deepclone(settings))
         subclass.settings.default_proc = proc { |h, k| h[k] = settings[k] }
       end
 
+      # Returns a Hash with the application settings.
+      #
+      # Examples
+      #
+      #   Tynn.set(:environment, :development)
+      #
+      #   Tynn.settings
+      #   # => { :environment => :development }
+      #
       def settings
         return @settings ||= {}
       end

data/lib/tynn/version.rb

@@ -3,6 +3,6 @@ class Tynn # :nodoc: all
     MAJOR_VERSION = 1,
     MINOR_VERSION = 0,
     PATCH_VERSION = 0,
-    PRE_VERSION   = "rc3"
+    PRE_VERSION   = nil
   ].compact.join(".")
 end

data/lib/tynn.rb

@@ -111,7 +111,7 @@ class Tynn
   set(:default_headers, {})
 
   def default_headers # :nodoc:
-    return Hash[settings[:default_headers]]
+    return Hash[self.class.settings[:default_headers]]
   end
 
   def request_class # :nodoc:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tynn
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0
 platform: ruby
 authors:
 - Francesco Rodríguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -168,9 +168,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8