lennarb 1.3.0 → 1.4.0

data/guides/performance/readme.md

@@ -0,0 +1,120 @@
+# Performance
+
+The **Lennarb** is very fast. The following benchmarks were performed on a MacBook Pro (Retina, 13-inch, Early 2013) with 2,7 GHz Intel Core i7 and 8 GB 1867 MHz DDR3. Based on [jeremyevans/r10k](https://github.com/jeremyevans/r10k) using the following. All tests are performed using the **Ruby 3.3.0**
+
+## Benchmark results
+
+This document contains the benchmarks comparing **Lennarb** with other routers based on Rack. Metrics evaluated include Requests per Second, Initial memory usage and Startup time.
+
+### 1. Requests per Second (RPS)
+
+![RPS](https://raw.githubusercontent.com/aristotelesbr/lennarb/main/benchmark/rps.png)
+
+| Position | Application | 10 RPS     | 100 RPS    | 1.000 RPS | 10.000 RPS |
+| -------- | ----------- | ---------- | ---------- | --------- | ---------- |
+| 1        | Lenna       | 126.252,36 | 108.086,55 | 87.111,91 | 68.460,64  |
+| 2        | Roda        | 123.360,37 | 88.380,56  | 66.990,77 | 48.108,29  |
+| 3        | Syro        | 114.105,38 | 80.909,39  | 61.415,86 | 46.639,81  |
+| 4        | Hanami-API  | 68.089,18  | 52.851,88  | 40.801,78 | 27.996,00  |
+
+This table ranks the routers by the number of requests they can process per second. Higher numbers indicate better performance.
+
+### 2. Initial memory usage (in KB)
+
+![Memory](https://raw.githubusercontent.com/aristotelesbr/lennarb/main/benchmark/memory.png)
+
+| Position | Application | 10 KB  | 100 KB | 1.000 KB | 10.000 KB |
+| -------- | ----------- | ------ | ------ | -------- | --------- |
+| 1        | Syro        | 12,160 | 12,544 | 16,460   | 49,692    |
+| 2        | Lenna       | 14,464 | 14,720 | 18,232   | 56,812    |
+| 3        | Roda        | 15,104 | 15,104 | 18,220   | 49,900    |
+| 4        | Hanami-API  | 15,744 | 16,128 | 20,888   | 64,824    |
+
+This table shows the initial memory usage in KB. Lower values indicate lower memory consumption.
+
+### 3. Startup time (in seconds)
+
+![Startup](https://raw.githubusercontent.com/aristotelesbr/lennarb/main/benchmark/runtime_with_startup.png)
+
+| Position | Application | 10 seg | 100 seg | 1.000 seg | 10.000 seg |
+| -------- | ----------- | ------ | ------- | --------- | ---------- |
+| 1        | Syro        | 0.274  | 0.347   | 0.455     | 0.997      |
+| 2        | Lenna       | 0.289  | 0.312   | 0.393     | 0.914      |
+| 3        | Roda        | 0.294  | 0.378   | 0.467     | 0.918      |
+| 4        | Hanami-API  | 0.445  | 0.550   | 0.808     | 3.074      |
+
+This table shows the startup time in seconds. Lower values indicate faster startup times.
+
+## Graphs
+
+See the graphs in the `benchmarks` directory of the lennarb project.
+
+## Steps to run the benchmarks
+
+### 1. Install the router gem you want to test
+
+```bash
+gem install lennarb
+gem install syro
+gem install roda
+```
+
+### 2. Clone the jeremyevans/r10k repository
+
+```bash
+git clone https://github.com/jeremyevans/r10k
+```
+
+### 3. Create a new file in the `r10k` directory
+
+In the `r10k` directory, create a new file called `lennarb.rb` into `builders` directory with the code below:
+
+```bash
+touch r10k/builders/lennarb.rb
+```
+
+Put the code below into `lennarb.rb` file:
+
+```rb
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Aristóteles Coutinho.
+
+lennarb_routes =
+  lambda do |f, level, prefix, calc_path, lvars|
+    base = BASE_ROUTE.dup
+    ROUTES_PER_LEVEL.times do
+      route = "#{prefix}#{base}"
+      if level == 1
+        params = lvars.map { |lvar| "\#{req.params[:#{lvar}]}" }
+.join('-')
+        f.puts "  app.get '#{route}/:#{lvars.last}' do |req, res|"
+        f.puts "    body = \"#{calc_path[1..]}#{base}-#{params}\""
+        f.puts '    res.html body'
+        f.puts '  end'
+      else
+       lennarb_routes.call(f, level - 1, "#{route}/:#{lvars.last}/", "#{calc_path}#{base}/", lvars + [lvars.last.succ])
+      end
+      base.succ!
+    end
+  end
+
+File.open("#{File.dirname(__FILE__)}/../apps/lennarb_#{LEVELS}_#{ROUTES_PER_LEVEL}.rb", 'wb') do |f|
+  f.puts '# frozen_string_literal: true'
+  f.puts "require 'lennarb'"
+  f.puts 'app = Lennarb.new'
+  lennarb_routes.call(f, LEVELS, '/', '/', ['a'])
+  f.puts 'App = app'
+end
+```
+
+### 4. Run the benchmarks
+
+```bash
+bundle exec rake bench graphs R10K_APPS="lennarb syro roda"
+```
+
+## Conclusion
+
+These numbers are just a small reference, **Lennarb** is not a framework, it is a router. In my opinion, **Roda** is the best router for Ruby because it has many interesting features, such as a middleware manager, and very good development performance.

data/guides/response/readme.md

@@ -0,0 +1,83 @@
+# Response
+
+This is the response guide.
+The `res` object is used to send a response to the client. The Lennarb use a custom response object to send responses to the client. The `res` object is an instance of {Lennarb::Response}.
+
+## Usage
+
+You can use the `res` object to send a response to the client.
+
+```ruby
+# app.rb
+
+app.get '/' do |req, res|
+ res.html 'Hello World'
+end
+```
+
+## Content Types
+
+Lenna supports the following content types:
+
+```ruby
+# app.rb
+
+app.get '/' do |req, res|
+ res.html 'Hello World'
+ res.json '{"message": "Hello World"}'
+ res.text 'Hello World'
+end
+```
+
+But you can also set your own content type:
+
+```ruby
+res['content-type'] = 'text/markdown'
+res.write '# Hello World'
+```
+
+## The write method
+
+You can use the `res.write` method to write to the response body:
+
+```ruby
+# app.rb
+
+app.get '/' do |req, res|
+ res.write 'Hello World'
+end
+```
+
+JSON example:
+
+```ruby
+# app.rb
+
+app.post '/posts' do |req, res|
+ req.params # => { name: 'Lenna' }
+ name = req.params[:name]
+
+ res.write({ data: { name: } }.to_json) # This will write to the response body
+end
+```
+
+## Status Codes
+
+You can set the status code using the `res.status` method:
+
+```ruby
+res.status 200
+```
+
+## Redirects
+
+You can redirect the client using the `res.redirect` method:
+
+```ruby
+# app.ruby
+
+app.get '/' do |req, res|
+  # Stuff code here...
+ res.redirect '/hello'
+end
+```

data/lennarb.gemspec

@@ -0,0 +1,44 @@
+require_relative "lib/lennarb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "lennarb"
+  spec.version = Lennarb::VERSION
+
+  spec.summary = <<~DESC
+    Lennarb provides a lightweight yet robust solution for web routing in Ruby, focusing on performance and simplicity.
+  DESC
+  spec.authors = ["Aristóteles Coutinho"]
+  spec.license = "MIT"
+  spec.homepage = "https://aristotelesbr.github.io/lennarb"
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "changelog_uri" => "https://github.com/aristotelesbr/lennarb/blob/master/changelog.md",
+    "homepage_uri" => "https://aristotelesbr.github.io/lennarb",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/aristotelesbr/lennarb"
+  }
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.match(%r{^(test|features)/}) }
+  end
+
+  spec.bindir = "exe"
+  spec.executables = ["lenna"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bigdecimal"
+  spec.add_dependency "colorize", "~> 1.1"
+  spec.add_dependency "rack", "~> 3.1"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "covered"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "standard-custom"
+  spec.add_development_dependency "standard-performance"
+  spec.add_development_dependency "m"
+end

data/lib/lennarb/constansts.rb

@@ -0,0 +1 @@
+HTTP_METHODS = %i[GET POST PUT PATCH DELETE HEAD OPTIONS].freeze

data/lib/lennarb/request.rb

@@ -1,8 +1,3 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023-2024, by Aristóteles Coutinho.
-
 class Lennarb
   class Request < Rack::Request
     # The environment variables of the request
@@ -33,7 +28,7 @@ class Lennarb
     #
     # @returns [String]
     #
-    def path = @path ||= super.split('?').first
+    def path = @path ||= super.split("?").first
 
     # Read the body of the request
     #
@@ -52,18 +47,26 @@ class Lennarb
     # Get the headers of the request
     #
     def headers
-      @headers ||= env.select { |key, _| key.start_with?('HTTP_') }
+      @headers ||= env.select { |key, _| key.start_with?("HTTP_") }
     end
 
-    def ip             = ip_address
-    def secure?        = scheme == 'https'
-    def user_agent     = headers['HTTP_USER_AGENT']
-    def accept         = headers['HTTP_ACCEPT']
-    def referer        = headers['HTTP_REFERER']
-    def host           = headers['HTTP_HOST']
-    def content_length = headers['HTTP_CONTENT_LENGTH']
-    def content_type   = headers['HTTP_CONTENT_TYPE']
-    def xhr?           = headers['HTTP_X_REQUESTED_WITH']&.casecmp('XMLHttpRequest')&.zero?
+    def ip = ip_address
+
+    def secure? = scheme == "https"
+
+    def user_agent = headers["HTTP_USER_AGENT"]
+
+    def accept = headers["HTTP_ACCEPT"]
+
+    def referer = headers["HTTP_REFERER"]
+
+    def host = headers["HTTP_HOST"]
+
+    def content_length = headers["HTTP_CONTENT_LENGTH"]
+
+    def content_type = headers["HTTP_CONTENT_TYPE"]
+
+    def xhr? = headers["HTTP_X_REQUESTED_WITH"]&.casecmp("XMLHttpRequest")&.zero?
 
     def []=(key, value)
       env[key] = value
@@ -76,8 +79,8 @@ class Lennarb
     private
 
     def ip_address
-      forwarded_for = headers['HTTP_X_FORWARDED_FOR']
-      forwarded_for ? forwarded_for.split(',').first.strip : env['REMOTE_ADDR']
+      forwarded_for = headers["HTTP_X_FORWARDED_FOR"]
+      forwarded_for ? forwarded_for.split(",").first.strip : env["REMOTE_ADDR"]
     end
   end
 end

data/lib/lennarb/response.rb

@@ -1,8 +1,3 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023-2024, by Aristóteles Coutinho.
-
 class Lennarb
   class Response
     # @!attribute [rw] status
@@ -27,27 +22,25 @@ class Lennarb
 
     # Constants
     #
-    LOCATION = 'location'
+    LOCATION = "location"
     private_constant :LOCATION
 
-    CONTENT_TYPE = 'content-type'
+    CONTENT_TYPE = "content-type"
     private_constant :CONTENT_TYPE
 
-    CONTENT_LENGTH = 'content-length'
+    CONTENT_LENGTH = "content-length"
     private_constant :CONTENT_LENGTH
 
-    ContentType = { HTML: 'text/html', TEXT: 'text/plain', JSON: 'application/json' }.freeze
-    private_constant :ContentType
-
+    ContentType = {HTML: "text/html", TEXT: "text/plain", JSON: "application/json"}.freeze
     # Initialize the response object
     #
     # @returns [Response]
     #
     def initialize
-      @status  = 404
+      @status = 404
       @headers = {}
-      @body    = []
-      @length  = 0
+      @body = []
+      @length = 0
     end
 
     # Set the response header

data/lib/lennarb/route_node.rb

@@ -1,16 +1,11 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023-2024, by Aristóteles Coutinho.
-
 class Lennarb
   class RouteNode
     attr_accessor :static_children, :dynamic_children, :blocks, :param_key
 
     def initialize
-      @blocks           = {}
-      @param_key        = nil
-      @static_children  = {}
+      @blocks = {}
+      @param_key = nil
+      @static_children = {}
       @dynamic_children = {}
     end
 
@@ -18,7 +13,7 @@ class Lennarb
       current_node = self
 
       parts.each do |part|
-        if part.start_with?(':')
+        if part.start_with?(":")
           param_sym = part[1..].to_sym
           current_node.dynamic_children[param_sym] ||= RouteNode.new
           dynamic_node = current_node.dynamic_children[param_sym]

data/lib/lennarb/version.rb

@@ -1,10 +1,5 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023-2024, by Aristóteles Coutinho.
-
 class Lennarb
-  VERSION = '1.3.0'
+  VERSION = "1.4.0"
 
   public_constant :VERSION
 end

data/lib/lennarb.rb

@@ -1,133 +1,63 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023-2024, by Aristóteles Coutinho.
-
 # Core extensions
 #
-require 'pathname'
-require 'rack'
+require "pathname"
+require "rack"
+require "bundler"
 
-require_relative 'lennarb/plugin'
-require_relative 'lennarb/request'
-require_relative 'lennarb/response'
-require_relative 'lennarb/route_node'
-require_relative 'lennarb/version'
+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
 
-  attr_reader :_root, :_plugins, :_loaded_plugins, :_middlewares, :_app
-
-  def self.use(middleware, *args, &block)
-    @_middlewares ||= []
-    @_middlewares << [middleware, args, block]
-  end
-
-  def self.get(path, &block)     = add_route(path, :GET, block)
-  def self.put(path, &block)     = add_route(path, :PUT, block)
-  def self.post(path, &block)    = add_route(path, :POST, block)
-  def self.head(path, &block)    = add_route(path, :HEAD, block)
-  def self.patch(path, &block)   = add_route(path, :PATCH, block)
-  def self.delete(path, &block)  = add_route(path, :DELETE, block)
-  def self.options(path, &block) = add_route(path, :OPTIONS, block)
-
-  def self.inherited(subclass)
-    super
-    subclass.instance_variable_set(:@_root, RouteNode.new)
-    subclass.instance_variable_set(:@_plugins, [])
-    subclass.instance_variable_set(:@_middlewares, @_middlewares&.dup || [])
-
-    Plugin.load_defaults! if Plugin.load_defaults?
-  end
-
-  def self.plugin(plugin_name, *, &)
-    @_loaded_plugins ||= {}
-    @_plugins        ||= []
-
-    return if @_loaded_plugins.key?(plugin_name)
-
-    plugin_module = Plugin.load(plugin_name)
-    plugin_module.configure(self, *, &) if plugin_module.respond_to?(:configure)
-
-    @_loaded_plugins[plugin_name] = plugin_module
-    @_plugins << plugin_name
+  def initialize
+    @_mutex ||= Mutex.new
+    yield self if block_given?
   end
 
-  def self.freeze!
-    app = new
-    app.freeze!
-    app
+  HTTP_METHODS.each do |http_method|
+    define_method(http_method.downcase) do |path, &block|
+      add_route(path, http_method, block)
+    end
   end
 
-  def self.add_route(path, http_method, block)
-    @_root ||= RouteNode.new
-    parts = path.split('/').reject(&:empty?)
-    @_root.add_route(parts, http_method, block)
+  def root
+    @root ||= RouteNode.new
   end
 
-  private_class_method :add_route
-
-  def initialize
-    @_mutex = Mutex.new
-    @_root             = self.class.instance_variable_get(:@_root)&.dup           || RouteNode.new
-    @_plugins          = self.class.instance_variable_get(:@_plugins)&.dup        || []
-    @_loaded_plugins   = self.class.instance_variable_get(:@_loaded_plugins)&.dup || {}
-    @_middlewares      = self.class.instance_variable_get(:@_middlewares)&.dup    || []
-
-    build_app
+  def app
+    @app ||= begin
+      request_handler = ->(env) { process_request(env) }
 
-    yield self if block_given?
-  end
-
-  def call(env) = @_mutex.synchronize { @_app.call(env) }
-
-  def freeze!
-    return self if @_mounted
-
-    @_root.freeze
-    @_plugins.freeze
-    @_loaded_plugins.freeze
-    @_middlewares.freeze
-    @_app.freeze if @_app.respond_to?(:freeze)
-    self
+      Rack::Builder.app do
+        run request_handler
+      end
+    end
   end
 
-  def get(path, &block)     = add_route(path, :GET, block)
-  def put(path, &block)     = add_route(path, :PUT, block)
-  def post(path, &block)    = add_route(path, :POST, block)
-  def head(path, &block)    = add_route(path, :HEAD, block)
-  def patch(path, &block)   = add_route(path, :PATCH, block)
-  def delete(path, &block)  = add_route(path, :DELETE, block)
-  def options(path, &block) = add_route(path, :OPTIONS, block)
-
-  def plugin(plugin_name, *, &)
-    return if @_loaded_plugins.key?(plugin_name)
+  def initializer!
+    Bundler.require(:default, ENV["LENNA_ENV"] || "development")
 
-    plugin_module = Plugin.load(plugin_name)
-    self.class.extend plugin_module::ClassMethods     if plugin_module.const_defined?(:ClassMethods)
-    self.class.include plugin_module::InstanceMethods if plugin_module.const_defined?(:InstanceMethods)
-    plugin_module.configure(self, *, &)               if plugin_module.respond_to?(:configure)
-    @_loaded_plugins[plugin_name] = plugin_module
-    @_plugins << plugin_name
+    root.freeze
+    app.freeze
   end
 
-  private
+  def call(env) = @_mutex.synchronize { app.call(env) }
 
-  def build_app
-    @_app = method(:process_request)
-
-    @_middlewares.reverse_each do |middleware, args, block|
-      @_app = middleware.new(@_app, *args, &block)
-    end
+  def add_route(path, http_method, block)
+    parts = path.split("/").reject(&:empty?)
+    root.add_route(parts, http_method, block)
   end
 
-  def process_request(env)
+  private def process_request(env)
     http_method = env[Rack::REQUEST_METHOD].to_sym
-    parts       = env[Rack::PATH_INFO].split('/').reject(&:empty?)
+    parts = env[Rack::PATH_INFO].split("/").reject(&:empty?)
 
-    block, params = @_root.match_route(parts, http_method)
-    return not_found unless block
+    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)
@@ -136,23 +66,7 @@ class Lennarb
       instance_exec(req, res, &block)
       res.finish
     end
-  rescue StandardError => e
-    handle_error(e)
-  end
-
-  def handle_error(error)
-    case error
-    when ArgumentError
-      [400, { 'content-type' => 'text/plain' }, ["Bad Request: #{error.message}"]]
-    else
-      [500, { 'content-type' => 'text/plain' }, ["Internal Server Error: #{error.message}"]]
-    end
-  end
-
-  def not_found = [404, { 'content-type' => 'text/plain' }, ['Not Found']]
-
-  def add_route(path, http_method, block)
-    parts = path.split('/').reject(&:empty?)
-    @_root.add_route(parts, http_method, block)
+  rescue => e
+    [500, {"content-type" => Response::ContentType[:TEXT]}, ["Internal Server Error - #{e.message}"]]
   end
 end

data/readme.md

@@ -1,8 +1,19 @@
-# Lennarb
+<div align="center">
+  <picture>
+    <img alt="Lennarb" src="logo/lennarb.png" width="250">
+  </picture>
 
-Lennarb is a lightweight, fast, and modular web framework for Ruby based on Rack. The **Lennarb** supports Ruby (MRI) 3.0+
+---
 
-**Basic Usage**
+A lightweight, fast, and modular web framework for Ruby based on Rack. The **Lennarb** supports Ruby (MRI) 3.4+
+
+[![Tests](https://github.com/aristotelesbr/lennarb/workflows/rubyby-tests/badge.svg)](https://github.com/aristotelesbr/lennarb)
+[![Gem](https://img.shields.io/gem/v/lennarb.svg)](https://rubygems.org/gems/lennarb)
+[![Gem](https://img.shields.io/gem/dt/lennarb.svg)](https://rubygems.org/gems/lennarb)
+[![MIT License](https://img.shields.io/:License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+</div>
+
+## Basic Usage
 
 ```ruby
 require "lennarb"
@@ -36,13 +47,13 @@ Plese see [Performance](https://aristotelesbr.github.io/lennarb/guides/performan
 
 ## Usage
 
-  - [Getting Started](https://aristotelesbr.github.io/lennarb/guides/getting-started/index) - This guide covers getting up and running with **Lennarb**.
+- [Getting Started](https://aristotelesbr.github.io/lennarb/guides/getting-started/index) - This guide covers getting up and running with **Lennarb**.
 
-  - [Performance](https://aristotelesbr.github.io/lennarb/guides/performance/index.html) - The **Lennarb** is very fast. The following benchmarks were performed on a MacBook Pro (Retina, 13-inch, Early 2013) with 2,7 GHz Intel Core i7 and 8 GB 1867 MHz DDR3. Based on [jeremyevans/r10k](https://github.com/jeremyevans/r10k) using the following [template build](static/r10k/build/lennarb.rb).
+- [Performance](https://aristotelesbr.github.io/lennarb/guides/performance/index.html) - The **Lennarb** is very fast. The following benchmarks were performed on a MacBook Pro (Retina, 13-inch, Early 2013) with 2,7 GHz Intel Core i7 and 8 GB 1867 MHz DDR3. Based on [jeremyevans/r10k](https://github.com/jeremyevans/r10k) using the following [template build](static/r10k/build/lennarb.rb).
 
-  - [Plugin](https://aristotelesbr.github.io/lennarb/guides/plugin/index.html) - You can create your plugins to extend the functionality of the framework.
+- [Plugin](https://aristotelesbr.github.io/lennarb/guides/plugin/index.html) - You can create your plugins to extend the functionality of the framework.
 
-  - [Response](https://aristotelesbr.github.io/lennarb/guides/response/index.html) - This is the response guide.
+- [Response](https://aristotelesbr.github.io/lennarb/guides/response/index.html) - This is the response guide.
     The `res` object is used to send a response to the client. The Lennarb use a custom response object to send responses to the client. The `res` object is an instance of `Lennarb::Response`.
 
 ### Developer Certificate of Origin