lennarb 0.1.5 → 0.1.7

data/lib/lenna/router/namespace_stack.rb

@@ -1,73 +1,77 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module Lenna
-  class Router
-    # This class is used to manage the namespaces.
-    #
-    # @api private
-    class NamespaceStack
-      # @return [Array] The stack of namespaces
-      #
-      # @api private
-      attr_reader :stack
+	class Router
+		# This class is used to manage the namespaces.
+		#
+		# @private `Since v0.1.0`
+		#
+		class NamespaceStack
+			# @return [Array] The stack of namespaces
+			#
+			# @private
+			#
+			attr_reader :stack
 
-      # @return [void]
-      #
-      # @api private
-      def initialize = @stack = ['']
+			# The initialize method is used to initialize the stack of namespaces.
+			#
+			# @private
+			#
+			# @attibute stack [Array] The stack of namespaces
+			#
+			# @return [void]
+			#
+			def initialize = @stack = ['']
 
-      # This method is used to push a prefix to the stack.
-      #
-      # @param prefix [String] The prefix to be pushed
-      # @return       [void]
-      #
-      # @example:
-      #
-      #  stack = NamespaceStack.new
-      #  stack.push('/users')
-      #  stack.current_prefix # => '/users'
-      #
-      # @see #resolve_prefix
-      #
-      # @api private
-      def push(prefix)
-        @stack.push(resolve_prefix(prefix))
-      end
+			# This method is used to push a prefix to the stack.
+			#
+			# @parameter prefix [String] The prefix to be pushed
+			#
+			# @return           [void]
+			#
+			# ex.
+			#
+			#  stack = NamespaceStack.new
+			#  stack.push('/users')
+			#  stack.current_prefix # => '/users'
+			#
+			# @see #resolve_prefix
+			#
+			def push(prefix)
+				@stack.push(resolve_prefix(prefix))
+			end
 
-      # @return [String] The popped prefix
-      #
-      # @api private
-      def pop
-        @stack.pop unless @stack.size == 1
-      end
+			# This method is used to remove the last prefix from the stack.
+			#
+			# @return [String] The popped prefix
+			#
+			def pop
+				@stack.pop unless @stack.size == 1
+			end
 
-      # @return [String] The current prefix
-      #
-      # @api private
-      #
-      # @since 0.1.0
-      def current_prefix = @stack.last
+			# @return [String] The current prefix
+			#
+			def current_prefix = @stack.last
 
-      # The to_s method is used to return the current prefix.
-      #
-      # @return [String] The current prefix
-      #
-      # @api private
-      def to_s = current_prefix
+			# The to_s method is used to return the current prefix.
+			#
+			# @return [String] The current prefix
+			#
+			def to_s = current_prefix
 
-      private
+			private
 
-      # The resolve_prefix method is used to resolve the prefix.
-      #
-      # @param prefix [String] The prefix to be resolved
-      # @return       [String] The resolved prefix
-      #
-      # @see #current_prefix
-      #
-      # @since 0.1.0
-      def resolve_prefix(prefix)
-        current_prefix + prefix
-      end
-    end
-  end
+			# The resolve_prefix method is used to resolve the prefix.
+			#
+			# @parameter prefix [String] The prefix to be resolved
+			# @return           [String] The resolved prefix
+			#
+			def resolve_prefix(prefix)
+				current_prefix + prefix
+			end
+		end
+	end
 end

data/lib/lenna/router/request.rb

@@ -1,117 +1,141 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module Lenna
-  class Router
-    # The Request class is responsible for managing the request.
-    #
-    # @attr headers [Hash] the request headers
-    # @attr body    [Hash] the request body
-    # @attr params  [Hash] the request params
-    class Request < ::Rack::Request
+	class Router
+		# The Request class is responsible for managing the request.
+		#
+		# @attr headers [Hash] the request headers
+		# @attr body    [Hash] the request body
+		# @attr params  [Hash] the request params
+		#
+		# @public `Since v0.1.0`
+		#
+		class Request < ::Rack::Request
+			# This method is used to set the request headers.
+			#
+			# @parameter name  [String] the header name
+			# @parameter value [String] the header value
+			#
+			# @return          [String] the header value
+			#
+			# @public
+			#
+			# ex.
+			#   request.put_header('Foo', 'bar')
+			#
+			#  request.headers
+			#  # => { 'Foo' => 'bar' }
+			#
+			def put_header(name, value) = headers[name] = value
 
-      # This method is used to set the request params.
-      #
-      # @param params [Hash] the request params
-      #
-      # @return [Hash] the request params
-      #
-      # @api public
-      def assign_params(params) = @params = params
+			# This method is used to set the request params.
+			#
+			# @parameter params [Hash] the request params
+			#
+			# @return [Hash] the request params
+			#
+			# @public
+			#
+			def assign_params(params) = @params = params
 
-      # This method is used to parse the body params.
-      #
-      # @return [Hash] the request params
-      #
-      # @api public
-      def params = super.merge(parse_body_params)
+			# This method is used to parse the body params.
+			#
+			# @return [Hash] the request params
+			#
+			# @public
+			#
+			def params = super.merge(parse_body_params)
 
-      # This method rewinds the body
-      #
-      # @return [String] the request body content
-      #
-      # @api public
-      #
-      # @since 0.1.0
-      def body_content
-        body.rewind
-        body.read
-      end
+			# This method rewinds the body
+			#
+			# @return [String] the request body content
+			#
+			# @public
+			#
+			def body
+				super.rewind
+				super.read
+			end
 
-      # This method returns the headers in a normalized way.
-      #
-      # @return [Hash] the request headers
-      #
-      # @api public
-      #
-      # @example:
-      # Turn this:
-      # HTTP_FOO=bar Foo=bar
-      def headers
-        content_type = env['CONTENT_TYPE']
-        @headers ||= env.select { |k, _| k.start_with?('HTTP_') }
-                        .transform_keys { |k| format_header_name(k) }
+			# This method returns the headers in a normalized way.
+			#
+			# @public
+			#
+			# @return [Hash] the request headers
+			#
+			# ex.
+			#		Turn this:
+			#		HTTP_FOO=bar Foo=bar
+			#
+			def headers
+				content_type = env['CONTENT_TYPE']
+				@headers ||= env.select { |k, _| k.start_with?('HTTP_') }
+										.transform_keys { |k| format_header_name(k) }
 
-        @headers['Content-Type'] = content_type if content_type
-        @headers
-      end
+				@headers['Content-Type'] = content_type if content_type
+				@headers
+			end
 
-      # This method returns the request body in a normalized way.
-      #
-      # @return [Hash] the request body
-      #
-      # @api public
-      def json_body = @json_body ||= parse_body_params
+			# This method returns the request body like a json.
+			#
+			# @return [Hash] the request body
+			#
+			def json_body = @json_body ||= parse_body_params
 
-      private
+			private
 
-      def json_request? = media_type == 'application/json'
+			# This method returns the media type.
+			#
+			# @return [String] the request media type
+			#
+			def media_type = headers['Content-Type']
 
-      def parse_json_body
-        @parsed_json_body ||= ::JSON.parse(body_content) if json_request?
-      rescue ::JSON::ParserError
-        {}
-      end
+			# This method parses the json body.
+			#
+			# @return [Hash] the request json body
+			#
+			def parse_json_body
+				@parsed_json_body ||= ::JSON.parse(body)
+			rescue ::JSON::ParserError
+				{}
+			end
 
-      # This method parses the body params.
-      #
-      # @return [Hash] the request body params
-      #
-      # @api private
-      def parse_body_params
-        case media_type
-        when 'application/json'
-          parse_json_body
-        when 'application/x-www-form-urlencoded', 'multipart/form-data'
-          post_params
-        else
-          {}
-        end
-      end
+			# This method parses the body params.
+			#
+			# @return [Hash] the request body params
+			#
+			def parse_body_params
+				case media_type
+				in 'application/json' then parse_json_body
+				else post_params
+				end
+			end
 
-      # This method parses the post params.
-      #
-      # @return [Hash] the request post params
-      #
-      # @api private
-      def post_params
-        @post_params ||=
-          if body_content.empty?
-            {}
-          else
-            ::Rack::Utils.parse_nested_query(body_content)
-          end
-      end
+			# This method parses the post params.
+			#
+			# @return [Hash] the request post params
+			#
+			def post_params
+				@post_params ||=
+					if body.empty?
+						{}
+					else
+						::Rack::Utils.parse_nested_query(body)
+					end
+			end
 
-      # This method formats the header name.
-      #
-      # @param name [String] the header name
-      #
-      # @return [String] the formatted header name
-      #
-      # @api private
-      def format_header_name(name)
-        name.sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
-      end
-    end
-  end
+			# This method formats the header name.
+			#
+			# @parameter name [String] the header name
+			#
+			# @return         [String] the formatted header name
+			#
+			def format_header_name(name)
+				name.sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
+			end
+		end
+	end
 end