lennarb 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9951f0d799cadd7b4c3025eeaa9b050dd3920524b0a256530b4c53bb924a74
-  data.tar.gz: 39e78cd19783b98bb9f88d064821207dbc506c94f6742b840bfc3e31ed6568e9
+  metadata.gz: 9dfa4cf1e25284df8669a9fdd9faf45806575137b0b2a2cd131e4af205426176
+  data.tar.gz: 879b617cb51177961a055e2dfd069437e9cae0c7e781fb50aad410c14b271dd8
 SHA512:
-  metadata.gz: 9ec6a17703b76f22f9f24f1d356c8bf190ed351d1629deeffaf5b871d3ae5907130d90d9329cc9b51f859659c75732fdb034dc029d81c7faed324979e536b090
-  data.tar.gz: 5efe46152e8796c8f07d19d0117da18c7868f07bf472be060de06ae140ff6cccbf69daf9d0b0883584875e600ecf0855ec52cffbef253c277325cbdbd2363d72
+  metadata.gz: '087d53fc3627a7c61f028826f0af5ea8fc26e6fb02a2a461c54154852bbc9b71d9d65becf7faf5451e81612eeb9129b307002861aac49b3e85ecc1dab4e6a6de'
+  data.tar.gz: 74d0156c558d8619e66b2daa5d5449216d064b38c511efb01cea802397efc2323b149e71cb1a3756af591c58b10510aef48dcc77ec40e20cbbae6f2a350a38a7

data/changelog.md

@@ -5,6 +5,33 @@ 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

data/lib/lennarb/request.rb

@@ -10,7 +10,7 @@ class Lennarb
 		# @parameter [Hash] env
 		# @parameter [Hash] route_params
 		#
-		# @return [Request]
+		# @returns [Request]
 		#
 		def initialize(env, route_params = {})
 			super(env)
@@ -19,7 +19,7 @@ class Lennarb
 
 		# Get the request body
 		#
-		# @return [String]
+		# @returns [String]
 		def params
 			@params ||= super.merge(@route_params)
 		end
@@ -28,7 +28,7 @@ class Lennarb
 
 		# Get the query string
 		#
-		# @return [String]
+		# @returns [String]
 		#
 		def query_params
 			@query_params ||= Rack::Utils.parse_nested_query(query_string)

data/lib/lennarb/response.rb

@@ -6,22 +6,22 @@
 class Lennarb
 	class Response
 		# @!attribute [rw] status
-		#  @return [Integer]
+		#  @returns [Integer]
 		#
 		attr_accessor :status
 
 		# @!attribute [r] body
-		#  @return [Array]
+		#  @returns [Array]
 		#
 		attr_reader :body
 
 		# @!attribute [r] headers
-		#  @return [Hash]
+		#  @returns [Hash]
 		#
 		attr_reader :headers
 
 		# @!attribute [r] length
-		#  @return [Integer]
+		#  @returns [Integer]
 		#
 		attr_reader :length
 
@@ -41,7 +41,7 @@ class Lennarb
 
 		# Initialize the response object
 		#
-		# @return [Response]
+		# @returns [Response]
 		#
 		def initialize
 			@status = 404
@@ -54,7 +54,7 @@ class Lennarb
 		#
 		# @parameter [String] key
 		#
-		# @return [String] value
+		# @returns [String] value
 		#
 		def [](key)
 			@headers[key]
@@ -65,7 +65,7 @@ class Lennarb
 		# @parameter [String] key
 		# @parameter [String] value
 		#
-		# @return [String] value
+		# @returns [String] value
 		#
 		def []=(key, value)
 			@headers[key] = value
@@ -75,7 +75,7 @@ class Lennarb
 		#
 		# @parameter [String] str
 		#
-		# @return [String] str
+		# @returns [String] str
 		#
 		def write(str)
 			str = str.to_s
@@ -88,7 +88,7 @@ class Lennarb
 		#
 		# @parameter [String] str
 		#
-		# @return [String] str
+		# @returns [String] str
 		#
 		def text(str)
 			@headers[CONTENT_TYPE] = ContentType[:TEXT]
@@ -99,7 +99,7 @@ class Lennarb
 		#
 		# @parameter [String] str
 		#
-		# @return [String] str
+		# @returns [String] str
 		#
 		def html(str)
 			@headers[CONTENT_TYPE] = ContentType[:HTML]
@@ -110,7 +110,7 @@ class Lennarb
 		#
 		# @parameter [String] str
 		#
-		# @return [String] str
+		# @returns [String] str
 		#
 		def json(str)
 			@headers[CONTENT_TYPE] = ContentType[:JSON]
@@ -129,7 +129,7 @@ class Lennarb
 
 		# Finish the response
 		#
-		# @return [Array] response
+		# @returns [Array] response
 		#
 		def finish
 			[@status, @headers, @body]

data/lib/lennarb/route_node.rb

@@ -12,7 +12,7 @@ class Lennarb
 		# @return [RouteNode]
 		#
 		def initialize
-			@children = {}
+			@children  = {}
 			@blocks    = {}
 			@param_key = nil
 		end

data/lib/lennarb/version.rb

@@ -4,7 +4,7 @@
 # Copyright, 2023-2024, by Aristóteles Coutinho.
 
 class Lennarb
-	VERSION = '0.2.0'
+	VERSION = '0.4.0'
 
 	public_constant :VERSION
 end

data/lib/lennarb.rb

@@ -23,7 +23,7 @@ class Lennarb
 	class LennarbError < StandardError; end
 
 	# @attribute [r] root
-	# @return [RouteNode]
+	# @returns [RouteNode]
 	#
 	attr_reader :root
 
@@ -31,7 +31,7 @@ class Lennarb
 	#
 	# @yield { ... } The application
 	#
-	# @return [Lennarb]
+	# @returns [Lennarb]
 	#
 	def initialize
 		@root = RouteNode.new
@@ -42,7 +42,7 @@ class Lennarb
 	#
 	# @parameter [String] path
 	#
-	# @return [Array] parts. Ex. ['users', ':id']
+	# @returns [Array] parts. Ex. ['users', ':id']
 	#
 	SplitPath = ->(path) { path.split('/').reject(&:empty?) }
 	private_constant :SplitPath
@@ -51,16 +51,16 @@ class Lennarb
 	#
 	# @parameter [Hash] env
 	#
-	# @return [Array] response
+	# @returns [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
 
+		res = Response.new
 		req = Request.new(env, params)
 		instance_exec(req, res, &block)
 
@@ -72,15 +72,13 @@ class Lennarb
 	# @parameter [String] path
 	# @parameter [Proc] block
 	#
-	# @return [void]
+	# @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)
-
-	private
+	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
 	#
@@ -88,10 +86,54 @@ class Lennarb
 	# @parameter [String] http_method
 	# @parameter [Proc] block
 	#
-	# @return [void]
+	# @returns [void]
 	#
-	def add_route(path, http_method, block)
+	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/readme.md

@@ -19,6 +19,10 @@ end
 
 ### 1. Requests per Second (RPS)
 
+![RPS](https://raw.githubusercontent.com/aristotelesbr/lennarb/main/benchmark/rps.png)
+
+See all [graphs](https://github.com/aristotelesbr/lennarb/blob/main/benchmark)
+
 | 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  |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lennarb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Aristóteles Coutinho
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: A lightweight and experimental web framework for Ruby.