tynn 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d821049145b6aac7727124929f21acbc7596502a
-  data.tar.gz: 9766f2492ecba5bc81cf6630d517d3f3a1245d48
+  metadata.gz: caaa63933cf9306d02ec269daf58276c16cd28d3
+  data.tar.gz: f42352bb844554c1dd98f020bbceec81e5f6a6bb
 SHA512:
-  metadata.gz: b39573bfd1b8d61d9963a74f51dd27ba04da957f834f34fd08a8d0c0ec6038e8a33a6e03d4f99083592238171f0c305a18e2c32545658cbccddb377892aeea8b
-  data.tar.gz: 5aa36b7ab17f017c45028c43f0ecacaa0614e5ff040ebff7fb47ca6f46d8a64075395e3f6b74e3cefe48c6fa38b36dca99aa5ce3736694484131d603224f85c5
+  metadata.gz: 22ca341ae338b0305f31632ee651dea757344c1e6185ef33f18d2821ea0af12202275e0dda1a811f2d4a89ffcc803f5cbad409e7e2188c85f7d773c0bf625c62
+  data.tar.gz: 29923d6637a08a4d0d945ccfafe95b2ed9dbe2643c76085bc5ee1c476f0c55dff973e906bca95ab1c458d2b04a13503b1aaaef9b98bdb8f15f81038d31d9929e

data/lib/tynn.rb

@@ -7,31 +7,33 @@ require_relative "tynn/version"
 class Tynn
   include Syro::Deck::API
 
-  # Public: Extends Tynn functionality with the given +helper+ module.
+  # Public: Loads given +plugin+ into the application.
   #
   # Examples
   #
   #   require "tynn"
   #   require "tynn/protection"
+  #   require "tynn/session"
   #
-  #   Tynn.helpers(Tynn::Protection)
+  #   Tynn.plugin(Tynn::Protection)
+  #   Tynn.plugin(Tynn::Session, secret: "__a_random_secret_key")
   #
-  def self.helpers(helper, *args, &block)
-    if defined?(helper::InstanceMethods)
-      self.include(helper::InstanceMethods)
+  def self.plugin(plugin, *args, &block)
+    if defined?(plugin::InstanceMethods)
+      self.include(plugin::InstanceMethods)
     end
 
-    if defined?(helper::ClassMethods)
-      self.extend(helper::ClassMethods)
+    if defined?(plugin::ClassMethods)
+      self.extend(plugin::ClassMethods)
     end
 
-    if helper.respond_to?(:setup)
-      helper.setup(self, *args, &block)
+    if plugin.respond_to?(:setup)
+      plugin.setup(self, *args, &block)
     end
   end
 
-  # Internal: Default helpers.
-  helpers(Tynn::Settings)
+  # Internal: Default plugins.
+  plugin(Tynn::Settings)
 
   # Public: Sets the application handler.
   #
@@ -98,7 +100,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/environment"
   #
-  #   Tynn.helpers(Tynn::Environment)
+  #   Tynn.plugin(Tynn::Environment)
   #
   #   Tynn.set(:environment, :staging)
   #   Tynn.environment

data/lib/tynn/all_methods.rb

@@ -6,7 +6,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/all_methods"
   #
-  #   Tynn.helpers(Tynn::AllMethods)
+  #   Tynn.plugin(Tynn::AllMethods)
   #
   module AllMethods
     module InstanceMethods

data/lib/tynn/environment.rb

@@ -6,7 +6,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/environment"
   #
-  #   Tynn.helpers(Tynn::Environment)
+  #   Tynn.plugin(Tynn::Environment)
   #
   #   Tynn.environment  # => :development
   #
@@ -18,7 +18,7 @@ class Tynn
   #
   # Examples
   #
-  #   Tynn.helpers(Tynn::Environment, env: ENV["RACK_ENV"])
+  #   Tynn.plugin(Tynn::Environment, env: ENV["RACK_ENV"])
   #
   module Environment
     # Internal: Configures current environment.

data/lib/tynn/force_ssl.rb

@@ -8,7 +8,7 @@ class Tynn
   #   require "tynn/force_ssl"
   #   require "tynn/test"
   #
-  #   Tynn.helpers(Tynn::ForceSSL)
+  #   Tynn.plugin(Tynn::ForceSSL)
   #
   #   Tynn.define { }
   #

data/lib/tynn/hsts.rb

@@ -9,7 +9,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/hsts"
   #
-  #   Tynn.helpers(Tynn::HSTS)
+  #   Tynn.plugin(Tynn::HSTS)
   #
   #   Tynn.define { }
   #
@@ -33,7 +33,7 @@ class Tynn
   #
   # Examples
   #
-  #   Tynn.helpers(
+  #   Tynn.plugin(
   #     Tynn::HSTS,
   #     expires: 31_536_000,
   #     includeSubdomains: true,
@@ -49,7 +49,7 @@ class Tynn
   #
   # Examples
   #
-  #   Tynn.helpers(Tynn::HSTS, expires: 0)
+  #   Tynn.plugin(Tynn::HSTS, expires: 0)
   #
   module HSTS
     # Internal: Sets the HSTS header as a default header.

data/lib/tynn/json.rb

@@ -8,7 +8,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/json"
   #
-  #   Tynn.helpers(Tynn::JSON)
+  #   Tynn.plugin(Tynn::JSON)
   #
   module JSON
     CONTENT_TYPE = "application/json".freeze

data/lib/tynn/matchers.rb

@@ -6,7 +6,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/matchers"
   #
-  #   Tynn.helpers(Tynn::Matchers)
+  #   Tynn.plugin(Tynn::Matchers)
   #
   module Matchers
     module InstanceMethods

data/lib/tynn/protection.rb

@@ -8,7 +8,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/protection"
   #
-  #   Tynn.helpers(Tynn::Protection)
+  #   Tynn.plugin(Tynn::Protection)
   #
   # If you are using SSL/TLS (HTTPS), it's recommended to set
   # the +:ssl+ option:
@@ -18,9 +18,9 @@ class Tynn
   #   require "tynn"
   #   require "tynn/protection"
   #
-  #   Tynn.helpers(Tynn::Protection, ssl: true)
+  #   Tynn.plugin(Tynn::Protection, ssl: true)
   #
-  # By default, it includes the following security helpers:
+  # By default, it includes the following security plugins:
   #
   # - Tynn::SecureHeaders
   #
@@ -31,22 +31,22 @@ class Tynn
   # - Tynn::ForceSSL
   #
   module Protection
-    # Internal: Configures security related helpers.
+    # Internal: Configures security related plugins.
     def self.setup(app, ssl: false, force_ssl: ssl, hsts: {})
-      app.helpers(Tynn::SecureHeaders)
+      app.plugin(Tynn::SecureHeaders)
 
       if ssl
         app.settings[:ssl] = true
 
         require_relative "hsts"
 
-        app.helpers(Tynn::HSTS, hsts)
+        app.plugin(Tynn::HSTS, hsts)
       end
 
       if force_ssl
         require_relative "force_ssl"
 
-        app.helpers(Tynn::ForceSSL)
+        app.plugin(Tynn::ForceSSL)
       end
     end
   end

data/lib/tynn/secure_headers.rb

@@ -6,9 +6,9 @@ class Tynn
   #   require "tynn"
   #   require "tynn/secure_headers"
   #
-  #   Tynn.helpers(Tynn::SecureHeaders)
+  #   Tynn.plugin(Tynn::SecureHeaders)
   #
-  # This helper applies the following headers:
+  # This plugin applies the following headers:
   #
   # *X-Content-Type-Options:* <tt>"nosniff"</tt>
   #

data/lib/tynn/session.rb

@@ -7,7 +7,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/session"
   #
-  #   Tynn.helpers(Tynn::Session, secret: "__change_me__")
+  #   Tynn.plugin(Tynn::Session, secret: "__change_me__")
   #
   #   Tynn.define do
   #     root do
@@ -30,7 +30,7 @@ class Tynn
   #
   # Examples
   #
-  #   Tynn.helpers(Tynn::Session, secret: ENV["SESSION_SECRET"])
+  #   Tynn.plugin(Tynn::Session, secret: ENV["SESSION_SECRET"])
   #
   # Under the hood, Tynn::Session uses the +Rack::Session::Cookie+ middleware.
   # Thus, supports all the options available for this middleware:
@@ -50,7 +50,7 @@ class Tynn
   #
   # Examples
   #
-  #   Tynn.helpers(
+  #   Tynn.plugin(
   #     Tynn::Session,
   #     key: "app",
   #     secret: ENV["SESSION_SECRET"],

data/lib/tynn/settings.rb

@@ -1,5 +1,5 @@
 class Tynn
-  # Public: It provides a settings API for applications. This helper is
+  # Public: It provides a settings API for applications. This plugin is
   # included by default.
   #
   # Examples
@@ -18,7 +18,7 @@ class Tynn
   #     end
   #   end
   #
-  #   Tynn.helpers(AppName, "MyApp")
+  #   Tynn.plugin(AppName, "MyApp")
   #
   #   Tynn.app_name
   #   # => "MyApp"

data/lib/tynn/static.rb

@@ -7,7 +7,7 @@ class Tynn
   #   require "tynn"
   #   require "tynn/static"
   #
-  #   Tynn.helpers(Tynn::Static, ["/js", "/css"])
+  #   Tynn.plugin(Tynn::Static, ["/js", "/css"])
   #
   # By default, serves all requests beginning with the given paths from
   # the folder +public+ in the current directory (e.g. +public/js/*+,
@@ -16,7 +16,7 @@ class Tynn
   #
   # Examples
   #
-  #   Tynn.helpers(Tynn::Static, ["/js", "/css"], root: "assets")
+  #   Tynn.plugin(Tynn::Static, ["/js", "/css"], root: "assets")
   #
   # Under the hood, it uses the +Rack::Static+ middleware. Thus,
   # supports all the options available by the middleware. Check
@@ -25,7 +25,7 @@ class Tynn
   #
   # Examples
   #
-  #   Tynn.helpers(Tynn::Static, ["/js", "/css"], index: "index.html")
+  #   Tynn.plugin(Tynn::Static, ["/js", "/css"], index: "index.html")
   #
   module Static
     # Internal: Configures Rack::Static middleware.

data/lib/tynn/version.rb

@@ -1,7 +1,7 @@
 class Tynn # :nodoc: all
   VERSION = [
     MAJOR_VERSION = 1,
-    MINOR_VERSION = 0,
+    MINOR_VERSION = 1,
     PATCH_VERSION = 0,
     PRE_VERSION   = nil
   ].compact.join(".")

data/test/all_methods_test.rb

@@ -1,6 +1,6 @@
 require_relative "../lib/tynn/all_methods"
 
-Tynn.helpers(Tynn::AllMethods)
+Tynn.plugin(Tynn::AllMethods)
 
 test "methods" do
   [:head, :options].each do |method|

data/test/environment_test.rb

@@ -4,7 +4,7 @@ test "use RACK_ENV by default" do
   begin
     old, ENV["RACK_ENV"] = ENV["RACK_ENV"], "production"
 
-    Tynn.helpers(Tynn::Environment)
+    Tynn.plugin(Tynn::Environment)
 
     assert_equal(:production, Tynn.environment)
 
@@ -18,7 +18,7 @@ test "use RACK_ENV by default" do
 end
 
 test "use custom value" do
-  Tynn.helpers(Tynn::Environment, env: "development")
+  Tynn.plugin(Tynn::Environment, env: "development")
 
   assert_equal(:development, Tynn.environment)
   assert Tynn.development?

data/test/force_ssl_test.rb

@@ -5,7 +5,7 @@ setup do
 end
 
 test "redirects to https" do |app|
-  Tynn.helpers(Tynn::ForceSSL)
+  Tynn.plugin(Tynn::ForceSSL)
 
   Tynn.define do
   end
@@ -17,7 +17,7 @@ test "redirects to https" do |app|
 end
 
 test "https request" do |app|
-  Tynn.helpers(Tynn::ForceSSL)
+  Tynn.plugin(Tynn::ForceSSL)
 
   Tynn.define do
     root do

data/test/hmote_test.rb

@@ -1,7 +1,7 @@
 require_relative "../lib/tynn/hmote"
 
 setup do
-  Tynn.helpers(Tynn::HMote, views: File.expand_path("./test/views"))
+  Tynn.plugin(Tynn::HMote, views: File.expand_path("./test/views"))
 
   Tynn::Test.new
 end

data/test/hsts_test.rb

@@ -1,7 +1,7 @@
 require_relative "../lib/tynn/hsts"
 
 test "hsts header" do |app|
-  Tynn.helpers(Tynn::HSTS)
+  Tynn.plugin(Tynn::HSTS)
 
   Tynn.define do
   end
@@ -15,7 +15,7 @@ test "hsts header" do |app|
 end
 
 test "hsts header options" do |app|
-  Tynn.helpers(Tynn::HSTS, expires: 1, subdomains: false, preload: true)
+  Tynn.plugin(Tynn::HSTS, expires: 1, subdomains: false, preload: true)
 
   Tynn.define do
   end

data/test/json_test.rb

@@ -1,7 +1,7 @@
 require_relative "../lib/tynn/json"
 
 test "json" do
-  Tynn.helpers(Tynn::JSON)
+  Tynn.plugin(Tynn::JSON)
 
   Tynn.define do
     root do

data/test/matchers_test.rb

@@ -1,7 +1,7 @@
 require_relative "../lib/tynn/matchers"
 
 setup do
-  Tynn.helpers(Tynn::Matchers)
+  Tynn.plugin(Tynn::Matchers)
 
   Tynn::Test.new
 end

data/test/not_found_test.rb

@@ -1,7 +1,7 @@
 require_relative "../lib/tynn/not_found"
 
 test "not found" do
-  Tynn.helpers(Tynn::NotFound)
+  Tynn.plugin(Tynn::NotFound)
 
   class Tynn
     def not_found

data/test/protection_test.rb

@@ -4,7 +4,7 @@ require_relative "../lib/tynn/session"
 test "supports hsts options" do
   hsts = { expires: 100, subdomains: false, preload: true }
 
-  Tynn.helpers(Tynn::Protection, ssl: true, hsts: hsts)
+  Tynn.plugin(Tynn::Protection, ssl: true, hsts: hsts)
 
   Tynn.define do
   end
@@ -18,8 +18,8 @@ test "supports hsts options" do
 end
 
 test "adds secure flag to session cookie" do
-  Tynn.helpers(Tynn::Protection, ssl: true)
-  Tynn.helpers(Tynn::Session, secret: "_this_must_be_random_")
+  Tynn.plugin(Tynn::Protection, ssl: true)
+  Tynn.plugin(Tynn::Session, secret: "_this_must_be_random_")
 
   Tynn.define do
     root do

data/test/render_test.rb

@@ -2,7 +2,7 @@ require "erubis"
 require_relative "../lib/tynn/render"
 
 setup do
-  Tynn.helpers(Tynn::Render, views: File.expand_path("./test/views"))
+  Tynn.plugin(Tynn::Render, views: File.expand_path("./test/views"))
 
   Tynn::Test.new
 end

data/test/secure_headers_test.rb

@@ -1,7 +1,7 @@
 require_relative "../lib/tynn/secure_headers"
 
 test "secure headers" do
-  Tynn.helpers(Tynn::SecureHeaders)
+  Tynn.plugin(Tynn::SecureHeaders)
 
   Tynn.define do
     root do

data/test/session_test.rb

@@ -2,7 +2,7 @@ require "securerandom"
 require_relative "../lib/tynn/session"
 
 test "session" do
-  Tynn.helpers(Tynn::Session, secret: SecureRandom.hex(64))
+  Tynn.plugin(Tynn::Session, secret: SecureRandom.hex(64))
 
   Tynn.define do
     root do

data/test/static_test.rb

@@ -1,7 +1,7 @@
 require_relative "../lib/tynn/static"
 
 test "static" do
-  Tynn.helpers(Tynn::Static, %w(/test), root: Dir.pwd)
+  Tynn.plugin(Tynn::Static, %w(/test), root: Dir.pwd)
 
   Tynn.define do
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tynn
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Francesco Rodríguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack