lennarb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c397642a693a43af01eac2929b1a43c4f6258f43b63f4dadb6c6bd2245eb54f
-  data.tar.gz: eb65ddcc1896bd51e7f254e22698f8bc9d190c388e9dd892e35d6a348e9d5724
+  metadata.gz: b0e10a539894e1cf41bcebf4c01b086092d36779b1b8aebada8eabc717552348
+  data.tar.gz: 86afa28d62c0b532e08027df8a1847bc4a72b36347388b11f4c6f7aef8c2d345
 SHA512:
-  metadata.gz: d36a2a07a847997c2b55cfb0c47aa894cd6d19ef1214721b3c4d1c8922e93077f0b47e5989b63a6f0fb555f5cee95a4b7938a232c7ddea56e11401a95074e971
-  data.tar.gz: 8827458b308d68e874326b143670112af07e7b03f7945bfdd1db7f3d04c1e22daf196f59bf5c46e0ed741add8b52dc11d7447d545f869620b5efbfb4f50c5efe
+  metadata.gz: '0539b0de41e1de79c84a89204c67931dcf0b015a2401db8bece03ef66e8fc5b7e74c87527bb431d1ec447998b067738bb41127f68917d0dbcfd44ff973294935'
+  data.tar.gz: 88820bc3511a72fda57ef39fac259c69cc632dcb3ad0d9faa4b3514327603cc78cd6e5b6531b4c632a109901883e5ca642fa13904ab8e6445cecea466edde298

data/CHANGELOG.md

@@ -4,26 +4,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [Released]
 
-### Added
-- New feature for the next release.
+## [0.1.1] - 2023-23-11
 
 ### Added
-- Initial release of the project.
+- Introduced `Array.wrap` extension to the `Array` class for more reliable conversion of objects to arrays within the Lennarb router environment. This method ensures consistent array wrapping of single objects and `nil` values.
 
 ### Changed
-- Example change to an existing feature.
+- Refactored the `put_header` method to use the `Array.wrap` method for more predictable header value handling.
+- Renamed methods to have a consistent `assign_` prefix to standardize the API interface:
+  - `put_header` to `assign_header`
+  - `write_body` to `assign_body`
+  - `set_params` to `assign_params`
+  - `update_status` to `assign_status`
 
 ### Deprecated
-- Example feature that will be removed in future releases.
 
 ### Removed
-- Example feature that was removed.
 
 ### Fixed
-- Example bug fix.
 
 ### Security
-- Example security fix.
 

data/lib/lenna/router/request.rb

@@ -12,7 +12,7 @@ module Lenna
       #
       # @return [Hash] the request params
       #
-      # @public
+      # @api public
       def params = super.merge(parse_body_params)
 
       # This method rewinds the body

data/lib/lenna/router/response.rb

@@ -4,51 +4,41 @@ module Lenna
   class Router
     # The Response class is responsible for managing the response.
     #
-    # @attr _headers [Hash]          the response headers
-    # @attr _body    [Array(String)] the response body
-    # @attr _status  [Integer]       the response status
-    # @attr params   [Hash]          the response params
+    # @attr headers [Hash]          the response headers
+    # @attr body    [Array(String)] the response body
+    # @attr status  [Integer]       the response status
+    # @attr params  [Hash]          the response params
     class Response
-      public  attr_reader :params
-      private attr_accessor :_headers, :_body, :_status
+      private attr_writer :body, :headers, :status, :params
+      public  attr_reader :body, :headers, :status, :params
 
-      # Initialize the Response
       def initialize(headers = {}, status = 200, body = [])
-        self._headers = headers
-        self._status  = status
-        self._body    = body
-        @params       = {}
+        @params  = {}
+        @body    = body
+        @status  = status
+        @headers = headers
       end
 
+      # This method will set the response status.
+      #
+      # @param value [Integer] the response status
+      #
+      # @return      [void]
+      #
       # @api public
-      # @return [Integer] the response status
-      def status = fetch_status
-
-      # @api public
-      # @param status [Integer] the response status
-      # @return       [void]
-      def put_status(value) = status!(value)
-
-      # @api public
-      # @return [Array(String)] the body value
-      def body = fetch_body
+      def assign_status(value) = put_status(value)
 
-      # @api public
+      # Thi method set the body value.
+      #
       # @param value [Array(String)] the body value
+      #
       # @return      [void]
-      def put_body(value) = body!(value)
-
-      # @api public
-      # @param header [String] the header name
-      # @return       [String] the header value
-      # @note                  This method will get the header value.
-      def header(key) = fetch_header(key)
-
+      #
       # @api public
-      # @return [Hash] the response headers
-      def headers = fetch_headers
+      def assign_body(value) = put_body(value)
 
-      # @api public
+      # This method will set the header value.
+      #
       # @param header [String] the header name
       # @param value  [String] the header value
       # @return       [void]
@@ -56,18 +46,21 @@ module Lenna
       #                        If the header already exists, then the value will
       #                        be appended to the header.
       #
+      # @api public
+      #
       # @example
-      #   put_header('X-Request-Id', '123')
+      #   assign_header('X-Request-Id', '123')
       #   # => '123'
       #
-      #   put_header('X-Request-Id', '456')
+      #   assign_header('X-Request-Id', '456')
       #   # => ['123', '456']
       #
-      #   put_header('X-Request-Id', ['456', '789'])
+      #   assign_header('X-Request-Id', ['456', '789'])
       #   # => ['123', '456', '789']
-      def put_header(key, value) = header!(key, value)
+      def assign_header(key, value) = put_header(key, value)
 
       # Add multiple headers.
+      #
       # @param headers [Hash] the headers
       # @return        [void]
       # @note                 This method will add the headers.
@@ -80,49 +73,66 @@ module Lenna
       #     'X-Request-Id' => '123'
       #   }
       #
-      def put_headers(headers)
+      def assign_headers(headers)
         headers => ::Hash
 
         headers.each { |key, value| put_header(key, value) }
       end
 
+      # This method will get the content type.
+      #
+      # @return [String] the content type
+      #
       # @api public
+      def content_type = @headers['Content-Type']
+
+      # This method will delete the header.
       # @param header [String] the header name
+      #
       # @return       [void]
-      # @note                 This method will delete the header.
+      #
+      # @api public
       def remove_header(key) = delete_header(key)
 
-      # @api public
+      # This method will get the redirect location.
+      #
       # @param value [String] the key of the cookie
+      #
       # @return      [String] the cookie
-      # @note                 This method will get the cookie.
+      #
+      # @api public
       def cookie(value)
         value => ::String
 
-        fetch_header('Set-Cookie')
+        @headers['Set-Cookie']
           .then { |cookie| cookie.split('; ') }
           .then { |cookie| cookie.find { |c| c.start_with?("#{value}=") } }
           .then { |cookie| cookie.split('=').last }
       end
 
-      # @api public
+      # This method will set the cookie.
+      #
       # @param key   [String] the key of the cookie
       # @param value [String] the value of the cookie
+      #
       # @return      [void]
-      # @note                 This method will set the cookie.
-      def put_cookie(key, value)
+      #
+      # @api public
+      def assign_cookie(key, value)
         key   => ::String
         value => ::String
 
         cookie = "#{key}=#{value}"
 
-        header!('Set-Cookie', cookie)
+        put_header('Set-Cookie', cookie)
       end
 
-      # @api public
+      # This method will get all the cookies.
+      #
       # @return [Hash] the cookies
+      # @api public
       def cookies
-        fetch_header('Set-Cookie')
+        @headers['Set-Cookie']
           .then { |cookie| cookie.split('; ') }
           .each_with_object({}) do |cookie, acc|
           key, value = cookie.split('=')
@@ -131,82 +141,93 @@ module Lenna
         end
       end
 
-      # @api public
+      # This method will set redirect location. The status will be set to 302.
+      #
       # @param location [String] the redirect location
-      # @param status   [Integer] the redirect status
+      # @param status   [Integer] the redirect status, default is 302.
+      #
       # @return         [void]
-      # @note                   This method will set the redirect location and
-      #                         status and finish the response.
+      #
+      # @api public
       def redirect(location, status: 302)
         location => ::String
 
-        header!('Location', location)
-        status!(status)
+        put_header('Location', location)
+        put_status(status)
 
         finish!
       rescue ::NoMatchingPatternError
         raise ::ArgumentError, 'location must be a string'
       end
 
-      # @api public
+      # This method will finish the response.
+      #
       # @return [void]
-      # @note        This method will finish the response.
-      def finish = finish!
-
+      #
       # @api public
-      # @return             [String] the response content type
-      # @note                        This method will set
-      #                              the response content type.
-      def content_type = header('Content-Type')
+      def finish = finish!
 
-      # @api public
+      # This method will set the response content type.
+      #
       # @param type    [String] the response content type
       # @param charset [Hash]   the response charset
+      #
       # @return        [void]
-      def put_content_type(type, charset: nil)
+      #
+      # @api public
+      def assign_content_type(type, charset: nil)
         type => ::String
 
         case charset
-        in ::String then header!('Content-Type', "#{type}; charset=#{charset}")
-        else             header!('Content-Type', type)
+        in ::String then put_header(
+          'Content-Type',
+          "#{type}; charset=#{charset}"
+        )
+        else put_header('Content-Type', type)
         end
       rescue ::NoMatchingPatternError
         raise ::ArgumentError, 'type must be a string'
       end
 
-      # @api public
+      # This method will set the response data and finish the response.
+      #
       # @param data [Hash, Array] the response data
+      #
       # @return     [void]
-      # @note                      This method will set the response data and
-      #                            finish the response.
+      #
+      # @api public
       def json(data:, status: 200)
         data => ::Array | ::Hash
 
-        status!(status)
-        header!('Content-Type', 'application/json')
-        body!(data.to_json)
+        put_status(status)
+        put_header('Content-Type', 'application/json')
+        put_body(data.to_json)
 
         finish!
       end
 
       # Set the response content type to text/html.
+      #
       # @param str [String] the response body
+      #
       # @return    [void]
+      #
+      # @api public
       def html(str = nil, status: 200)
-        status!(status)
-        header!('Content-Type', 'text/html')
-        body!(str)
+        put_status(status)
+        put_header('Content-Type', 'text/html')
+        put_body(str)
 
         finish!
       end
 
+      # This method will render the template.
+      #
       # @param template_nam [String] the template name
       # @param path         [String] the template path, default is 'views'
       # @param locals       [Hash]   the template locals
+      #
       # @return             [void | Exception]
-      # @note                        This method will render the template.
-      #                              The template engine is determined by the
-      #                              file extension.
       #
       # @example
       #   render('index')
@@ -245,112 +266,113 @@ module Lenna
       end
 
       # Helper methods for the response.
-      # @api public
+      #
       # @return [void]
-      # @note          This method will finish the response with a 404 status.
+      #
+      # @api public
+      #
+      # @see #render
+      # @see #finish!
       def not_found
-        body!(['Not Found'])
-        status!(404)
+        put_body(['Not Found'])
+        put_status(404)
+
         finish!
       end
 
       private
 
-      # @api private
+      # This method will get the response status.
+      #
       # @return [Integer] the response status
-      # @note             This method will get the response status.
-      def fetch_status = _status
-
+      #
       # @api private
-      # @return [Integer] the response status
-      # @note             This method will get the response status.
-      def status!(value)
+      def put_status(value)
         value => ::Integer
 
-        self._status = value
+        self.status = value
       rescue ::NoMatchingPatternError
         raise ::ArgumentError, 'status must be an integer'
       end
 
-      # @api private
-      # @return [Array(String)] the body value
-      def fetch_body = _body
-
-      # @api private
+      # This method will set the body.
+      #
       # @param body [Array(String)] the body to be used
       # @return     [void]
-      # @note                       This method will set the body.
-      def body!(value)
-        body => ::String | ::Array
+      def put_body(value)
+        value => ::String | ::Array
 
         case value
-        in ::String then self._body = [value]
-        in ::Array  then self._body = value
+        in ::String then @body = [value]
+        in ::Array  then @body = value
         end
       rescue ::NoMatchingPatternError
         raise ::ArgumentError, 'body must be a string or an array'
       end
 
-      # @api private
-      # @param header [String] the header name
-      # @return       [String] the header value
-      # @note                  This method will get the header value.
-      def fetch_header(header) = _headers[header]
-
-      # @api private
-      # @return [Hash] the response headers
-      def fetch_headers = _headers
-
-      # @api private
       # @param key   [String] the header name
       # @param value [String] the value to be used
+      #
       # @return      [void]
-      # @note                 This method will set the header value.
-      #                       If the header already exists, then the value will
-      #                       be appended to the header.
-      def header!(key, value)
-        key   => ::String
-        value => ::String | ::Array
+      def put_header(key, value)
+        raise ::ArgumentError, 'key must be a string' unless key.is_a?(::String)
 
-        header_value = fetch_header(key)
-
-        case value
-        in ::String then _headers[key] = [*header_value, value].uniq.join(', ')
-        in ::Array  then _headers[key] = [*header_value, *value].uniq.join(', ')
+        unless value.is_a?(::String) || value.is_a?(::Array)
+          raise ::ArgumentError, 'value must be a string or an array'
         end
-      rescue ::NoMatchingPatternError
-        raise ::ArgumentError, 'header must be a string or an array'
+
+        header_value = @headers[key]
+
+        new_values      = ::Array.wrap(value)
+        existing_values = ::Array.wrap(header_value)
+
+        @headers[key] = (existing_values + new_values).uniq.join(', ')
       end
 
-      # @api private
       # @param key [String] the header name
+      #
       # @return    [void]
-      # @note      This method will delete the header.
-      def delete_header(key) = _headers.delete(key)
+      def delete_header(key) = @headers.delete(key)
 
-      # @api private
       # @param value [String] the redirect location
+      #
       # @return      [void]
       def location!(value)
         value => ::String
 
-        header!('Location', value)
+        put_header('Location', value)
       end
 
-      # @api private
-      # @param value [String] the content value
-      # @return      [String] the size of the content
-      # @note                 This method will get the size of the content.
-      def content_length!(value) = header!('Content-Length', value)
-
-      # @api private
+      # This method will finish the response.
+      #
       # @return [void]
-      # @note   This method will finish the response.
       def finish!
-        put_content_type('text/html')        unless header('Content-Type')
-        content_length!(body.join.size.to_s) unless header('Content-Length')
+        default_router_header!
+        default_content_length!    unless @headers['Content-Length']
+        default_html_content_type! unless @headers['Content-Type']
+
+        [@status, @headers, @body]
+      end
 
-        [_status, _headers, _body]
+      # This method will set the response default html content type.
+      #
+      # @return [void]
+      def default_html_content_type!
+        put_header('Content-Type', 'text/html')
+      end
+
+      # This method will set the response default content length.
+      #
+      # @return [void]
+      def default_content_length!
+        put_header('Content-Length', @body.join.size.to_s)
+      end
+
+      # This method will set the response default router header.
+      #
+      # @return [void]
+      def default_router_header!
+        put_header('Server', "Lennarb VERSION #{::Lennarb::VERSION}")
       end
     end
   end

data/lib/lennarb/array_extensions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lennarb
+  module ArrayExtensions
+    def wrap(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      else
+        [object]
+      end
+    end
+  end
+end
+
+Array.extend(Lennarb::ArrayExtensions)

data/lib/lennarb/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lennarb
+  VERSION = '0.1.1'
+
+  public_constant :VERSION
+end

data/lib/lennarb.rb

@@ -1,3 +1,8 @@
 # frozen_string_literal: true
 
+# Extension for Array class
+require 'lennarb/array_extensions'
+
+# Base class for Lennarb
 require 'lenna/base'
+require 'lennarb/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lennarb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aristóteles Coutinho
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -141,6 +141,8 @@ files:
 - lib/lenna/router/response.rb
 - lib/lenna/router/route_matcher.rb
 - lib/lennarb.rb
+- lib/lennarb/array_extensions.rb
+- lib/lennarb/version.rb
 homepage: https://rubygems.org/gems/lennarb
 licenses:
 - MIT