lennarb 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133bc5b7fbe787ae7bf9d17f79cddb09d75f3e1d12e99deff891edae698b109a
-  data.tar.gz: de9d4b466c30c19b1fd84e6d55c162f144904aa09d22d4bc874bb7291eb72ce8
+  metadata.gz: 3a9951f0d799cadd7b4c3025eeaa9b050dd3920524b0a256530b4c53bb924a74
+  data.tar.gz: 39e78cd19783b98bb9f88d064821207dbc506c94f6742b840bfc3e31ed6568e9
 SHA512:
-  metadata.gz: 1aa540d8f1f3d7d82104f441f4d141249485597d34d80072bb2c5df38237ea2651dba35b4f2499f00be7c9d1a94755c2400aefbe102283ff5a0ea3341dc74e97
-  data.tar.gz: 5660b98b90c019ff4501076845668ddea45210e701d91eae9b99c38a36ee7605511903178e986239934078d22aa8d7156d6efe4c73560e5c4951d7c734fa6f77
+  metadata.gz: 9ec6a17703b76f22f9f24f1d356c8bf190ed351d1629deeffaf5b871d3ae5907130d90d9329cc9b51f859659c75732fdb034dc029d81c7faed324979e536b090
+  data.tar.gz: 5efe46152e8796c8f07d19d0117da18c7868f07bf472be060de06ae140ff6cccbf69daf9d0b0883584875e600ecf0855ec52cffbef253c277325cbdbd2363d72

data/changelog.md

@@ -5,6 +5,72 @@ 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.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
+
+- Add `console` gem to print the logs in the console.
+
+- Add CLI module to:
+  - Create a new project with `lennarb new` command.
+  - Run the server with `lennarb server` command.
+
+- Add simple guide to create and run a project with Lennarb. See [guides/command-line/readme.md](guides/command-line/readme.md) for more details.
+
+- Add `Reload` middleware to reload the application in development environment. You can import and use this middleware in your application. Ex.
+
+```rb
+# app.rb
+
+require 'lenna/middleware/default/reload'
+
+app = Lenna::Application.new
+
+app.use Lenna::Middleware::Default::Reload
+```
+
+In the next version, this middleware will be available by default in development environment.
+
+- Add `root` method to `Lennarb` module to get the root path of the project. Ex.
+
+```rb
+# app.rb
+
+Lennarb.root.join('app.rb')
+# => /home/user/project/app.rb
+```
+
+- Add `zeitwerk` gem to load the files in the project.
+
+### Remove
+
+- Remove `Logging` and `ErrorHandling` middlewares from any environment. Now, theses middlewares are only available in development environment.
+
+### Changed
+
+- Change log level to `fatal` in test environment.
+
 ## [0.1.6] - 2023-21-12
 
 ### Changed
@@ -81,16 +147,16 @@ request.params = { name: 'John' }
 require 'lennarb'
 
 app = Lennarb::Application.new do |app|
-		app.get '/hello' do |req, res|
-				res.status = 200
-				res['Content-Type'] = 'text/plain'
-				res.body = 'Hello World'
-		end
-		app.post '/hello' do |req, res|
-				res.status = 200
-				res['Content-Type'] = 'text/plain'
-				res.body = 'Hello World'
-		end
+  app.get '/hello' do |req, res|
+    res.status = 200
+    res['Content-Type'] = 'text/plain'
+    res.body = 'Hello World'
+  end
+  app.post '/hello' do |req, res|
+    res.status = 200
+    res['Content-Type'] = 'text/plain'
+    res.body = 'Hello World'
+  end
 end
 
 run app

data/exe/lenna

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
+# Require the main file
+#
+# @private `Since v0.1`
+#
+require 'lennarb'
+
+# Show the version
+#
+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
+		#
+		# @return [Request]
+		#
+		def initialize(env, route_params = {})
+			super(env)
+			@route_params = route_params
+		end
+
+		# Get the request body
+		#
+		# @return [String]
+		def params
+			@params ||= super.merge(@route_params)
+		end
+
+		private
+
+		# Get the query string
+		#
+		# @return [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
+		#  @return [Integer]
+		#
+		attr_accessor :status
+
+		# @!attribute [r] body
+		#  @return [Array]
+		#
+		attr_reader :body
+
+		# @!attribute [r] headers
+		#  @return [Hash]
+		#
+		attr_reader :headers
+
+		# @!attribute [r] length
+		#  @return [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
+		#
+		# @return [Response]
+		#
+		def initialize
+			@status = 404
+			@headers = {}
+			@body    = []
+			@length  = 0
+		end
+
+		# Set the response header
+		#
+		# @parameter [String] key
+		#
+		# @return [String] value
+		#
+		def [](key)
+			@headers[key]
+		end
+
+		# Get the response header
+		#
+		# @parameter [String] key
+		# @parameter [String] value
+		#
+		# @return [String] value
+		#
+		def []=(key, value)
+			@headers[key] = value
+		end
+
+		# Write to the response body
+		#
+		# @parameter [String] str
+		#
+		# @return [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
+		#
+		# @return [String] str
+		#
+		def text(str)
+			@headers[CONTENT_TYPE] = ContentType[:TEXT]
+			write(str)
+		end
+
+		# Set the response type to html
+		#
+		# @parameter [String] str
+		#
+		# @return [String] str
+		#
+		def html(str)
+			@headers[CONTENT_TYPE] = ContentType[:HTML]
+			write(str)
+		end
+
+		# Set the response type to json
+		#
+		# @parameter [String] str
+		#
+		# @return [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
+		#
+		# @return [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.6'
+class Lennarb
+	VERSION = '0.2.0'
 
 	public_constant :VERSION
 end

data/lib/lennarb.rb

@@ -1,15 +1,97 @@
 # 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'
+
+class Lennarb
+	# Error class
+	#
+	class LennarbError < StandardError; end
+
+	# @attribute [r] root
+	# @return [RouteNode]
+	#
+	attr_reader :root
+
+	# Initialize the application
+	#
+	# @yield { ... } The application
+	#
+	# @return [Lennarb]
+	#
+	def initialize
+		@root = RouteNode.new
+		yield self if block_given?
+	end
+
+	# Split a path into parts
+	#
+	# @parameter [String] path
+	#
+	# @return [Array] parts. Ex. ['users', ':id']
+	#
+	SplitPath = ->(path) { path.split('/').reject(&:empty?) }
+	private_constant :SplitPath
+
+	# Call the application
+	#
+	# @parameter [Hash] env
+	#
+	# @return [Array] response
+	#
+	def call(env)
+		res = Response.new
+		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
+
+		req = Request.new(env, params)
+		instance_exec(req, res, &block)
+
+		res.finish
+	end
+
+	# Add a routes
+	#
+	# @parameter [String] path
+	# @parameter [Proc] block
+	#
+	# @return [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)
+
+	private
+
+	# Add a route
+	#
+	# @parameter [String] path
+	# @parameter [String] http_method
+	# @parameter [Proc] block
+	#
+	# @return [void]
+	#
+	def add_route(path, http_method, block)
+		parts = SplitPath[path]
+		@root.add_route(parts, http_method, block)
+	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,43 @@
 # 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
+```
 
-Please see the [project documentation](https://aristotelesbr.github.io/lennarb) for more details.
+## Performance
 
-  - [Getting Started](https://aristotelesbr.github.io/lennarbguides/getting-started/index) - This guide show you how to use the `lennarb`
+### 1. Requests per Second (RPS)
 
-  - [Middlewares](https://aristotelesbr.github.io/lennarbguides/middlewares/index) - This guide shows how to use middlewares in Lennarb.
+| 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  |
 
-  - [Namespace routes](https://aristotelesbr.github.io/lennarbguides/namespace-routes/index) - This guide show you how to use namespace routes.
+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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lennarb
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Aristóteles Coutinho
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -48,16 +48,30 @@ dependencies:
   name: bake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: covered
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.25.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -130,24 +172,17 @@ dependencies:
         version: 0.33.0
 description:
 email:
-executables: []
+executables:
+- lenna
 extensions: []
 extra_rdoc_files: []
 files:
 - changelog.md
-- lib/lenna/application.rb
-- lib/lenna/middleware/app.rb
-- lib/lenna/middleware/default/error_handler.rb
-- lib/lenna/middleware/default/logging.rb
-- lib/lenna/router.rb
-- lib/lenna/router/builder.rb
-- lib/lenna/router/cache.rb
-- lib/lenna/router/namespace_stack.rb
-- lib/lenna/router/request.rb
-- lib/lenna/router/response.rb
-- lib/lenna/router/route_matcher.rb
+- exe/lenna
 - lib/lennarb.rb
-- lib/lennarb/array_extensions.rb
+- lib/lennarb/request.rb
+- lib/lennarb/response.rb
+- lib/lennarb/route_node.rb
 - lib/lennarb/version.rb
 - license.md
 - readme.md
@@ -168,14 +203,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A lightweight and experimental web framework for Ruby.