hanami-controller 1.3.2 → 2.0.0.alpha3

data/lib/hanami/action/callable.rb

@@ -1,92 +0,0 @@
-module Hanami
-  module Action
-    module Callable
-      # Execute application logic.
-      # It implements the Rack protocol.
-      #
-      # The request params are passed as an argument to the `#call` method.
-      #
-      # If routed with Hanami::Router, it extracts the relevant bits from the
-      # Rack `env` (eg the requested `:id`).
-      #
-      # Otherwise everything it's passed as it is: the full Rack `env`
-      # in production, and the given `Hash` for unit tests. See the examples
-      # below.
-      #
-      # Application developers are forced to implement this method in their
-      # actions.
-      #
-      # @param env [Hash] the full Rack env or the params. This value may vary,
-      #   see the examples below.
-      #
-      # @return [Array] a serialized Rack response (eg. `[200, {}, ["Hi!"]]`)
-      #
-      # @since 0.1.0
-      #
-      # @example with Hanami::Router
-      #   require 'hanami/controller'
-      #
-      #    class Show
-      #      include Hanami::Action
-      #
-      #      def call(params)
-      #        # ...
-      #        puts params # => { id: 23 } extracted from Rack env
-      #      end
-      #    end
-      #
-      # @example Standalone
-      #   require 'hanami/controller'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #
-      #     def call(params)
-      #       # ...
-      #       puts params
-      #         # => { :"rack.version"=>[1, 2],
-      #         #      :"rack.input"=>#<StringIO:0x007fa563463948>, ... }
-      #     end
-      #   end
-      #
-      # @example Unit Testing
-      #   require 'hanami/controller'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #
-      #     def call(params)
-      #       # ...
-      #       puts params # => { id: 23, key: 'value' } passed as it is from testing
-      #     end
-      #   end
-      #
-      #   action   = Show.new
-      #   response = action.call({ id: 23, key: 'value' })
-      def call(env)
-        _rescue do
-          @_env    = env
-          @headers = ::Rack::Utils::HeaderHash.new(configuration.default_headers)
-          @params  = self.class.params_class.new(@_env)
-          super @params
-        end
-
-        finish
-      end
-
-      private
-
-      # Prepare the Rack response before the control is returned to the
-      # webserver.
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see Hanami::Action#finish
-      def finish
-        super
-        response
-      end
-    end
-  end
-end

data/lib/hanami/action/callbacks.rb

@@ -1,214 +0,0 @@
-require 'hanami/utils/class_attribute'
-require 'hanami/utils/callbacks'
-
-module Hanami
-  module Action
-    # Before and after callbacks
-    #
-    # @since 0.1.0
-    # @see Hanami::Action::ClassMethods#before
-    # @see Hanami::Action::ClassMethods#after
-    module Callbacks
-      # Override Ruby's hook for modules.
-      # It includes callbacks logic
-      #
-      # @param base [Class] the target action
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see http://www.ruby-doc.org/core/Module.html#method-i-included
-      def self.included(base)
-        base.class_eval do
-          extend  ClassMethods
-          prepend InstanceMethods
-        end
-      end
-
-      # Callbacks API class methods
-      #
-      # @since 0.1.0
-      # @api private
-      module ClassMethods
-        # Override Ruby's hook for modules.
-        # It includes callbacks logic
-        #
-        # @param base [Class] the target action
-        #
-        # @since 0.1.0
-        # @api private
-        #
-        # @see http://www.ruby-doc.org/core/Module.html#method-i-extended
-        def self.extended(base)
-          base.class_eval do
-            include Utils::ClassAttribute
-
-            class_attribute :before_callbacks
-            self.before_callbacks = Utils::Callbacks::Chain.new
-
-            class_attribute :after_callbacks
-            self.after_callbacks = Utils::Callbacks::Chain.new
-          end
-        end
-
-        # Define a callback for an Action.
-        # The callback will be executed **before** the action is called, in the
-        # order they are added.
-        #
-        # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
-        #   each of them is representing a name of a method available in the
-        #   context of the Action.
-        #
-        # @param blk [Proc] an anonymous function to be executed
-        #
-        # @return [void]
-        #
-        # @since 0.3.2
-        #
-        # @see Hanami::Action::Callbacks::ClassMethods#append_after
-        #
-        # @example Method names (symbols)
-        #   require 'hanami/controller'
-        #
-        #   class Show
-        #     include Hanami::Action
-        #
-        #     before :authenticate, :set_article
-        #
-        #     def call(params)
-        #     end
-        #
-        #     private
-        #     def authenticate
-        #       # ...
-        #     end
-        #
-        #     # `params` in the method signature is optional
-        #     def set_article(params)
-        #       @article = Article.find params[:id]
-        #     end
-        #   end
-        #
-        #   # The order of execution will be:
-        #   #
-        #   # 1. #authenticate
-        #   # 2. #set_article
-        #   # 3. #call
-        #
-        # @example Anonymous functions (Procs)
-        #   require 'hanami/controller'
-        #
-        #   class Show
-        #     include Hanami::Action
-        #
-        #     before { ... } # 1 do some authentication stuff
-        #     before {|params| @article = Article.find params[:id] } # 2
-        #
-        #     def call(params)
-        #     end
-        #   end
-        #
-        #   # The order of execution will be:
-        #   #
-        #   # 1. authentication
-        #   # 2. set the article
-        #   # 3. #call
-        def append_before(*callbacks, &blk)
-          before_callbacks.append(*callbacks, &blk)
-        end
-
-        # @since 0.1.0
-        alias_method :before, :append_before
-
-        # Define a callback for an Action.
-        # The callback will be executed **after** the action is called, in the
-        # order they are added.
-        #
-        # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
-        #   each of them is representing a name of a method available in the
-        #   context of the Action.
-        #
-        # @param blk [Proc] an anonymous function to be executed
-        #
-        # @return [void]
-        #
-        # @since 0.3.2
-        #
-        # @see Hanami::Action::Callbacks::ClassMethods#append_before
-        def append_after(*callbacks, &blk)
-          after_callbacks.append(*callbacks, &blk)
-        end
-
-        # @since 0.1.0
-        alias_method :after, :append_after
-
-        # Define a callback for an Action.
-        # The callback will be executed **before** the action is called.
-        # It will add the callback at the beginning of the callbacks' chain.
-        #
-        # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
-        #   each of them is representing a name of a method available in the
-        #   context of the Action.
-        #
-        # @param blk [Proc] an anonymous function to be executed
-        #
-        # @return [void]
-        #
-        # @since 0.3.2
-        #
-        # @see Hanami::Action::Callbacks::ClassMethods#prepend_after
-        def prepend_before(*callbacks, &blk)
-          before_callbacks.prepend(*callbacks, &blk)
-        end
-
-        # Define a callback for an Action.
-        # The callback will be executed **after** the action is called.
-        # It will add the callback at the beginning of the callbacks' chain.
-        #
-        # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
-        #   each of them is representing a name of a method available in the
-        #   context of the Action.
-        #
-        # @param blk [Proc] an anonymous function to be executed
-        #
-        # @return [void]
-        #
-        # @since 0.3.2
-        #
-        # @see Hanami::Action::Callbacks::ClassMethods#prepend_before
-        def prepend_after(*callbacks, &blk)
-          after_callbacks.prepend(*callbacks, &blk)
-        end
-      end
-
-      # Callbacks API instance methods
-      #
-      # @since 0.1.0
-      # @api private
-      module InstanceMethods
-        # Implements the Rack/Hanami::Action protocol
-        #
-        # @since 0.1.0
-        # @api private
-        def call(params)
-          _run_before_callbacks(params)
-          super
-          _run_after_callbacks(params)
-        end
-
-        private
-        # @since 0.1.0
-        # @api private
-        def _run_before_callbacks(params)
-          self.class.before_callbacks.run(self, params)
-        end
-
-        # @since 0.1.0
-        # @api private
-        def _run_after_callbacks(params)
-          self.class.after_callbacks.run(self, params)
-        end
-      end
-    end
-  end
-end

data/lib/hanami/action/configurable.rb

@@ -1,50 +0,0 @@
-require 'hanami/utils/class_attribute'
-
-module Hanami
-  module Action
-    # Configuration API
-    #
-    # @since 0.2.0
-    #
-    # @see Hanami::Controller::Configuration
-    module Configurable
-      # Override Ruby's hook for modules.
-      # It includes configuration logic
-      #
-      # @param base [Class] the target action
-      #
-      # @since 0.2.0
-      # @api private
-      #
-      # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #   end
-      #
-      #   Show.configuration
-      def self.included(base)
-        config = Hanami::Controller::Configuration.for(base)
-
-        base.class_eval do
-          include Utils::ClassAttribute
-
-          class_attribute :configuration
-          self.configuration = config
-        end
-
-        config.copy!(base)
-      end
-
-      private
-
-      # @since 0.2.0
-      def configuration
-        self.class.configuration
-      end
-    end
-  end
-end

data/lib/hanami/action/exposable/guard.rb

@@ -1,104 +0,0 @@
-require 'hanami/controller/error'
-
-module Hanami
-  module Controller
-    # Exposure of reserved words
-    #
-    # @since 0.7.1
-    class IllegalExposureError < Error
-    end
-  end
-
-  module Action
-    module Exposable
-      # Guard for Exposures API.
-      # Prevents exposure of reserved words
-      #
-      # @since 0.7.1
-      # @api private
-      #
-      # @see Hanami::Action::Exposable::Guard::ClassMethods#expose
-      # @see Hanami::Action::Exposable::Guard::ClassMethods#reserved_word?
-      module Guard
-        # Override Ruby's hook for modules.
-        # It prepends a guard for the exposures logic
-        #
-        # @param base [Class] the target action
-        #
-        # @since 0.7.1
-        # @api private
-        #
-        # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
-        def self.included(base)
-          class << base
-            prepend ClassMethods
-          end
-        end
-
-        # Exposures API Guard class methods
-        #
-        # @since 0.7.1
-        # @api private
-        module ClassMethods
-          # Prevents exposure if names contain a reserved word.
-          #
-          # @param names [Array<Symbol>] the name(s) of the attribute(s) to be
-          #   exposed
-          #
-          # @return [void]
-          #
-          # @since 0.7.1
-          # @api private
-          def expose(*names)
-            detect_reserved_words!(names)
-
-            super
-          end
-
-          private
-
-          # Raises error if given names  contain a reserved word.
-          #
-          # @param names [Array<Symbol>] a list of names to be checked.
-          #
-          # @return [void]
-          #
-          # @raise [IllegalExposeError] if names contain one or more of reserved
-          #   words
-          #
-          # @since 0.7.1
-          # @api private
-          def detect_reserved_words!(names)
-            names.each do |name|
-              if reserved_word?(name)
-                raise Hanami::Controller::IllegalExposureError.new("#{name} is a reserved word. It cannot be exposed")
-              end
-            end
-          end
-
-          # Checks if a string is a reserved word
-          #
-          # Reserved word is a name of the method defined in one of the modules
-          # of a given namespace.
-          #
-          # @param name [Symbol] the word to be checked
-          # @param namespace [String] the namespace containing internal modules
-          #
-          # @return [true, false]
-          #
-          # @since 0.7.1
-          # @api private
-          def reserved_word?(name, namespace = 'Hanami')
-            if method_defined?(name) || private_method_defined?(name)
-              method_owner = instance_method(name).owner
-
-              Utils::String.namespace(method_owner) == namespace
-            else
-              false
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hanami/action/exposable.rb

@@ -1,126 +0,0 @@
-require 'hanami/action/exposable/guard'
-
-module Hanami
-  module Action
-    # Exposures API
-    #
-    # @since 0.1.0
-    #
-    # @see Hanami::Action::Exposable::ClassMethods#expose
-    module Exposable
-      # Override Ruby's hook for modules.
-      # It includes exposures logic
-      #
-      # @param base [Class] the target action
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
-      def self.included(base)
-        base.class_eval do
-          extend ClassMethods
-          include Guard
-
-          _expose :params
-        end
-      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.
-        #
-        # @param names [Array<Symbol>] the name(s) of the attribute(s) to be
-        #   exposed
-        #
-        # @return [void]
-        #
-        # @since 0.1.0
-        #
-        # @example
-        #   require 'hanami/controller'
-        #
-        #   class Show
-        #     include Hanami::Action
-        #
-        #     expose :article, :tags
-        #
-        #     def call(params)
-        #       @article = Article.find params[:id]
-        #       @tags    = Tag.for(article)
-        #     end
-        #   end
-        #
-        #   action = Show.new
-        #   action.call({id: 23})
-        #
-        #   action.article # => #<Article ...>
-        #   action.tags    # => [#<Tag ...>, #<Tag ...>]
-        #
-        #   action.exposures # => { :article => #<Article ...>, :tags => [ ... ] }
-        def expose(*names)
-          class_eval do
-            names.each do |name|
-              attr_reader(name) unless attr_reader?(name)
-            end
-
-            exposures.push(*names)
-          end
-        end
-
-        # Alias of #expose to be used in internal modules.
-        # #_expose is not watched by the Guard
-        alias _expose expose
-
-        # Set of exposures attribute names
-        #
-        # @return [Array] the exposures attribute names
-        #
-        # @since 0.1.0
-        # @api private
-        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
-      #
-      # @return [Hash] the exposures
-      #
-      # @since 0.1.0
-      #
-      # @see Hanami::Action::Exposable::ClassMethods.expose
-      def exposures
-        @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 Hanami::Action#finish
-      def finish
-        super
-        exposures
-      end
-    end
-  end
-end

data/lib/hanami/action/head.rb

@@ -1,121 +0,0 @@
-module Hanami
-  module Action
-    # Ensures to not send body or headers for HEAD requests and/or for status
-    # codes that doesn't allow them.
-    #
-    # @since 0.3.2
-    #
-    # @see http://www.ietf.org/rfc/rfc2616.txt
-    module Head
-
-      # Status codes that by RFC must not include a message body
-      #
-      # @since 0.3.2
-      # @api private
-      HTTP_STATUSES_WITHOUT_BODY = Set.new((100..199).to_a << 204 << 205 << 304).freeze
-
-
-      # Entity headers allowed in blank body responses, according to
-      # RFC 2616 - Section 10 (HTTP 1.1).
-      #
-      # "The response MAY include new or updated metainformation in the form
-      #   of entity-headers".
-      #
-      # @since 0.4.0
-      # @api private
-      #
-      # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5
-      # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec7.html
-      ENTITY_HEADERS = {
-        'Allow'            => true,
-        'Content-Encoding' => true,
-        'Content-Language' => true,
-        'Content-Location' => true,
-        'Content-MD5'      => true,
-        'Content-Range'    => true,
-        'Expires'          => true,
-        'Last-Modified'    => true,
-        'extension-header' => true
-      }.freeze
-
-      # Ensures to not send body or headers for HEAD requests and/or for status
-      # codes that doesn't allow them.
-      #
-      # @since 0.3.2
-      # @api private
-      #
-      # @see Hanami::Action#finish
-      def finish
-        super
-
-        if _requires_no_body?
-          @_body = nil
-          @headers.reject! {|header,_| !keep_response_header?(header) }
-        end
-      end
-
-      protected
-      # @since 0.3.2
-      # @api private
-      def _requires_no_body?
-        HTTP_STATUSES_WITHOUT_BODY.include?(@_status) || head?
-      end
-
-      private
-      # According to RFC 2616, when a response MUST have an empty body, it only
-      # allows Entity Headers.
-      #
-      # For instance, a <tt>204</tt> doesn't allow <tt>Content-Type</tt> or any
-      # other custom header.
-      #
-      # This restriction is enforced by <tt>Hanami::Action::Head#finish</tt>.
-      #
-      # However, there are cases that demand to bypass this rule to set meta
-      # informations via headers.
-      #
-      # An example is a <tt>DELETE</tt> request for a JSON API application.
-      # It returns a <tt>204</tt> but still wants to specify the rate limit
-      # quota via <tt>X-Rate-Limit</tt>.
-      #
-      # @since 0.5.0
-      #
-      # @see Hanami::Action::HEAD#finish
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   module Books
-      #     class Destroy
-      #       include Hanami::Action
-      #
-      #       def call(params)
-      #         # ...
-      #         self.headers.merge!(
-      #           'Last-Modified' => 'Fri, 27 Nov 2015 13:32:36 GMT',
-      #           'X-Rate-Limit'  => '4000',
-      #           'Content-Type'  => 'application/json',
-      #           'X-No-Pass'     => 'true'
-      #         )
-      #
-      #         self.status = 204
-      #       end
-      #
-      #       private
-      #
-      #       def keep_response_header?(header)
-      #         super || header == 'X-Rate-Limit'
-      #       end
-      #     end
-      #   end
-      #
-      #   # Only the following headers will be sent:
-      #   #  * Last-Modified - because we used `super' in the method that respects the HTTP RFC
-      #   #  * X-Rate-Limit  - because we explicitely allow it
-      #
-      #   # Both Content-Type and X-No-Pass are removed because they're not allowed
-      def keep_response_header?(header)
-        ENTITY_HEADERS.include?(header)
-      end
-    end
-  end
-end