lennarb 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 888f84e566de65f5c87013ff56ac3fe485f59acba6f1cc39862178894cf101fa
-  data.tar.gz: 8703693e316b83f747f927c23b07d56f6dd571f813d8c00901432cf6c941d1f2
+  metadata.gz: d9cfd70e5b40a64d96f5cd52b748c32a36b796c43e6d490b4df64bc5fae3c781
+  data.tar.gz: ffc4abf90906f7378879a0d342e74922c01c6ae9d6d59855128d4fd3ec11d40c
 SHA512:
-  metadata.gz: bc83791eb32ad87b5aa772f375b048829d794d35bdea5c5d1d083dc4a2e8b27560b313c79f51ca7a3a7084d73cc4ddeb9fb17a29a33a211bd53db57090af791a
-  data.tar.gz: a1fb09a73e8610d562cb4f4ea5e2ce1a07ffa68f4574363f07700b0e1004823fb5f1003d6cf6276fec2eb0002894ddf4dce7c7e4c4b55773bbb729a96ec74f4c
+  metadata.gz: 6d1e7a05a3e931a3163b4103d9900c36163e72e738e0435bc4396fb5f3aeb3c6d044edbdfd8a7fde7512265df91d86dc01a719b7b58ffdf7dc10698a69c1016c
+  data.tar.gz: 75c64ac16b3fd3599e78c6a9dd04c951137d11b64b11685af4f9d7d0626331aa554564d8786914d129b93e128ebaa54015f0098b75626e5c74bd347e7ece2861

data/changelog.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.1] - 2024-05-17
+
+### Added
+
+- Add `Lennarb::Plugin` module to manage the plugins in the project. Now, the `Lennarb` class is the main class of the project.
+- Add `Lennarb::Plugin::Base` class to be the base class of the plugins in the project.
+- Add simple guide to use `Lenn` plugins. See [guides/plugins/readme.md](guides/plugins/readme.md) for more details.
+
 ## [0.4.4] - 2024-04-02
 
 ### Added

data/lib/lennarb/application/base.rb

@@ -3,6 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Aristóteles Coutinho.
 
+require 'colorize'
+
 class Lennarb
 	module Application
 		class Base
@@ -30,207 +32,214 @@ class Lennarb
 			#
 			# @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
+			class << self
+				def 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
-			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
+				def get(path, &) = @_route.get(path, &)
+				def put(...)     = @_route.put(...)
+				def post(...)    = @_route.post(...)
+				def head(...)    = @_route.head(...)
+				def match(...)   = @_route.match(...)
+				def patch(...)   = @_route.patch(...)
+				def delete(...)  = @_route.delete(...)
+				def options(...) = @_route.options(...)
+
+				# @returns [Array] middlewares
+				def middlewares = @_middlewares
+
+				# Use a middleware
+				#
+				# @parameter [Object] middleware
+				# @parameter [Array] args
+				# @parameter [Block] block
+				#
+				# @returns [Array] middlewares
+				#
+				def use(middleware, *args, &block)
+					@_middlewares << [middleware, args, 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
+				# Add a before hook
+				#
+				# @parameter [String] path
+				# @parameter [Block] block
+				#
+				def before(path = nil, &block)
+					if path
+						parts = path.split('/').reject(&:empty?)
+						@_before_hooks.add_route(parts, :before, block)
+					else
+						@_global_before_hooks << block
 					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)
+				# Add a after hook
+				#
+				# @parameter [String] path
+				# @parameter [Block] block
+				#
+				def 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
 
-				stack.run @_route
+				# 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::MethodOverride
+				#  - Rack::Head
+				#  - Rack::ContentLength
+				#
+				def run!
+					stack = Rack::Builder.new
+
+					use Rack::ShowExceptions if test? || development?
+					use Rack::MethodOverride
+					use Rack::Head
+					use Rack::ContentLength
+
+					middlewares.each do |(middleware, args, block)|
+						stack.use(middleware, *args, &block)
+					end
 
-				@_route.freeze!
+					stack.run ->(env) do
+						catch(:halt) do
+							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
+					end
 
-				@_route = stack.to_app.freeze
+					@_route.freeze!
 
-				self
-			end
+					stack.to_app
+				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
+				def test?        = ENV['RACK_ENV'] == 'test'        || ENV['LENNARB_ENV'] == 'test'
+				def production?  = ENV['RACK_ENV'] == 'production'  || ENV['LENNARB_ENV'] == 'production'
+				def development? = ENV['RACK_ENV'] == 'development' || ENV['LENNARB_ENV'] == 'development'
+
+				# Render a not found
+				#
+				# @returns [void]
+				#
+				def 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
 
-			# 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)
+				# Render an error
+				#
+				# @returns [void]
+				#
+				def 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
 
-				execute_route_hooks(hook_route, env, action)
-			end
+				# Redirect to a path
+				#
+				# @parameter [String] path
+				# @parameter [Integer] status default is 302
+				#
+				def redirect(path, status = 302) = throw :halt, [status, { 'location' => path }, []]
+
+				# To use a plugin
+				#
+				# @parameter [String | Symbol] plugin_name
+				#
+				# @returns [void]
+				#
+				def plugin(plugin_name) = @_route.plugin(plugin_name)
+
+				private
+
+				# Execute the hooks
+				#
+				# @parameter [RouteNode] hook_route
+				# @parameter [Hash] env
+				# @parameter [Symbol] action
+				#
+				# @returns [void]
+				#
+				def 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 global hooks
+				#
+				# @parameter [Hash] env
+				# @parameter [Symbol] action
+				#
+				# @returns [void]
+				#
+				def 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
+				# Execute the route hooks
+				#
+				# @parameter [RouteNode] hook_route
+				# @parameter [Hash] env
+				# @parameter [Symbol] action
+				#
+				# @returns [void]
+				#
+				def 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
 
-				block, = hook_route.match_route(parts, action)
-				block&.call(env)
+				# Parse the path
+				#
+				# @parameter [Hash] env
+				#
+				# @returns [Array] parts
+				#
+				def parse_path(env) = env[Rack::PATH_INFO]&.split('/')&.reject(&:empty?)
+
+				# Check if the request is a HTML request
+				#
+				# @parameter [Hash] env
+				#
+				# @returns [Boolean]
+				#
+				def html_request?(env) = env['HTTP_ACCEPT']&.include?('text/html')
 			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/plugin.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Aristóteles Coutinho.
+
+class Lennarb
+	module Plugin
+		@plugins = {}
+
+		def self.register(name, mod)
+			@plugins[name] = mod
+		end
+
+		def self.load(name)
+			@plugins[name] || raise("Plugin #{name} did not register itself correctly")
+		end
+
+		def self.plugins = @plugins
+	end
+end

data/lib/lennarb/version.rb

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

data/lib/lennarb.rb

@@ -3,8 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Aristóteles Coutinho.
 
-ENV['RACK_ENV'] ||= 'development'
-
 # Core extensions
 #
 require 'pathname'
@@ -13,6 +11,7 @@ require 'rack'
 # Base class for Lennarb
 #
 require_relative 'lennarb/application/base'
+require_relative 'lennarb/plugin'
 require_relative 'lennarb/request'
 require_relative 'lennarb/response'
 require_relative 'lennarb/route_node'
@@ -91,6 +90,17 @@ class Lennarb
 	def delete(path, &block)  = add_route(path, :DELETE, block)
 	def options(path, &block) = add_route(path, :OPTIONS, block)
 
+	# Register a plugin
+	#
+	# @parameter [String | Symbol] plugin_name
+	#
+	# @returns [void]
+	#
+	def plugin(plugin_name)
+		plugin_module = Lennarb::Plugin.load(plugin_name)
+		extend plugin_module
+	end
+
 	private
 
 	# Add a route

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lennarb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Aristóteles Coutinho
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -44,34 +44,6 @@ 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
@@ -209,6 +181,7 @@ files:
 - exe/lenna
 - lib/lennarb.rb
 - lib/lennarb/application/base.rb
+- lib/lennarb/plugin.rb
 - lib/lennarb/request.rb
 - lib/lennarb/response.rb
 - lib/lennarb/route_node.rb