lotus-controller 0.2.0 → 0.3.0

data/lib/lotus/action/cache/expires.rb

@@ -0,0 +1,73 @@
+require 'lotus/action/cache/cache_control'
+
+module Lotus
+  module Action
+    module Cache
+
+      # Module with Expires logic
+      #
+      # @since 0.3.0
+      # @api private
+      module Expires
+
+        # The HTTP header for Expires
+        #
+        # @since 0.3.0
+        # @api private
+        HEADER = 'Expires'.freeze
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          def expires(amount, *values)
+            @expires_directives ||= Directives.new(amount, *values)
+          end
+
+          def expires_directives
+            @expires_directives || Object.new.tap do |null_object|
+              def null_object.headers
+                Hash.new
+              end
+            end
+          end
+        end
+
+        # Finalize the response including default cache headers into the response
+        #
+        # @since 0.3.0
+        # @api private
+        #
+        # @see Lotus::Action#finish
+        def finish
+          super
+          headers.merge!(self.class.expires_directives.headers) unless headers.include? HEADER
+        end
+
+        # Class which stores Expires directives
+        #
+        # @since 0.3.0
+        #
+        # @api private
+        #
+        class Directives
+          def initialize(amount, *values)
+            @amount = amount
+            @cache_control = Lotus::Action::Cache::CacheControl::Directives.new(*(values << { max_age: amount }))
+          end
+
+          def headers
+            { HEADER => time.httpdate }.merge(@cache_control.headers)
+          end
+
+          private
+
+          def time
+            Time.now + @amount.to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lotus/action/callable.rb

@@ -69,13 +69,14 @@ module Lotus
         _rescue do
           @_env    = env
           @headers = ::Rack::Utils::HeaderHash.new
-          super        Params.new(@_env)
+          @params  = self.class.params_class.new(@_env)
+          super @params
         end
 
         finish
       end
 
-      protected
+      private
 
       # Prepare the Rack response before the control is returned to the
       # webserver.

data/lib/lotus/action/callbacks.rb

@@ -25,6 +25,10 @@ module Lotus
         end
       end
 
+      # Callbacks API class methods
+      #
+      # @since 0.1.0
+      # @api private
       module ClassMethods
         # Override Ruby's hook for modules.
         # It includes callbacks logic
@@ -131,6 +135,10 @@ module Lotus
         end
       end
 
+      # Callbacks API instance methods
+      #
+      # @since 0.1.0
+      # @api private
       module InstanceMethods
         # Implements the Rack/Lotus::Action protocol
         #

data/lib/lotus/action/configurable.rb

@@ -36,10 +36,11 @@ module Lotus
           self.configuration = config
         end
 
-        config.load!(base)
+        config.copy!(base)
       end
 
-      protected
+      private
+
       def configuration
         self.class.configuration
       end

data/lib/lotus/action/cookies.rb

@@ -10,20 +10,8 @@ module Lotus
     #
     # @see Lotus::Action::Cookies#cookies
     module Cookies
-
       protected
 
-      # Finalize the response by flushing cookies into the response
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see Lotus::Action#finish
-      def finish
-        super
-        cookies.finish
-      end
-
       # Gets the cookies from the request and expose them as an Hash
       #
       # @return [Lotus::Action::CookieJar] the cookies
@@ -55,6 +43,19 @@ module Lotus
       def cookies
         @cookies ||= CookieJar.new(@_env.dup, headers)
       end
+
+      private
+
+      # Finalize the response by flushing cookies into the response
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see Lotus::Action#finish
+      def finish
+        super
+        cookies.finish
+      end
     end
   end
 end

data/lib/lotus/action/exposable.rb

@@ -19,6 +19,10 @@ module Lotus
         base.extend ClassMethods
       end
 
+      # Exposures API class methods
+      #
+      # @since 0.1.0
+      # @api private
       module ClassMethods
         # Expose the given attributes on the outside of the object with
         # a getter and a special method called #exposures.
@@ -53,7 +57,10 @@ module Lotus
         #   action.exposures # => { :article => #<Article ...>, :tags => [ ... ] }
         def expose(*names)
           class_eval do
-            attr_reader(   *names)
+            names.each do |name|
+              attr_reader(name) unless attr_reader?(name)
+            end
+
             exposures.push(*names)
           end
         end
@@ -67,6 +74,15 @@ module Lotus
         def exposures
           @exposures ||= []
         end
+
+        private
+        # Check if the attr_reader is already defined
+        #
+        # @since 0.3.0
+        # @api private
+        def attr_reader?(name)
+          (instance_methods | private_instance_methods).include?(name)
+        end
       end
 
       # Set of exposures
@@ -77,12 +93,23 @@ module Lotus
       #
       # @see Lotus::Action::Exposable::ClassMethods.expose
       def exposures
-        {}.tap do |result|
-          self.class.exposures.each do |exposure|
-            result[exposure] = send(exposure)
+        @exposures ||= {}.tap do |result|
+          self.class.exposures.each do |name|
+            result[name] = send(name)
           end
         end
       end
+
+      # Finalize the response
+      #
+      # @since 0.3.0
+      # @api private
+      #
+      # @see Lotus::Action#finish
+      def finish
+        super
+        exposures
+      end
     end
   end
 end

data/lib/lotus/action/flash.rb

@@ -0,0 +1,141 @@
+module Lotus
+  module Action
+    # Container useful to transport data with the HTTP session
+    # It has a life span of one HTTP request or redirect.
+    #
+    # @since 0.3.0
+    # @api private
+    class Flash
+      # Session key where the data is stored
+      #
+      # @since 0.3.0
+      # @api private
+      SESSION_KEY = :__flash
+
+      # Initialize a new Flash instance
+      #
+      # @param session [Rack::Session::Abstract::SessionHash] the session
+      # @param request_id [String] the HTTP Request ID
+      #
+      # @return [Lotus::Action::Flash] the flash
+      #
+      # @see http://www.rubydoc.info/gems/rack/Rack/Session/Abstract/SessionHash
+      # @see Lotus::Action::Rack#session_id
+      def initialize(session, request_id)
+        @session    = session
+        @request_id = request_id
+
+        session[SESSION_KEY]             ||= {}
+        session[SESSION_KEY][request_id] ||= {}
+      end
+
+      # Set the given value for the given key
+      #
+      # @param key [#to_s] the key
+      # @param value [Object] the value
+      #
+      # @since 0.3.0
+      # @api private
+      def []=(key, value)
+        data[key] = value
+      end
+
+      # Get the value associated to the given key, if any
+      #
+      # @return [Object,NilClass] the value
+      #
+      # @since 0.3.0
+      # @api private
+      def [](key)
+        data.fetch(key) do
+          _values.find {|data| !data[key].nil? }
+        end
+      end
+
+      # Removes entirely the flash from the session if it has stale contents
+      # or if empty.
+      #
+      # @return [void]
+      #
+      # @since 0.3.0
+      # @api private
+      def clear
+        # FIXME we're just before a release and I can't find a proper way to reproduce
+        # this bug that I've found via a browser.
+        #
+        # It may happen that `#flash` is nil, and those two methods will fail
+        unless flash.nil?
+          expire_stale!
+          remove!
+        end
+      end
+
+      # Check if there are contents stored in the flash from the current or the
+      # previous request.
+      #
+      # @return [TrueClass,FalseClass] the result of the check
+      #
+      # @since 0.3.0
+      # @api private
+      def empty?
+        _values.all?(&:empty?)
+      end
+
+      private
+
+      # The flash registry that holds the data for **all** the recent requests
+      #
+      # @return [Hash] the flash
+      #
+      # @since 0.3.0
+      # @api private
+      def flash
+        @session[SESSION_KEY]
+      end
+
+      # The flash registry that holds the data **only for** the current request
+      #
+      # @return [Hash] the flash for the current request
+      #
+      # @since 0.3.0
+      # @api private
+      def data
+        flash[@request_id]
+      end
+
+      # Expire the stale data from the previous request.
+      #
+      # @return [void]
+      #
+      # @since 0.3.0
+      # @api private
+      def expire_stale!
+        flash.each do |request_id, _|
+          flash.delete(request_id) if @request_id != request_id
+        end
+      end
+
+      # Remove the flash entirely from the session if empty.
+      #
+      # @return [void]
+      #
+      # @since 0.3.0
+      # @api private
+      #
+      # @see Lotus::Action::Flash#empty?
+      def remove!
+        @session.delete(SESSION_KEY) if empty?
+      end
+
+      # Values from all the stored requests
+      #
+      # @return [Array]
+      #
+      # @since 0.3.0
+      # @api private
+      def _values
+        flash.values
+      end
+    end
+  end
+end

data/lib/lotus/action/glue.rb

@@ -0,0 +1,35 @@
+module Lotus
+  module Action
+    # Glue code for full stack Lotus applications
+    #
+    # @api private
+    # @since 0.3.0
+    module Glue
+      # Rack environment key that indicates where the action instance is passed
+      #
+      # @api private
+      # @since 0.3.0
+      ENV_KEY = 'lotus.action'.freeze
+
+      # Override Ruby's Module#included
+      #
+      # @api private
+      # @since 0.3.0
+      def self.included(base)
+        base.class_eval { expose :format }
+      end
+
+      protected
+      # Put the current instance into the Rack environment
+      #
+      # @api private
+      # @since 0.3.0
+      #
+      # @see Lotus::Action#finish
+      def finish
+        super
+        @_env[ENV_KEY] = self
+      end
+    end
+  end
+end

data/lib/lotus/action/mime.rb

@@ -11,23 +11,33 @@ module Lotus
       # The key that returns accepted mime types from the Rack env
       #
       # @since 0.1.0
+      # @api private
       HTTP_ACCEPT          = 'HTTP_ACCEPT'.freeze
 
       # The header key to set the mime type of the response
       #
       # @since 0.1.0
+      # @api private
       CONTENT_TYPE         = 'Content-Type'.freeze
 
       # The default mime type for an incoming HTTP request
       #
       # @since 0.1.0
+      # @api private
       DEFAULT_ACCEPT       = '*/*'.freeze
 
       # The default mime type that is returned in the response
       #
       # @since 0.1.0
+      # @api private
       DEFAULT_CONTENT_TYPE = 'application/octet-stream'.freeze
 
+      # The default charset that is returned in the response
+      #
+      # @since 0.3.0
+      # @api private
+      DEFAULT_CHARSET = 'utf-8'.freeze
+
       # Override Ruby's hook for modules.
       # It includes Mime types logic
       #
@@ -50,11 +60,11 @@ module Lotus
             raise Lotus::Controller::UnknownFormatError.new(format)
         end
 
-        protected
+        private
 
         # Restrict the access to the specified mime type symbols.
         #
-        # @param mime_types[Array<Symbol>] one or more symbols representing mime type(s)
+        # @param formats[Array<Symbol>] one or more symbols representing mime type(s)
         #
         # @raise [Lotus::Controller::UnknownFormatError] if the symbol cannot
         #   be converted into a mime type
@@ -176,7 +186,62 @@ module Lotus
         @content_type || accepts || default_content_type || DEFAULT_CONTENT_TYPE
       end
 
-      protected
+      # Action charset setter, receives new charset value
+      #
+      # @return [String] the charset of the request.
+      #
+      # @since 0.3.0
+      #
+      # @example
+      #   require 'lotus/controller'
+      #
+      #   class Show
+      #     include Lotus::Action
+      #
+      #     def call(params)
+      #       # ...
+      #       self.charset = 'koi8-r'
+      #     end
+      #   end
+      def charset=(value)
+        @charset = value
+      end
+
+      # The charset that will be automatically set in the response.
+      #
+      # It prefers, in order:
+      #   * Explicit set value (see #charset=)
+      #   * Default configuration charset
+      #   * Default content type
+      #
+      # To override the value, use <tt>#charset=</tt>
+      #
+      # @return [String] the charset of the request.
+      #
+      # @since 0.3.0
+      #
+      # @see Lotus::Action::Mime#charset=
+      # @see Lotus::Configuration#default_charset
+      # @see Lotus::Action::Mime#default_charset
+      # @see Lotus::Action::Mime#DEFAULT_CHARSET
+      #
+      # @example
+      #   require 'lotus/controller'
+      #
+      #   class Show
+      #     include Lotus::Action
+      #
+      #     def call(params)
+      #       # ...
+      #       charset # => 'text/html'
+      #     end
+      #   end
+      def charset
+        @charset || default_charset || DEFAULT_CHARSET
+      end
+
+      private
+
       # Finalize the response by setting the current content type
       #
       # @since 0.1.0
@@ -185,7 +250,7 @@ module Lotus
       # @see Lotus::Action#finish
       def finish
         super
-        headers.merge! CONTENT_TYPE => content_type
+        headers[CONTENT_TYPE] = content_type_with_charset
       end
 
       # Sets the given format and corresponding content type.
@@ -368,6 +433,19 @@ module Lotus
         configuration.format_for(content_type) ||
           ::Rack::Mime::MIME_TYPES.key(content_type).gsub(/\A\./, '').to_sym
       end
+
+      # @since 0.3.0
+      # @api private
+      def default_charset
+        configuration.default_charset
+      end
+
+      # @since 0.3.0
+      # @api private
+      def content_type_with_charset
+        "#{content_type}; charset=#{charset}"
+      end
+
     end
   end
 end