lennarb 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f83fbde3862f89138c06960e7e10d92febf1b2568ec1ac7d5f414e56eb7861
-  data.tar.gz: 2ae1191814fc395c684f7d3b52a3d16d41cdb722d61ebd1c18937ab7e2eeff00
+  metadata.gz: 888f84e566de65f5c87013ff56ac3fe485f59acba6f1cc39862178894cf101fa
+  data.tar.gz: 8703693e316b83f747f927c23b07d56f6dd571f813d8c00901432cf6c941d1f2
 SHA512:
-  metadata.gz: 9bf21b6aeaaafc3b1c1f795ae356883ad6c4581506527f6b92b2a10b823770e6d5a8249dc7ebacc0776e0d5a8b4d10a818dcb05ac22ec5cb48e84c7f027d9925
-  data.tar.gz: 96a9067abdf1f6062da9cac71fd79df3a7da8d01a19d662419c9f7d9498438b57299074a5ac2ac86b44271f263e0a52c69d8f48e69c7843177191a653d68e508
+  metadata.gz: bc83791eb32ad87b5aa772f375b048829d794d35bdea5c5d1d083dc4a2e8b27560b313c79f51ca7a3a7084d73cc4ddeb9fb17a29a33a211bd53db57090af791a
+  data.tar.gz: a1fb09a73e8610d562cb4f4ea5e2ce1a07ffa68f4574363f07700b0e1004823fb5f1003d6cf6276fec2eb0002894ddf4dce7c7e4c4b55773bbb729a96ec74f4c

data/changelog.md

@@ -5,6 +5,37 @@ 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).
 
+## [Unreleased]
+
+## [0.4.4] - 2024-04-02
+
+### Added
+
+- Add `Lennarb::Router` module to manage the routes in the project. Now, the `Lennarb` class is the main class of the project.
+
+## [0.4.3] - 2024-04-01
+
+### Added
+
+### Remove
+
+- Remove `Lennarb::ApplicationBase` class from the project. Now, the `Lennarb` class is the main class of the project.
+
+### Changed
+
+- Improve performance of the RPS (Requests per second), memory and CPU usage.
+- Change the `finish` method from `Lennarb` class to call `halt(@res.finish)` method to finish the response.
+
+## [0.4.2] - 2024-08-02
+
+### Added
+
+- Add `header` and `options` methods to `Lennarb` and `Lennarb::ApplicatiobBase`.
+
+### Fix
+
+- Fix Content-Length header to be the length of the body in the response.
+
 ## [0.4.1] - 2024-08-02
 
 ### Change

data/lib/lennarb/application/base.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Aristóteles Coutinho.
+
+class Lennarb
+	module Application
+		class Base
+			# @attribute [r] _route
+			# @returns [RouteNode]
+			#
+			# @attribute [r] _middlewares
+			# @returns [Array]
+			#
+			# @attribute [r] _global_after_hooks
+			# @returns [Array]
+			#
+			# @attribute [r] _global_before_hooks
+			# @returns [Array]
+			#
+			# @attribute [r] _after_hooks
+			# @returns [RouteNode]
+			#
+			# @attribute [r] _before_hooks
+			# @returns [RouteNode]
+			#
+			attr_accessor :_route, :_global_after_hooks, :_global_before_hooks, :_after_hooks, :_before_hooks
+
+			# Initialize the Application
+			#
+			# @returns [Base]
+			#
+			def self.inherited(subclass)
+				subclass.instance_variable_set(:@_route, Lennarb.new)
+				subclass.instance_variable_set(:@_middlewares, [])
+				subclass.instance_variable_set(:@_global_after_hooks, [])
+				subclass.instance_variable_set(:@_global_before_hooks, [])
+				subclass.instance_variable_set(:@_after_hooks, Lennarb::RouteNode.new)
+				subclass.instance_variable_set(:@_before_hooks, Lennarb::RouteNode.new)
+			end
+
+			def self.get(...)     = @_route.get(...)
+			def self.put(...)     = @_route.put(...)
+			def self.post(...)    = @_route.post(...)
+			def self.head(...)    = @_route.head(...)
+			def self.match(...)   = @_route.match(...)
+			def self.patch(...)   = @_route.patch(...)
+			def self.delete(...)  = @_route.delete(...)
+			def self.options(...) = @_route.options(...)
+
+			# @returns [Array] middlewares
+			def self.middlewares = @_middlewares
+
+			# Use a middleware
+			#
+			# @parameter [Object] middleware
+			# @parameter [Array] args
+			# @parameter [Block] block
+			#
+			# @returns [Array] middlewares
+			#
+			def self.use(middleware, *args, &block)
+				@_middlewares << [middleware, args, block]
+			end
+
+			# Add a before hook
+			#
+			# @parameter [String] path
+			# @parameter [Block] block
+			#
+			def self.before(path = nil, &block)
+				if path
+					parts = path.split('/').reject(&:empty?)
+					@_before_hooks.add_route(parts, :before, block)
+				else
+					@_global_before_hooks << block
+				end
+			end
+
+			# Add a after hook
+			#
+			# @parameter [String] path
+			# @parameter [Block] block
+			#
+			def self.after(path = nil, &block)
+				if path
+					parts = path.split('/').reject(&:empty?)
+					@_after_hooks.add_route(parts, :after, block)
+				else
+					@_global_after_hooks << block
+				end
+			end
+
+			# Call the application
+			#
+			# @parameter [Hash] env
+			#
+			# @returns [Array] response
+			#
+			def self.call(env)
+				response =
+					catch(:halt) do
+						execute_hooks(@_before_hooks, env, :before)
+
+						res = @_route.call(env)
+
+						execute_hooks(@_after_hooks, env, :after)
+						res
+					end
+
+				case response
+				in [404 | 404, _, _] if html_request?(env) && File.exist?('public/404.html')
+					env['PATH_INFO'] = '/404.html'
+					Rack::Static.new(-> { response }, urls: ['/404.html'], root: 'public').call(env)
+				in [404 | 404, _, _] then response
+				else
+					response.is_a?(Array) ? response : response.finish
+				end
+			end
+
+			# Run the Application
+			#
+			# @returns [Base] self
+			#
+			# When you use this method, the application will be frozen. And you can't add more routes after that.
+			# This method is used to run the application in a Rack server so, you can use the `rackup` command to run the application.
+			# Ex. rackup -p 3000
+			# This command will use the following middleware:
+			#  - Rack::ShowExceptions
+			#  - Rack::Lint
+			#  - Rack::MethodOverride
+			#  - Rack::Head
+			#  - Rack::ContentLength
+			#  - Rack::Static
+			#
+			def self.run!
+				stack = Rack::Builder.new
+
+				use Rack::ShowExceptions
+				use Rack::Lint
+				use Rack::MethodOverride
+				use Rack::Head
+				use Rack::ContentLength
+				use Rack::Static,
+								root: 'public',
+								urls: ['/404.html'],
+								header_rules: [
+									[200, %w[html], { 'content-type' => 'text/html; charset=utf-8' }]
+								]
+
+				middlewares.each do |(middleware, args, block)|
+					stack.use(middleware, *args, &block)
+				end
+
+				stack.run @_route
+
+				@_route.freeze!
+
+				@_route = stack.to_app.freeze
+
+				self
+			end
+
+			# Redirect to a path
+			#
+			# @parameter [String] path
+			# @parameter [Integer] status default is 302
+			# @parameter [Hash] env (optional)
+			#
+			def self.redirect(path, status = 302, _env = nil)
+				response = Rack::Response.new([], status, 'location' => path)
+				throw :halt, response.finish
+			end
+
+			# Execute the hooks
+			#
+			# @parameter [RouteNode] hook_route
+			# @parameter [Hash] env
+			# @parameter [Symbol] action
+			#
+			# @returns [void]
+			#
+			def self.execute_hooks(hook_route, env, action)
+				execute_global_hooks(env, action)
+
+				execute_route_hooks(hook_route, env, action)
+			end
+
+			# Execute the global hooks
+			#
+			# @parameter [Hash] env
+			# @parameter [Symbol] action
+			#
+			# @returns [void]
+			#
+			def self.execute_global_hooks(env, action)
+				global_hooks = action == :before ? @_global_before_hooks : @_global_after_hooks
+				global_hooks.each { |hook| hook.call(env) }
+			end
+
+			# Execute the route hooks
+			#
+			# @parameter [RouteNode] hook_route
+			# @parameter [Hash] env
+			# @parameter [Symbol] action
+			#
+			# @returns [void]
+			#
+			def self.execute_route_hooks(hook_route, env, action)
+				parts = parse_path(env)
+				return unless parts
+
+				block, = hook_route.match_route(parts, action)
+				block&.call(env)
+			end
+
+			# Parse the path
+			#
+			# @parameter [Hash] env
+			#
+			# @returns [Array] parts
+			#
+			def self.parse_path(env) = env[Rack::PATH_INFO]&.split('/')&.reject(&:empty?)
+
+			# Check if the request is a HTML request
+			#
+			# @parameter [Hash] env
+			#
+			# @returns [Boolean]
+			#
+			def self.html_request?(env) = env['HTTP_ACCEPT']&.include?('text/html')
+
+			private_class_method :execute_hooks, :execute_global_hooks, :execute_route_hooks, :parse_path, :html_request?
+		end
+	end
+end

data/lib/lennarb/response.rb

@@ -125,6 +125,8 @@ class Lennarb
 		def redirect(path, status = 302)
 			@headers[LOCATION] = path
 			@status = status
+
+			throw :halt, finish
 		end
 
 		# Finish the response

data/lib/lennarb/version.rb

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

data/lib/lennarb.rb

@@ -12,6 +12,7 @@ require 'rack'
 
 # Base class for Lennarb
 #
+require_relative 'lennarb/application/base'
 require_relative 'lennarb/request'
 require_relative 'lennarb/response'
 require_relative 'lennarb/route_node'
@@ -25,9 +26,8 @@ class Lennarb
 	# @attribute [r] root
 	# @returns [RouteNode]
 	#
-	attr_reader :root
+	attr_reader :_root
 
-	@routes = []
 	# Initialize the application
 	#
 	# @yield { ... } The application
@@ -35,7 +35,7 @@ class Lennarb
 	# @returns [Lennarb]
 	#
 	def initialize
-		@root = RouteNode.new
+		@_root = RouteNode.new
 		yield self if block_given?
 	end
 
@@ -55,19 +55,27 @@ class Lennarb
 	# @returns [Array] response
 	#
 	def call(env)
-		http_method = env.fetch('REQUEST_METHOD').to_sym
-		parts       = SplitPath[env.fetch('PATH_INFO')]
+		http_method = env[Rack::REQUEST_METHOD].to_sym
+		parts       = SplitPath[env[Rack::PATH_INFO]]
 
-		block, params = @root.match_route(parts, http_method)
+		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 = Response.new
+		req  = Request.new(env, params)
 
-		res.finish
+		catch(:halt) do
+			instance_exec(req, @res, &block)
+			@res.finish
+		end
 	end
 
+	# Freeze the routes
+	#
+	# @returns [void]
+	#
+	def freeze! = @_root.freeze
+
 	# Add a routes
 	#
 	# @parameter [String] path
@@ -75,12 +83,12 @@ class Lennarb
 	#
 	# @returns [void]
 	#
-	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 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)
 
 	private
@@ -95,61 +103,6 @@ class Lennarb
 	#
 	def add_route(path, http_method, block)
 		parts = SplitPath[path]
-		@root.add_route(parts, http_method, block)
-	end
-
-	# Base class for Lennarb applications
-	#
-	class ApplicationBase < Lennarb
-		@routes = []
-
-		class << self
-			attr_reader :routes
-
-			# Add a route
-			#
-			# @parameter [String] path
-			# @parameter [Proc] block
-			#
-			# @returns [void]
-			#
-			%i[get post put patch delete].each do |http_method|
-				define_method(http_method) do |path, &block|
-					routes << { method: http_method, path:, proc: block }
-				end
-			end
-		end
-
-		# Inherited hook
-		#
-		# @parameter [Class] subclass
-		#
-		# @returns [void]
-		#
-		def self.inherited(subclass)
-			super
-			subclass.instance_variable_set(:@routes, routes.dup)
-		end
-
-		# Initialize the application
-		#
-		# @returns [ApplicationBase]
-		#
-		def initialize
-			super
-			setup_routes
-		end
-
-		private
-
-		# Setup the routes
-		#
-		# @returns [void]
-		#
-		def setup_routes
-			self.class.routes.each do |route_info|
-				__send__(route_info[:method], route_info[:path], &route_info[:proc])
-			end
-		end
+		@_root.add_route(parts, http_method, block)
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lennarb
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Aristóteles Coutinho
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -44,6 +44,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.8
+- !ruby/object:Gem::Dependency
+  name: rack-protection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rack-session
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bake
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +208,7 @@ files:
 - changelog.md
 - exe/lenna
 - lib/lennarb.rb
+- lib/lennarb/application/base.rb
 - lib/lennarb/request.rb
 - lib/lennarb/response.rb
 - lib/lennarb/route_node.rb
@@ -210,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A lightweight and experimental web framework for Ruby.