lennarb 0.1.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b1fe759bb5de90ef757201a4023c441a9c40146f31a318aecc5c5c08cd04bb
-  data.tar.gz: 8137ee838ca5636d7013cbfa5aa5f7e83d66e3b28d3387255b702d82becd884a
+  metadata.gz: 9dfa4cf1e25284df8669a9fdd9faf45806575137b0b2a2cd131e4af205426176
+  data.tar.gz: 879b617cb51177961a055e2dfd069437e9cae0c7e781fb50aad410c14b271dd8
 SHA512:
-  metadata.gz: 3216bc56c89485d3292b621dcdfb26082957bea1ecfc622107b2f631f86508d7eb5318ce5bc43889ccf0db59775dcefd34e7e4ac00f5b023f34c4f371bab83b9
-  data.tar.gz: 944b432173eeeee78c2fc8d546ee74f6768ab3581a61babfdad27f8e54969afd96581259d8866126a3e6e26c2418f92355af8cc07d3aa215b0f9fb9a6bceccc0
+  metadata.gz: '087d53fc3627a7c61f028826f0af5ea8fc26e6fb02a2a461c54154852bbc9b71d9d65becf7faf5451e81612eeb9129b307002861aac49b3e85ecc1dab4e6a6de'
+  data.tar.gz: 74d0156c558d8619e66b2daa5d5449216d064b38c511efb01cea802397efc2323b149e71cb1a3756af591c58b10510aef48dcc77ec40e20cbbae6f2a350a38a7

data/changelog.md

@@ -5,6 +5,54 @@ 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).
 
+## [0.4.0] - 2024-07-02
+
+### Added
+
+- Add `Lennarb::ApplicationBase` class to be the base class of the `Lennarb` class. Now, the `Lennarb` class is a subclass of `Lennarb::ApplicationBase` class.
+
+That permits to create a new application with the `Lennarb::ApplicationBase` class and use http methods to create the routes. Ex.
+
+```rb
+# app.rb
+
+require 'lennarb'
+
+class MyApp
+  include Lennarb::ApplicationBase
+
+	get '/hello' do |req, res|
+		res.html('Hello World')
+	end
+end
+```
+
+### Change
+
+- Change the test/test_lenna.rb to test/test_lennarb.rb
+- Change `add_route` method from `Lennarb` class to `__add_route` and remove from private section.
+
+## [0.2.0] - 2024-08-01
+
+### Removed
+
+- Remove `zeitwerk` gem to load the files in the project.
+- Remove `console` gem to print the logs in the console.
+- Remove `Lenna` module. Now, the `Lennarb` class is the main class of the project.
+- Remove `Middleware` module.
+- Remove `CLI` module.
+- Remove `Cache` module
+
+### Changed
+
+- Change `Lennarb::Application` class to `Lennarb` class.
+- Request class and Response class now are in `Lennarb` class
+- Change `Lennarb::Router` class to `Lennarb` class
+
+### Fixed
+
+- Improve performance of the RPS (Requests per second), memory and CPU usage. Now the performance is similar to the [Roda](https://github.com/jeremyevans/roda/tree/master).
+
 ## [0.1.7] - 2023-23-12
 
 ### Added

data/exe/lenna

@@ -10,8 +10,6 @@
 #
 require 'lennarb'
 
-# Call the CLI to start the server
+# Show the version
 #
-# @private `Since v0.1`
-#
-Lenna::Cli::App.run!(ARGV)
+puts Lennarb::VERSION

data/lib/lennarb/request.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Aristóteles Coutinho.
+
+class Lennarb
+	class Request < Rack::Request
+		# Initialize the request object
+		#
+		# @parameter [Hash] env
+		# @parameter [Hash] route_params
+		#
+		# @returns [Request]
+		#
+		def initialize(env, route_params = {})
+			super(env)
+			@route_params = route_params
+		end
+
+		# Get the request body
+		#
+		# @returns [String]
+		def params
+			@params ||= super.merge(@route_params)
+		end
+
+		private
+
+		# Get the query string
+		#
+		# @returns [String]
+		#
+		def query_params
+			@query_params ||= Rack::Utils.parse_nested_query(query_string)
+		end
+	end
+end

data/lib/lennarb/response.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Aristóteles Coutinho.
+
+class Lennarb
+	class Response
+		# @!attribute [rw] status
+		#  @returns [Integer]
+		#
+		attr_accessor :status
+
+		# @!attribute [r] body
+		#  @returns [Array]
+		#
+		attr_reader :body
+
+		# @!attribute [r] headers
+		#  @returns [Hash]
+		#
+		attr_reader :headers
+
+		# @!attribute [r] length
+		#  @returns [Integer]
+		#
+		attr_reader :length
+
+		# Constants
+		#
+		LOCATION = 'location'
+		private_constant :LOCATION
+
+		CONTENT_TYPE = 'content-type'
+		private_constant :CONTENT_TYPE
+
+		CONTENT_LENGTH = 'content-length'
+		private_constant :CONTENT_LENGTH
+
+		ContentType = { HTML: 'text/html', TEXT: 'text/plain', JSON: 'application/json' }.freeze
+		private_constant :ContentType
+
+		# Initialize the response object
+		#
+		# @returns [Response]
+		#
+		def initialize
+			@status = 404
+			@headers = {}
+			@body    = []
+			@length  = 0
+		end
+
+		# Set the response header
+		#
+		# @parameter [String] key
+		#
+		# @returns [String] value
+		#
+		def [](key)
+			@headers[key]
+		end
+
+		# Get the response header
+		#
+		# @parameter [String] key
+		# @parameter [String] value
+		#
+		# @returns [String] value
+		#
+		def []=(key, value)
+			@headers[key] = value
+		end
+
+		# Write to the response body
+		#
+		# @parameter [String] str
+		#
+		# @returns [String] str
+		#
+		def write(str)
+			str = str.to_s
+			@length += str.bytesize
+			@headers[CONTENT_LENGTH] ||= @length.to_s
+			@body << str
+		end
+
+		# Set the response type to text
+		#
+		# @parameter [String] str
+		#
+		# @returns [String] str
+		#
+		def text(str)
+			@headers[CONTENT_TYPE] = ContentType[:TEXT]
+			write(str)
+		end
+
+		# Set the response type to html
+		#
+		# @parameter [String] str
+		#
+		# @returns [String] str
+		#
+		def html(str)
+			@headers[CONTENT_TYPE] = ContentType[:HTML]
+			write(str)
+		end
+
+		# Set the response type to json
+		#
+		# @parameter [String] str
+		#
+		# @returns [String] str
+		#
+		def json(str)
+			@headers[CONTENT_TYPE] = ContentType[:JSON]
+			write(str)
+		end
+
+		# Redirect the response
+		#
+		# @parameter [String] path
+		# @parameter [Integer] status, default: 302
+		#
+		def redirect(path, status = 302)
+			@headers[LOCATION] = path
+			@status = status
+		end
+
+		# Finish the response
+		#
+		# @returns [Array] response
+		#
+		def finish
+			[@status, @headers, @body]
+		end
+	end
+end

data/lib/lennarb/route_node.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Aristóteles Coutinho.
+
+class Lennarb
+	class RouteNode
+		attr_accessor :children, :blocks, :param_key
+
+		# Initialize the route node
+		#
+		# @return [RouteNode]
+		#
+		def initialize
+			@children  = {}
+			@blocks    = {}
+			@param_key = nil
+		end
+
+		# Add a route to the route node
+		#
+		# @parameter [Array] parts
+		# @parameter [String] http_method
+		# @parameter [Proc] block
+		#
+		# @return [void]
+		#
+		def add_route(parts, http_method, block)
+			current_node = self
+
+			parts.each do |part|
+				if part.start_with?(':')
+					key = :param
+					current_node.children[key] ||= RouteNode.new
+					current_node = current_node.children[key]
+					current_node.param_key = part[1..].to_sym
+				else
+					key = part
+					current_node.children[key] ||= RouteNode.new
+					current_node = current_node.children[key]
+				end
+			end
+
+			current_node.blocks[http_method] = block
+		end
+
+		# Match a route to the route node
+		#
+		# @parameter [Array] parts
+		# @parameter [String] http_method
+		#
+		# @return [Array]
+		#
+		def match_route(parts, http_method)
+			current_node = self
+			params = {}
+
+			parts.each do |part|
+				return [nil, nil] unless current_node.children.key?(part) || current_node.children[:param]
+
+				if current_node.children.key?(part)
+					current_node = current_node.children[part]
+				else
+					param_node = current_node.children[:param]
+					params[param_node.param_key] = part
+					current_node = param_node
+				end
+			end
+
+			[current_node.blocks[http_method], params]
+		end
+	end
+end

data/lib/lennarb/version.rb

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

data/lib/lennarb.rb

@@ -1,46 +1,139 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Aristóteles Coutinho.
+# Copyright, 2023-2024, by Aristóteles Coutinho.
 
 ENV['RACK_ENV'] ||= 'development'
 
-# Extension for Array class
+# Core extensions
 #
-require 'lennarb/array_extensions'
+require 'pathname'
+require 'rack'
 
 # Base class for Lennarb
 #
-require 'lenna/application'
-require 'lennarb/version'
+require_relative 'lennarb/request'
+require_relative 'lennarb/response'
+require_relative 'lennarb/route_node'
+require_relative 'lennarb/version'
 
-# Core extensions
-#
-require 'pathname'
+class Lennarb
+	# Error class
+	#
+	class LennarbError < StandardError; end
 
-# Zeitwerk
-#
-require 'zeitwerk'
+	# @attribute [r] root
+	# @returns [RouteNode]
+	#
+	attr_reader :root
 
-# Zeitwerk loader
-#
-Zeitwerk::Loader.new.tap do |loader|
-	loader.inflector.inflect('Version' => 'VERSION')
-	loader.push_dir(__dir__)
-	loader.setup
-end
+	# Initialize the application
+	#
+	# @yield { ... } The application
+	#
+	# @returns [Lennarb]
+	#
+	def initialize
+		@root = RouteNode.new
+		yield self if block_given?
+	end
 
-# Lennarb module
-#
-module Lennarb
-	module_function
+	# Split a path into parts
+	#
+	# @parameter [String] path
+	#
+	# @returns [Array] parts. Ex. ['users', ':id']
+	#
+	SplitPath = ->(path) { path.split('/').reject(&:empty?) }
+	private_constant :SplitPath
 
-	# Lennarb root path
+	# Call the application
+	#
+	# @parameter [Hash] env
 	#
-	# @return [Pathname] the root path
+	# @returns [Array] response
 	#
-	def root
-		File.expand_path('..', __dir__)
-		Pathname.new(File.expand_path('..', __dir__))
+	def call(env)
+		http_method = env.fetch('REQUEST_METHOD').to_sym
+		parts       = SplitPath[env.fetch('PATH_INFO')]
+
+		block, params = @root.match_route(parts, http_method)
+		return [404, { 'content-type' => 'text/plain' }, ['Not Found']] unless block
+
+		res = Response.new
+		req = Request.new(env, params)
+		instance_exec(req, res, &block)
+
+		res.finish
+	end
+
+	# Add a routes
+	#
+	# @parameter [String] path
+	# @parameter [Proc] block
+	#
+	# @returns [void]
+	#
+	def get(path, &block)    = __add_route__(path, :GET, block)
+	def post(path, &block)   = __add_route__(path, :POST, block)
+	def put(path, &block)    = __add_route__(path, :PUT, block)
+	def patch(path, &block)  = __add_route__(path, :PATCH, block)
+	def delete(path, &block) = __add_route__(path, :DELETE, block)
+
+	# Add a route
+	#
+	# @parameter [String] path
+	# @parameter [String] http_method
+	# @parameter [Proc] block
+	#
+	# @returns [void]
+	#
+	def __add_route__(path, http_method, block)
+		parts = SplitPath[path]
+		@root.add_route(parts, http_method, block)
+	end
+
+	# Base module for the application. The main purpose is to include the class methods
+	# and call the Lennarb instance.
+	#
+	module ApplicationBase
+		# Include the class methods
+		#
+		# @parameter [Class] base
+		#
+		# @returns [void]
+		#
+		def self.included(base) = base.extend(ClassMethods)
+
+		# Call the Lennarb instance
+		#
+		# @parameter [Hash] env
+		#
+		# @returns [Array]
+		#
+		def call(env) = self.class.lennarb_instance.call(env)
+
+		# Class methods
+		#
+		module ClassMethods
+			# Get the Lennarb instance
+			#
+			# @returns [Lennarb]
+			#
+			def lennarb_instance = @lennarb_instance ||= Lennarb.new
+
+			# Add a route
+			#
+			# @parameter [String] path
+			# @parameter [Proc] block
+			#
+			# @returns [void]
+			#
+			def get(path, &block)    = lennarb_instance.__add_route__(path, :GET, block)
+			def put(path, &block)    = lennarb_instance.__add_route__(path, :PUT, block)
+			def post(path, &block)   = lennarb_instance.__add_route__(path, :POST, block)
+			def patch(path, &block)  = lennarb_instance.__add_route__(path, :PATCH, block)
+			def delete(path, &block) = lennarb_instance.__add_route__(path, :DELETE, block)
+		end
 	end
 end

data/license.md

@@ -1,6 +1,7 @@
 # MIT License
 
-Copyright, 2023, by Aristóteles Coutinho.  
+Copyright, 2023-2024, by Aristóteles Coutinho.  
+Copyright, 2023, by aristotelesbr.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -1,26 +1,47 @@
 # Lennarb
 
-Lennarb is a experimental lightweight, fast, and modular web framework for Ruby based on Rack.
+Lennarb is a lightweight, fast, and modular web framework for Ruby based on Rack. The **Lennarb** supports Ruby (MRI) 3.0+
 
-## Usage
+**Basic Usage**
+
+```ruby
+require "lennarb"
+
+Lennarb.new do |router|
+  router.get("/hello/:name") do |req, res|
+    name = req.params[:name]
+    res.html("Hello, #{name}!")
+  end
+end
+```
+
+## Performance
 
-Please see the [project documentation](https://aristotelesbr.github.io/lennarb) for more details.
+### 1. Requests per Second (RPS)
 
-  - [Getting Started](https://aristotelesbr.github.io/lennarbguides/getting-started/index) - This guide show you how to use the `lennarb`
+![RPS](https://raw.githubusercontent.com/aristotelesbr/lennarb/main/benchmark/rps.png)
 
-  - [Middlewares](https://aristotelesbr.github.io/lennarbguides/middlewares/index) - This guide shows how to use middlewares in Lennarb.
+See all [graphs](https://github.com/aristotelesbr/lennarb/blob/main/benchmark)
 
-  - [Namespace routes](https://aristotelesbr.github.io/lennarbguides/namespace-routes/index) - This guide show you how to use namespace routes.
+| 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.
+
+Plese see [Performance](https://aristotelesbr.github.io/lennarb/guides/performance/index.html) for more information.
+
+## Usage
 
-## Contributing
+  - [Getting Started](https://aristotelesbr.github.io/lennarb/guides/getting-started/index) - This guide covers getting up and running with **Lennarb**.
 
-We welcome contributions to this project.
+  - [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).
 
-1.  Fork it.
-2.  Create your feature branch (`git checkout -b my-new-feature`).
-3.  Commit your changes (`git commit -am 'Add some feature'`).
-4.  Push to the branch (`git push origin my-new-feature`).
-5.  Create new Pull Request.
+  - [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