lennarb 0.4.4 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00b277c3ca70e4b15e74cb88d343915623d6ae869d4c98b15f46cf6cd286821d
-  data.tar.gz: c539aa17c39cd2d861e2bfc16b8ae1b76c1d4e37304f95e918ded2235e8c7a82
+  metadata.gz: ff30294350acea0efb5cf2c074d256472f99300d46fee6fe0ea9cadfb375e151
+  data.tar.gz: d96ea3d9ade277730f83fa0b011d3396d73be3ba8692229c5ad98cfd72f48ea4
 SHA512:
-  metadata.gz: ab79db446aab1914aa18146f5b0f8814c68296f04fc7b300af3ac9e0079b11f002b284402335a03acba3a2d63d039c54ce20396e84b1c60b3cc9dfadbeb5f860
-  data.tar.gz: d16922a8773b300d364c2db69b3925555dfa3d29f91a4018c2d887360dd0cdb36c5b9c3a0821a4b6044bb14586d739ae4ce98168e6bdcb9e9a6d82a494337fe0
+  metadata.gz: a5aad4351361de62499992df5f53ac8ec5f8b42f3cd1b207d108ac137404ab6e4e103f394193ae58c847195cc97fe53d475d275e542840360b4d61dfe74474c4
+  data.tar.gz: 55661804a4cb178b3365534c5df7a3c7653ecbe07e598b04ae4edfda64f0ada02edcd03ff08cc6f3004a519f5b1df80da4eccc1f4b2a6162d14166e6786f471e

data/changelog.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [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

data/lib/lennarb/application/base.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Aristóteles Coutinho.
+
+require 'colorize'
+
+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
+
+			# 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', '/500.html'],
+								header_rules: [
+									[200, %w[html], { 'content-type' => 'text/html; charset=utf-8' }],
+									[400, %w[html], { 'content-type' => 'text/html; charset=utf-8' }],
+									[500, %w[html], { 'content-type' => 'text/html; charset=utf-8' }]
+								]
+
+				middlewares.each do |(middleware, args, block)|
+					stack.use(middleware, *args, &block)
+				end
+
+				stack.run ->(env) do
+					catch(:halt) do
+						begin
+							execute_hooks(@_before_hooks, env, :before)
+							res = @_route.call(env)
+							execute_hooks(@_after_hooks, env, :after)
+							res
+						rescue StandardError => e
+							render_error if production?
+
+							puts e.message.red
+							puts e.backtrace
+							raise e
+						end.then do |response|
+							case response
+							in [400..499, _, _] then render_not_found
+							else response
+							end
+						end
+					end
+				end
+
+				@_route.freeze!
+
+				stack.to_app
+			end
+
+			def self.test? = ENV['RACK_ENV'] == 'test' || ENV['LENNARB_ENV'] == 'test'
+			def self.production? = ENV['RACK_ENV'] == 'production' || ENV['LENNARB_ENV'] == 'production'
+			def self.development? = ENV['RACK_ENV'] == 'development' || ENV['LENNARB_ENV'] == 'development'
+
+			# Render a not found
+			#
+			# @returns [void]
+			#
+			def self.render_not_found(content = nil)
+				default = File.exist?('public/404.html')
+				body = content || default || 'Not Found'
+				throw :halt, [404, { 'content-type' => 'text/html' }, [body]]
+			end
+
+			# Render an error
+			#
+			# @returns [void]
+			#
+			def self.render_error(content = nil)
+				default = File.exist?('public/500.html')
+				body = content || default || 'Internal Server Error'
+				throw :halt, [500, { 'content-type' => 'text/html' }, [body]]
+			end
+
+			# Redirect to a path
+			#
+			# @parameter [String] path
+			# @parameter [Integer] status default is 302
+			#
+			def self.redirect(path, status = 302) = throw :halt, [status, { 'location' => path }, []]
+
+			# 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.4'
+	VERSION = '0.5.1'
 
 	public_constant :VERSION
 end

data/lib/lennarb.rb

@@ -12,10 +12,10 @@ require 'rack'
 
 # Base class for Lennarb
 #
+require_relative 'lennarb/application/base'
 require_relative 'lennarb/request'
 require_relative 'lennarb/response'
 require_relative 'lennarb/route_node'
-require_relative 'lennarb/router'
 require_relative 'lennarb/version'
 
 class Lennarb
@@ -26,7 +26,7 @@ class Lennarb
 	# @attribute [r] root
 	# @returns [RouteNode]
 	#
-	attr_reader :root
+	attr_reader :_root
 
 	# Initialize the application
 	#
@@ -35,7 +35,7 @@ class Lennarb
 	# @returns [Lennarb]
 	#
 	def initialize
-		@root = RouteNode.new
+		@_root = RouteNode.new
 		yield self if block_given?
 	end
 
@@ -58,7 +58,7 @@ class Lennarb
 		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
@@ -66,36 +66,15 @@ class Lennarb
 
 		catch(:halt) do
 			instance_exec(req, @res, &block)
-			finish!
+			@res.finish
 		end
 	end
 
-	# Finish the request
-	#
-	# @returns [Array] Response
-	#
-	def finish! = halt(@res.finish)
-
-	# Immediately stops the request and returns `response`
-	# as per Rack's specification.
-	#
-	#     halt([200, { "Content-Type" => "text/html" }, ["hello"]])
-	#     halt([res.status, res.headers, res.body])
-	#     halt(res.finish)
-	#
-	# @parameter [Array] response
-	#
-	# @returns [Array] response
-	#
-	def halt(response)
-		throw(:halt, response)
-	end
-
 	# Freeze the routes
 	#
 	# @returns [void]
 	#
-	def freeze! = @root.freeze
+	def freeze! = @_root.freeze
 
 	# Add a routes
 	#
@@ -124,6 +103,6 @@ class Lennarb
 	#
 	def add_route(path, http_method, block)
 		parts = SplitPath[path]
-		@root.add_route(parts, http_method, block)
+		@_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.4
+  version: 0.5.1
 platform: ruby
 authors:
 - Aristóteles Coutinho
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-03 00:00:00.000000000 Z
+date: 2024-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -180,10 +180,10 @@ 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
-- lib/lennarb/router.rb
 - lib/lennarb/version.rb
 - license.md
 - readme.md
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A lightweight and experimental web framework for Ruby.

data/lib/lennarb/router.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023-2024, by Aristóteles Coutinho.
-
-class Lennarb
-	# This module must be included in the class that will use the router.
-	#
-	module Router
-		def self.included(base)
-			base.extend(ClassMethods)
-			base.instance_variable_set(:@router, Lennarb.new)
-			base.define_singleton_method(:router) do
-				base.instance_variable_get(:@router)
-			end
-		end
-
-		module ClassMethods
-			# Helper method to define a route
-			#
-			# returns [Lennarb] instance of the router
-			#
-			def route = router
-
-			# Use this in congi.ru to start the application
-			#
-			def app
-				router.freeze!
-				router
-			end
-		end
-	end
-end