tynn 1.4.0 → 2.0.0.alpha

data/lib/tynn.rb

@@ -1,127 +1,74 @@
-require "syro"
-require_relative "tynn/request"
-require_relative "tynn/response"
+# frozen_string_literal: true
+
+require_relative "tynn/base"
+require_relative "tynn/default_headers"
 require_relative "tynn/settings"
 require_relative "tynn/version"
 
 class Tynn
-  include Syro::Deck::API
-
-  # Public: Loads given +plugin+ into the application.
+  # Loads given <tt>plugin</tt> into the application.
   #
-  # Examples
+  # [plugin]
+  #   A module that can contain a <tt>ClassMethods</tt> or <tt>InstanceMethods</tt>
+  #   module to extend Tynn. If <tt>plugin</tt> responds to <tt>setup</tt>, it will
+  #   be called last, and should be used to set up the plugin.
   #
-  #   require "tynn"
-  #   require "tynn/protection"
-  #   require "tynn/session"
+  # [*args]
+  #   A list of arguments passed to <tt>plugin#setup</tt>.
   #
-  #   Tynn.plugin(Tynn::Protection)
-  #   Tynn.plugin(Tynn::Session, secret: "__a_random_secret_key")
+  # [&block]
+  #   A block passed to <tt>plugin#setup</tt>.
   #
-  def self.plugin(plugin, *args, &block)
-    if defined?(plugin::InstanceMethods)
-      self.include(plugin::InstanceMethods)
-    end
-
-    if defined?(plugin::ClassMethods)
-      self.extend(plugin::ClassMethods)
-    end
-
-    if plugin.respond_to?(:setup)
-      plugin.setup(self, *args, &block)
-    end
-  end
-
-  # Internal: Default plugins.
-  plugin(Tynn::Settings)
-
-  # Public: Sets the application handler.
+  # <tt></tt>
   #
-  # Examples
+  #   # Using default plugins
+  #   require "tynn"
+  #   require "tynn/environment"
+  #   require "tynn/static"
   #
-  #   class Users < Tynn
-  #   end
+  #   Tynn.plugin(Tynn::Environment)
+  #   Tynn.plugin(Tynn::Static, %(/css /js /images))
+  #
+  #   # Using a custom plugin
+  #   class MyAppNamePlugin
+  #     def self.setup(app, name, &block)
+  #       app.app_name = name
+  #     end
   #
-  #   Users.define do
-  #     on(:id) do |id|
-  #       get do
-  #         res.write("GET /users")
+  #     module ClassMethods
+  #       def app_name
+  #         @app_name
   #       end
   #
-  #       post do
-  #         res.write("POST /users")
+  #       def app_name=(name)
+  #         @app_name = name
   #       end
   #     end
-  #   end
   #
-  def self.define(&block)
-    build_app(Syro.new(self, &block))
-  end
-
-  # Public: Adds given Rack +middleware+ to the stack.
-  #
-  # Examples
-  #
-  #   require "rack/common_logger"
-  #   require "rack/show_exceptions"
+  #     module InstanceMethods
+  #       def app_name
+  #         self.class.app_name
+  #       end
+  #     end
+  #   end
   #
-  #   Tynn.use(Rack::CommonLogger)
-  #   Tynn.use(Rack::ShowExceptions)
+  #   Tynn.plugin(MyAppNamePlugin, "MyApp")
   #
-  def self.use(middleware, *args, &block)
-    self.middleware << proc { |app| middleware.new(app, *args, &block) }
-  end
-
-  def self.call(env) # :nodoc:
-    return @app.call(env)
-  end
-
-  def self.build_app(syro) # :nodoc:
-    if middleware.empty?
-      @app = syro
-    else
-      @app = middleware.reverse.inject(syro) { |a, m| m.call(a) }
+  def self.plugin(plugin, *args, &block)
+    if defined?(plugin::InstanceMethods)
+      include(plugin::InstanceMethods)
     end
-  end
-
-  # Internal: Returns middleware stack.
-  def self.middleware
-    return @middleware ||= []
-  end
-
-  def self.reset! # :nodoc:
-    @app = nil
-    @middleware = []
-  end
-
-  # Public: Sets an +option+ to the given +value+.
-  #
-  # Examples
-  #
-  #   require "tynn"
-  #   require "tynn/environment"
-  #
-  #   Tynn.plugin(Tynn::Environment)
-  #
-  #   Tynn.set(:environment, :staging)
-  #   Tynn.environment
-  #   # => :staging
-  #
-  def self.set(option, value)
-    settings[option] = value
-  end
 
-  set(:default_headers, {})
-
-  def default_headers # :nodoc:
-    return Hash[self.class.settings[:default_headers]]
-  end
+    if defined?(plugin::ClassMethods)
+      extend(plugin::ClassMethods)
+    end
 
-  def request_class # :nodoc:
-    return Tynn::Request
+    if plugin.respond_to?(:setup)
+      plugin.setup(self, *args, &block)
+    end
   end
 
-  def response_class # :nodoc:
-    return Tynn::Response
-  end
+  plugin(Tynn::Base)
+  plugin(Tynn::Settings)
+  plugin(Tynn::DefaultHeaders)
 end

data/lib/tynn/base.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "syro"
+require_relative "request"
+require_relative "response"
+
+class Tynn
+  module Base
+    module ClassMethods
+      # Sets the application handler.
+      #
+      #   class Users < Tynn
+      #   end
+      #
+      #   Users.define do
+      #     on(:id) do |id|
+      #       get do
+      #         res.write("GET /users/#{ id }")
+      #       end
+      #
+      #       post do
+      #         res.write("POST /users/#{ id }")
+      #       end
+      #     end
+      #   end
+      #
+      def define(&block)
+        @__app = build_app(Syro.new(self, &block))
+      end
+
+      def build_app(app) # :nodoc:
+        middleware.freeze.reverse.inject(app) { |a, e| e.call(a) }
+      end
+
+      # Adds given Rack <tt>middleware</tt> to the stack.
+      #
+      # [middleware] A Rack middleware.
+      # [*args]      A list of arguments passed to the middleware initialization.
+      # [&block]     A block passed to the middleware initialization.
+      #
+      #   require "rack/common_logger"
+      #   require "rack/show_exceptions"
+      #
+      #   Tynn.use(Rack::CommonLogger)
+      #   Tynn.use(Rack::ShowExceptions)
+      #
+      def use(middleware, *args, &block)
+        self.middleware.push(proc { |app| middleware.new(app, *args, &block) })
+      end
+
+      def middleware # :nodoc:
+        @__middleware ||= []
+      end
+
+      def call(env) # :nodoc:
+        app.call(env)
+      end
+
+      def app # :nodoc:
+        (defined?(@__app) && @__app) or
+          raise("Application handler is missing. Try #{ self }.define {}")
+      end
+    end
+
+    module InstanceMethods # :nodoc:
+      include Syro::Deck::API
+
+      # Overrides Syro::Deck::API#on to support passing the receiver to
+      # the capturing matchers.
+      #
+      #   on :name do |name|
+      #   end
+      #
+      #   # instead of
+      #
+      #   on :name do
+      #     name = inbox[:name]
+      #   end
+      #
+      def on(arg)
+        default { yield((arg.is_a?(Symbol) ? inbox[arg] : nil)) } if match(arg)
+      end
+
+      # Overrides request class used by Syro's router.
+      # See Tynn::Request for more information.
+      def request_class
+        Tynn::Request
+      end
+
+      # Overrides response class used by Syro's router.
+      # See Tynn::Response for more information.
+      def response_class
+        Tynn::Response
+      end
+    end
+  end
+end

data/lib/tynn/default_headers.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class Tynn
+  # Adds support to set default headers for responses.
+  #
+  #   require "tynn"
+  #   require "tynn/test"
+  #
+  #   Tynn.set(:default_headers, {
+  #     "Content-Type" => "application/json"
+  #   })
+  #
+  #   Tynn.define { }
+  #
+  #   app = Tynn::Test.new
+  #   app.get("/")
+  #
+  #   app.res.headers
+  #   # => { "Content-Type" => "application/json" }
+  #
+  # This plugin is included by default.
+  #
+  module DefaultHeaders
+    def self.setup(app) # :nodoc:
+      app.set(:default_headers, {})
+    end
+
+    module ClassMethods
+      # Returns a Hash with the default headers.
+      #
+      #   Tynn.set(:default_headers, {
+      #     "Content-Type" => "application/json"
+      #   })
+      #
+      #   Tynn.default_headers["Content-Type"]
+      #   # => "application/json"
+      #
+      def default_headers
+        settings[:default_headers]
+      end
+    end
+
+    module InstanceMethods # :nodoc:
+      # Overrides Syro's default implementation of default headers.
+      def default_headers
+        Hash[self.class.default_headers]
+      end
+    end
+  end
+end

data/lib/tynn/environment.rb

@@ -1,52 +1,69 @@
+# frozen_string_literal: true
+
 class Tynn
-  # Public: Adds helper methods to get and check the current environment.
-  #
-  # Examples
+  # Adds helper methods to get and check the current environment.
+  # By default, the environment is based on <tt>ENV["RACK_ENV"]</tt>.
   #
   #   require "tynn"
   #   require "tynn/environment"
   #
   #   Tynn.plugin(Tynn::Environment)
   #
+  #   # Accessing the current environment.
   #   Tynn.environment  # => :development
   #
+  #   # Checking the current environment.
   #   Tynn.development? # => true
   #   Tynn.production?  # => false
   #   Tynn.test?        # => false
+  #   Tynn.staging?     # => false
   #
-  # By default, the environment is based on <tt>ENV["RACK_ENV"]</tt>.
-  #
-  # Examples
+  #   # Changing the current environment.
+  #   Tynn.set(:environment, :test)
   #
-  #   Tynn.plugin(Tynn::Environment, env: ENV["RACK_ENV"])
+  #   # Performing operations in specific environments.
+  #   Tynn.configure(:development, :test) do
+  #     # ...
+  #   end
   #
   module Environment
-    # Internal: Configures current environment.
-    def self.setup(app, env: ENV["RACK_ENV"])
+    def self.setup(app, env: ENV["RACK_ENV"]) # :nodoc:
       app.set(:environment, (env || :development).to_sym)
     end
 
     module ClassMethods
-      # Public: Returns current environment.
+      # Yields if current environment matches one of the given environments.
       #
-      # Examples
+      #   class MyApp < Tynn
+      #     configure(:development, :staging) do
+      #       use(BetterErrors::Middleware)
+      #     end
+      #
+      #     configure(:production) do
+      #       plugin(Tynn::SSL)
+      #     end
+      #   end
+      #
+      def configure(*envs)
+        yield(self) if envs.include?(environment)
+      end
+
+      # Returns the current environment for the application.
       #
       #   Tynn.environment
       #   # => :development
       #
-      #   Tynn.set(:environment, :test)
+      #   Tynn.set(environment, :test)
       #
       #   Tynn.environment
       #   # => :test
       #
       def environment
-        return settings[:environment]
+        settings[:environment]
       end
 
-      # Public: Returns +true+ if the current environment is +:development+.
-      # Otherwise returns +false+.
-      #
-      # Examples
+      # Checks if current environment is development. Returns <tt>true</tt> if
+      # <tt>environment</tt> is <tt>:development</tt>. Otherwise, <tt>false</tt>.
       #
       #   Tynn.set(:environment, :test)
       #   Tynn.development? # => false
@@ -55,13 +72,11 @@ class Tynn
       #   Tynn.development? # => true
       #
       def development?
-        return environment == :development
+        environment == :development
       end
 
-      # Public: Returns +true+ if the current environment is +:test+.
-      # Otherwise returns +false+.
-      #
-      # Examples
+      # Checks if current environment is test. Returns <tt>true</tt> if
+      # <tt>environment</tt> is <tt>:test</tt>. Otherwise, <tt>false</tt>.
       #
       #   Tynn.set(:environment, :development)
       #   Tynn.test? # => false
@@ -70,13 +85,11 @@ class Tynn
       #   Tynn.test? # => true
       #
       def test?
-        return environment == :test
+        environment == :test
       end
 
-      # Public: Returns +true+ if the current environment is +:production+.
-      # Otherwise returns +false+.
-      #
-      # Examples
+      # Checks if current environment is production. Returns <tt>true</tt> if
+      # <tt>environment</tt> is <tt>:production</tt>. Otherwise, <tt>false</tt>.
       #
       #   Tynn.set(:environment, :development)
       #   Tynn.production? # => false
@@ -85,7 +98,20 @@ class Tynn
       #   Tynn.production? # => true
       #
       def production?
-        return environment == :production
+        environment == :production
+      end
+
+      # Checks if current environment is staging. Returns <tt>true</tt> if
+      # <tt>environment</tt> is <tt>:staging</tt>. Otherwise, <tt>false</tt>.
+      #
+      #   Tynn.set(environment, :test)
+      #   Tynn.staging? # => false
+      #
+      #   Tynn.set(:environment, :staging)
+      #   Tynn.staging? # => true
+      #
+      def staging?
+        environment == :staging
       end
     end
   end