lennarb 1.4.0 → 1.5.0

data/lib/lennarb/response.rb

@@ -1,22 +1,24 @@
-class Lennarb
+module Lennarb
+  # Response object
+  #
   class Response
     # @!attribute [rw] status
-    #  @returns [Integer]
+    # @return [Integer]
     #
     attr_accessor :status
 
     # @!attribute [r] body
-    #  @returns [Array]
+    # @retrn [Array]
     #
     attr_reader :body
 
     # @!attribute [r] headers
-    #  @returns [Hash]
+    # @retrn [Hash]
     #
     attr_reader :headers
 
     # @!attribute [r] length
-    #  @returns [Integer]
+    # @retrn [Integer]
     #
     attr_reader :length
 
@@ -31,13 +33,12 @@ class Lennarb
     CONTENT_LENGTH = "content-length"
     private_constant :CONTENT_LENGTH
 
-    ContentType = {HTML: "text/html", TEXT: "text/plain", JSON: "application/json"}.freeze
     # Initialize the response object
     #
-    # @returns [Response]
+    # @retrn [Response]
     #
     def initialize
-      @status = 404
+      @status = 200
       @headers = {}
       @body = []
       @length = 0
@@ -45,9 +46,9 @@ class Lennarb
 
     # Set the response header
     #
-    # @parameter [String] key
+    # @param [String] key
     #
-    # @returns [String] value
+    # @retrn [String] value
     #
     def [](key)
       @headers[key]
@@ -55,10 +56,10 @@ class Lennarb
 
     # Get the response header
     #
-    # @parameter [String] key
-    # @parameter [String] value
+    # @param [String] key
+    # @param [String] value
     #
-    # @returns [String] value
+    # @retrn [String] value
     #
     def []=(key, value)
       @headers[key] = value
@@ -66,9 +67,9 @@ class Lennarb
 
     # Write to the response body
     #
-    # @parameter [String] str
+    # @param [String] str
     #
-    # @returns [String] str
+    # @retrn [String] str
     #
     def write(str)
       str = str.to_s
@@ -79,41 +80,46 @@ class Lennarb
 
     # Set the response type to text
     #
-    # @parameter [String] str
+    # @param [String] str
     #
-    # @returns [String] str
+    # @retrn [String] str
     #
     def text(str)
-      @headers[CONTENT_TYPE] = ContentType[:TEXT]
+      @headers[CONTENT_TYPE] = Lennarb::CONTENT_TYPE[:TEXT]
       write(str)
     end
 
     # Set the response type to html
     #
-    # @parameter [String] str
+    # @param [String] str
     #
-    # @returns [String] str
+    # @retrn [String] str
     #
     def html(str)
-      @headers[CONTENT_TYPE] = ContentType[:HTML]
+      @headers[CONTENT_TYPE] = Lennarb::CONTENT_TYPE[:HTML]
       write(str)
     end
 
     # Set the response type to json
     #
-    # @parameter [String] str
+    # @param [String] str
     #
-    # @returns [String] str
+    # @retrn [String] str
     #
     def json(str)
-      @headers[CONTENT_TYPE] = ContentType[:JSON]
-      write(str)
+      json_str = JSON.generate(str)
+      @headers[CONTENT_TYPE] = Lennarb::CONTENT_TYPE[:JSON]
+      write(json_str)
+    rescue JSON::GeneratorError => e
+      @status = 500
+      @headers[CONTENT_TYPE] = Lennarb::CONTENT_TYPE[:TEXT]
+      write("JSON generation error: #{e.message}")
     end
 
     # Redirect the response
     #
-    # @parameter [String] path
-    # @parameter [Integer] status, default: 302
+    # @param [String] path
+    # @param [Integer] status, default: 302
     #
     def redirect(path, status = 302)
       @headers[LOCATION] = path
@@ -124,7 +130,7 @@ class Lennarb
 
     # Finish the response
     #
-    # @returns [Array] response
+    # @retrn [Array] response
     #
     def finish
       [@status, @headers, @body]

data/lib/lennarb/route_node.rb

@@ -1,7 +1,20 @@
-class Lennarb
+module Lennarb
+  # RouteNode is key to the routing system. It is a tree structure that
+  # represents the routes of the application.
+  #
+  # @example
+  #   node = RouteNode.new
+  #   node.add_route(["foo", "bar"], :GET, -> {})
+  #
+  # @note RouteNode use a trie data structure to store the routes and match them.
+  #
   class RouteNode
     attr_accessor :static_children, :dynamic_children, :blocks, :param_key
 
+    # Initialize the route node.
+    #
+    # @retrn [RouteNode]
+    #
     def initialize
       @blocks = {}
       @param_key = nil
@@ -9,6 +22,14 @@ class Lennarb
       @dynamic_children = {}
     end
 
+    # Add a route to the route node.
+    #
+    # @param parts [Array<String>] The parts of the route.
+    # @param http_method [String] The HTTP method.
+    # @param block [Proc] The block to be executed when the route is matched.
+    #
+    # @retrn [void]
+    #
     def add_route(parts, http_method, block)
       current_node = self
 
@@ -28,6 +49,14 @@ class Lennarb
       current_node.blocks[http_method] = block
     end
 
+    # Match a route.
+    #
+    # @param parts [Array<String>] The parts of the route.
+    # @param http_method [String] The HTTP method.
+    # @param params [Hash] The parameters of the route.
+    #
+    # @retrn [Array<Proc, Hash>]
+    #
     def match_route(parts, http_method, params: {})
       if parts.empty?
         return [blocks[http_method], params] if blocks[http_method]
@@ -52,10 +81,35 @@ class Lennarb
       [nil, nil]
     end
 
+    # Merge another route node into this one.
+    #
+    # @param other [RouteNode] The other route node.
+    #
+    # @retrn [void|DuplicateRouteError]
+    #
     def merge!(other)
-      static_children.merge!(other.static_children)
-      dynamic_children.merge!(other.dynamic_children)
-      blocks.merge!(other.blocks)
+      other.blocks.each do |http_method, block|
+        if @blocks[http_method]
+          raise Lennarb::DuplicateRouteError, "Duplicate route for HTTP method: #{http_method}"
+        end
+        @blocks[http_method] = block
+      end
+
+      other.static_children.each do |path, node|
+        if @static_children[path]
+          @static_children[path].merge!(node)
+        else
+          @static_children[path] = node
+        end
+      end
+
+      other.dynamic_children.each do |param, node|
+        if @dynamic_children[param]
+          @dynamic_children[param].merge!(node)
+        else
+          @dynamic_children[param] = node
+        end
+      end
     end
   end
 end

data/lib/lennarb/routes.rb

@@ -0,0 +1,67 @@
+module Lennarb
+  # Routes class for managing application routes
+  #
+  class Routes
+    # Initialize a new Routes instance
+    #
+    # @return [Routes] The initialized routes instance
+    def initialize
+      @store = RouteNode.new
+      @frozen = false
+    end
+
+    # Define a route for each HTTP method
+    HTTP_METHODS.each do |http_method|
+      define_method(http_method.downcase) do |path, &block|
+        fail RoutesFrozenError, "Routes are frozen and cannot be modified" if @frozen
+        register_route(http_method, path, &block)
+      end
+    end
+
+    # Define the root route (GET /)
+    #
+    # @param block [Proc] Block to execute when route matches
+    # @return [void]
+    def root(&block)
+      get("/", &block)
+    end
+
+    # Match a route with the given path parts and HTTP method
+    #
+    # @param parts [Array<String>] Path parts
+    # @param http_method [Symbol] HTTP method
+    # @return [Array(Proc, Hash), nil] Route handler and params, or nil if no match
+    def match_route(parts, http_method)
+      @store.match_route(parts, http_method)
+    end
+
+    # Freeze the routes to prevent further modification
+    #
+    # @return [self] The frozen routes
+    def freeze
+      @frozen = true
+      @store.freeze
+      self
+    end
+
+    # Check if the routes are frozen
+    #
+    # @return [Boolean] True if frozen
+    def frozen?
+      @frozen
+    end
+
+    private
+
+    # Register a route with the specified HTTP method and path
+    #
+    # @param http_method [Symbol] HTTP method (:GET, :POST, etc.)
+    # @param path [String] Route path pattern
+    # @param block [Proc] Block to execute when route matches
+    # @return [void]
+    def register_route(http_method, path, &block)
+      parts = path.split("/").reject(&:empty?)
+      @store.add_route(parts, http_method, block)
+    end
+  end
+end

data/lib/lennarb/version.rb

@@ -1,5 +1,3 @@
-class Lennarb
-  VERSION = "1.4.0"
-
-  public_constant :VERSION
+module Lennarb # :nodoc:
+  VERSION = "1.5.0" # :nodoc:
 end

data/lib/lennarb.rb

@@ -1,72 +1,40 @@
 # Core extensions
 #
-require "pathname"
-require "rack"
 require "bundler"
+require "rack"
+require "json"
+require "pathname"
+require "logger"
+require "securerandom"
+require "colorize"
+require "superconfig"
 
-require_relative "lennarb/request"
-require_relative "lennarb/response"
-require_relative "lennarb/route_node"
-require_relative "lennarb/version"
-require_relative "lennarb/constansts"
-
-class Lennarb
-  class LennarbError < StandardError; end
-
-  def initialize
-    @_mutex ||= Mutex.new
-    yield self if block_given?
-  end
-
-  HTTP_METHODS.each do |http_method|
-    define_method(http_method.downcase) do |path, &block|
-      add_route(path, http_method, block)
-    end
-  end
-
-  def root
-    @root ||= RouteNode.new
-  end
-
-  def app
-    @app ||= begin
-      request_handler = ->(env) { process_request(env) }
-
-      Rack::Builder.app do
-        run request_handler
-      end
-    end
-  end
-
-  def initializer!
-    Bundler.require(:default, ENV["LENNA_ENV"] || "development")
-
-    root.freeze
-    app.freeze
-  end
-
-  def call(env) = @_mutex.synchronize { app.call(env) }
-
-  def add_route(path, http_method, block)
-    parts = path.split("/").reject(&:empty?)
-    root.add_route(parts, http_method, block)
-  end
-
-  private def process_request(env)
-    http_method = env[Rack::REQUEST_METHOD].to_sym
-    parts = env[Rack::PATH_INFO].split("/").reject(&:empty?)
-
-    block, params = root.match_route(parts, http_method)
-    return [404, {"content-type" => Response::ContentType[:TEXT]}, ["Not Found"]] unless block
-
-    res = Response.new
-    req = Request.new(env, params)
-
-    catch(:halt) do
-      instance_exec(req, res, &block)
-      res.finish
-    end
-  rescue => e
-    [500, {"content-type" => Response::ContentType[:TEXT]}, ["Internal Server Error - #{e.message}"]]
-  end
+# Lennarb is a lightweight Ruby web framework based on Rack that offers a high-performance solution for web development. Focused on simplicity, Lennarb delivers essential functionality without unnecessary complexity.
+# Available in two versions:
+#
+# Lennarb::App: Minimal version. Includes only the core components, such as request, response, and route handling.
+#
+# Lennarb::Application: Standard version. Include common features like middleware, request handler, and more.
+#
+module Lennarb
+  require_relative "lennarb/constants"
+  require_relative "lennarb/environment"
+  require_relative "lennarb/version"
+  require_relative "lennarb/request"
+  require_relative "lennarb/response"
+  require_relative "lennarb/route_node"
+  require_relative "lennarb/routes"
+  require_relative "lennarb/config"
+  require_relative "lennarb/errors"
+  require_relative "lennarb/middleware_stack"
+  require_relative "lennarb/helpers"
+  require_relative "lennarb/hooks"
+  require_relative "lennarb/request_handler"
+  require_relative "lennarb/base"
+  require_relative "lennarb/app"
+
+  # Middlewares
+  require_relative "lennarb/logger"
+  require_relative "lennarb/parameter_filter"
+  require_relative "lennarb/middleware/request_logger"
 end

data/logo/lennarb.svg

@@ -0,0 +1,11 @@
+<svg width="192" height="56" viewBox="0 0 192 56" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect x="142" y="30.9185" width="35.2401" height="35.2401" rx="5" transform="rotate(-45 142 30.9185)" fill="#E8E8E8"/>
+<path d="M3.1075 3.4H14.3395V27.4H30.1315V37H3.1075V3.4ZM48.6719 21.64C48.5439 20.392 48.1439 19.432 47.4719 18.76C46.7999 18.056 45.9839 17.704 45.0239 17.704C44.0959 17.704 43.3279 18.056 42.7199 18.76C42.1119 19.464 41.7279 20.424 41.5679 21.64H48.6719ZM45.8879 37.624C43.7439 37.624 41.7759 37.304 39.9839 36.664C38.2239 35.992 36.7039 35.064 35.4239 33.88C34.1759 32.696 33.1999 31.272 32.4959 29.608C31.8239 27.944 31.4879 26.088 31.4879 24.04V23.944C31.4879 21.992 31.8239 20.184 32.4959 18.52C33.1679 16.824 34.0959 15.368 35.2799 14.152C36.4639 12.904 37.8719 11.928 39.5039 11.224C41.1679 10.52 42.9919 10.168 44.9759 10.168C47.3119 10.168 49.3279 10.552 51.0239 11.32C52.7519 12.056 54.1759 13.08 55.2959 14.392C56.4159 15.704 57.2479 17.24 57.7919 19C58.3359 20.76 58.6079 22.632 58.6079 24.616C58.6079 24.904 58.6079 25.208 58.6079 25.528C58.6079 25.848 58.5919 26.152 58.5599 26.44H41.7119C42.0959 27.592 42.7199 28.472 43.5839 29.08C44.4479 29.656 45.4719 29.944 46.6559 29.944C47.6479 29.944 48.5599 29.72 49.3919 29.272C50.2559 28.824 51.1199 28.152 51.9839 27.256L57.8399 31.912C56.5279 33.608 54.9119 34.984 52.9919 36.04C51.1039 37.096 48.7359 37.624 45.8879 37.624ZM60.9914 10.792H71.8874V14.44C72.3034 13.896 72.7834 13.368 73.3274 12.856C73.8714 12.344 74.4794 11.896 75.1514 11.512C75.8234 11.096 76.5434 10.776 77.3114 10.552C78.1114 10.296 78.9754 10.168 79.9034 10.168C82.6874 10.168 84.8794 11.016 86.4794 12.712C88.0794 14.408 88.8794 16.744 88.8794 19.72V37H77.9834V23.224C77.9834 22.104 77.6954 21.24 77.1194 20.632C76.5434 19.992 75.8394 19.672 75.0074 19.672C74.1754 19.672 73.4394 19.992 72.7994 20.632C72.1914 21.24 71.8874 22.104 71.8874 23.224V37H60.9914V10.792ZM91.9289 10.792H102.825V14.44C103.241 13.896 103.721 13.368 104.265 12.856C104.809 12.344 105.417 11.896 106.089 11.512C106.761 11.096 107.481 10.776 108.249 10.552C109.049 10.296 109.913 10.168 110.841 10.168C113.625 10.168 115.817 11.016 117.417 12.712C119.017 14.408 119.817 16.744 119.817 19.72V37H108.921V23.224C108.921 22.104 108.633 21.24 108.057 20.632C107.481 19.992 106.777 19.672 105.945 19.672C105.113 19.672 104.377 19.992 103.737 20.632C103.129 21.24 102.825 22.104 102.825 23.224V37H91.9289V10.792ZM134.77 31.336C135.73 31.336 136.53 30.984 137.17 30.28C137.81 29.544 138.13 28.552 138.13 27.304V26.2C137.81 26.072 137.426 25.976 136.978 25.912C136.53 25.816 136.082 25.768 135.634 25.768C134.546 25.768 133.714 26.056 133.138 26.632C132.562 27.176 132.274 27.864 132.274 28.696V28.792C132.274 29.56 132.514 30.184 132.994 30.664C133.474 31.112 134.066 31.336 134.77 31.336ZM130.45 37.624C129.202 37.624 128.05 37.448 126.994 37.096C125.938 36.744 125.026 36.232 124.258 35.56C123.49 34.856 122.898 34.008 122.482 33.016C122.066 32.024 121.858 30.872 121.858 29.56V29.464C121.858 26.84 122.754 24.824 124.546 23.416C126.338 22.008 128.77 21.304 131.842 21.304C132.386 21.304 132.962 21.336 133.57 21.4C134.178 21.432 134.754 21.496 135.298 21.592C135.874 21.688 136.402 21.8 136.882 21.928C137.362 22.024 137.746 22.136 138.034 22.264V21.832C138.034 20.616 137.65 19.688 136.882 19.048C136.114 18.376 134.882 18.04 133.186 18.04C131.842 18.04 130.578 18.184 129.394 18.472C128.242 18.728 127.09 19.08 125.938 19.528L124.018 12.28C125.554 11.704 127.202 11.24 128.962 10.888C130.722 10.536 132.754 10.36 135.058 10.36C137.746 10.36 139.97 10.648 141.73 11.224C143.522 11.768 144.994 12.616 146.146 13.768C147.138 14.76 147.842 15.912 148.258 17.224C148.674 18.536 148.882 20.152 148.882 22.072V37H137.986V34.36C137.058 35.352 135.97 36.152 134.722 36.76C133.506 37.336 132.082 37.624 130.45 37.624ZM150.944 31.48H156.512V37H150.944V31.48ZM157.933 23.896H163.381V26.536C163.749 25.656 164.253 24.952 164.893 24.424C165.533 23.896 166.397 23.656 167.485 23.704V29.488H166.909C165.757 29.488 164.877 29.824 164.269 30.496C163.677 31.152 163.381 32.208 163.381 33.664V37H157.933V23.896ZM175.922 32.824C176.546 32.824 177.066 32.6 177.482 32.152C177.898 31.704 178.106 31.144 178.106 30.472V30.424C178.106 29.752 177.898 29.192 177.482 28.744C177.066 28.296 176.546 28.072 175.922 28.072C175.298 28.072 174.778 28.296 174.362 28.744C173.946 29.192 173.738 29.752 173.738 30.424V30.472C173.738 30.792 173.794 31.096 173.906 31.384C174.018 31.672 174.17 31.928 174.362 32.152C174.554 32.36 174.778 32.528 175.034 32.656C175.306 32.768 175.602 32.824 175.922 32.824ZM177.794 37.312C176.802 37.312 176.002 37.128 175.394 36.76C174.786 36.392 174.274 35.976 173.858 35.512V37H168.41V19.48H173.858V25.504C174.082 25.264 174.314 25.032 174.554 24.808C174.81 24.568 175.09 24.36 175.394 24.184C175.698 24.008 176.042 23.864 176.426 23.752C176.81 23.64 177.25 23.584 177.746 23.584C178.53 23.584 179.266 23.752 179.954 24.088C180.642 24.408 181.242 24.872 181.754 25.48C182.266 26.072 182.666 26.784 182.954 27.616C183.242 28.432 183.386 29.344 183.386 30.352V30.4C183.386 31.44 183.234 32.384 182.93 33.232C182.642 34.08 182.242 34.808 181.73 35.416C181.234 36.024 180.642 36.496 179.954 36.832C179.282 37.152 178.562 37.312 177.794 37.312Z" fill="url(#paint0_linear_4_61)"/>
+<defs>
+<linearGradient id="paint0_linear_4_61" x1="0" y1="23" x2="185" y2="23" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FF793B"/>
+<stop offset="1" stop-color="#FF3BF2"/>
+</linearGradient>
+</defs>
+</svg>
+