lennarb 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59a236423ff7acaaeec6bf3b3b2a7dd42bfbc704eac97f7e2c7aa0539ebc0f45
-  data.tar.gz: 19b0a12ce5aa48f252c1ff342987b3c4e42073fe80a584dd983c3739321b316c
+  metadata.gz: 133bc5b7fbe787ae7bf9d17f79cddb09d75f3e1d12e99deff891edae698b109a
+  data.tar.gz: de9d4b466c30c19b1fd84e6d55c162f144904aa09d22d4bc874bb7291eb72ce8
 SHA512:
-  metadata.gz: 4df198f477ac2fcb3c09efb95ad9ea2699d6a12051cc9bcacd56c65adfe6d7778eed6cc1e920d6df35141d4dbbbb5aab4dfcc4aaea00483666e836b114b9e5e3
-  data.tar.gz: 03a57883380017a70be1974bd98cdd6df3bd851c1944f787db4d97aec1ddc0f8947f3fc8a3179d817585d5a8ce877454f52a539ab8b77403bafe4cdd0321d7c1
+  metadata.gz: 1aa540d8f1f3d7d82104f441f4d141249485597d34d80072bb2c5df38237ea2651dba35b4f2499f00be7c9d1a94755c2400aefbe102283ff5a0ea3341dc74e97
+  data.tar.gz: 5660b98b90c019ff4501076845668ddea45210e701d91eae9b99c38a36ee7605511903178e986239934078d22aa8d7156d6efe4c73560e5c4951d7c734fa6f77

data/changelog.md

@@ -0,0 +1,165 @@
+# Changelog
+
+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.1.6] - 2023-21-12
+
+### Changed
+
+- Update `README.md` with the new features. Move examples to `guides` folder.
+- Replace `rubocop` to `standard` gem to lint the code.
+- Move `puma` gem to development dependencies.
+- Use tabs instead of spaces to indent the code.
+- Add default middlewares to `Lennarb::Router` class. Now, the `Lennarb::Router` class has the following middlewares by default:
+
+  - `Lennarb::Middleware::Default::Logging`
+  - `Lennarb::Middleware::Default::ErrorHandling`
+
+- Replace `assign_status` to `=` on Response
+
+```rb
+response.status = 200
+```
+
+- Rename `Lenna::Base` to `Lenna::Application` and accept a block to build the routes. Ex.
+
+```rb
+Lenna::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
+end
+```
+
+- The Middleware app now implements [Singleton](https://ruby-doc.org/stdlib-2.5.1/libdoc/singleton/rdoc/Singleton.html) pattern to manager state.
+
+### Added
+
+- Add `standard` gem to lint the code.
+- Add `maintenance` gropu to `Gemfile` with:
+  - Add `bake-gem` gem to run the tasks.
+  - Add `bake-modernize` gem to update the code to the latest Ruby version.
+  - Add `utopia-project` gem to generate the project.
+  - Add `bake-github-pages` to generate the GitHub Pages.
+- Add `bake` gem to run the tasks.
+- Add `puma` gem to run the development server.
+- Add alias to `assign_header` to `[]=` on Response. Now, you can use:
+
+```rb
+response['Content-Type'] = 'application/json'
+```
+
+- Add alias to `assign_body` to `:body=` on Response. Now, you can use:
+
+```rb
+response.body = 'Hello World'
+```
+
+- Add alias to `assign_params` to `:params=` on Request. Now, you can use:
+
+```rb
+request.params = { name: 'John' }
+```
+
+### Removed
+
+- Remove `listen` method to run development server. Now, you must be use `.config.ru` file to run the development server. Ex.
+
+```rb
+# .config.ru
+
+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
+end
+
+run app
+```
+
+- Remove Rakefile. Now, you must be use `bake` gem to run the tasks. Ex.
+
+```sh
+bundle exec bake test
+```
+
+## Bug Fixes
+
+- Fix default middlewares to `Lennarb::Router` class. Now, the `Lennarb::Router` class has the following middlewares by default:
+  - `Lennarb::Middleware::Default::Logging`
+  - `Lennarb::Middleware::Default::ErrorHandling`
+
+## [0.1.5] - 2023-25-11
+
+### Added
+
+- Add `assign_params` method to Request class
+
+## [0.1.4] - 2023-25-11
+
+### Fixed
+
+- Internal docmentation methods
+- Fix `post_params` from Resquest router class
+
+### Added
+
+- Add basic documentation for usage. See [README.md](README.md) for more details.
+
+## [0.1.3] - 2023-24-11
+
+## [0.1.2] - 2023-23-11
+
+### Added
+
+- Implemented a specific error handler for Content-Type related errors, enhancing the system's ability to respond appropriately based on whether the request Content-Type is JSON or HTML.
+
+### Removed
+
+- Removed the debug gem from development dependencies, streamlining the development environment setup.
+
+### Fixed
+
+- Fixed a bug that prevented the correct reading of the Content-Type header in requests, ensuring proper handling of content types.
+
+## [0.1.1] - 2023-23-11
+
+### Added
+
+- Introduced `Array.wrap` extension to the `Array` class for more reliable conversion of objects to arrays within the Lennarb router environment. This method ensures consistent array wrapping of single objects and `nil` values.
+
+### Changed
+
+- Refactored the `put_header` method to use the `Array.wrap` method for more predictable header value handling.
+- Renamed methods to have a consistent `assign_` prefix to standardize the API interface:
+  - `put_header` to `assign_header`
+  - `write_body` to `assign_body`
+  - `set_params` to `assign_params`
+  - `update_status` to `assign_status`
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security

data/lib/lenna/application.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
+# Internal dependencies
+#
+require 'lenna/middleware/default/error_handler'
+require 'lenna/middleware/default/logging'
+require 'lenna/router'
+
+# The Lenna module is used to namespace the framework.
+#
+# @public
+#
+module Lenna
+	# The base class is used to start the server.
+	#
+	# @public
+	#
+	class Application < Router
+		# Initialize the base class
+		#
+		# @yield { ... } the block to be evaluated in the context of the instance.
+		#
+		# @return [void | Application] Returns the instance if a block is given.
+		#
+		def initialize
+			super
+			yield self if block_given?
+		end
+	end
+
+	# The base module is used to include the base class.
+	#
+	# @public
+	#
+	module Base
+		def self.included(base)
+			base.extend(ClassMethods)
+		end
+
+		module ClassMethods
+			# Initialize the base module
+			#
+			# @return [Lenna::Application] Returns the instance.
+			#
+			# @public
+			#
+			def app = @app ||= Lenna::Application.new
+		end
+	end
+end

data/lib/lenna/middleware/app.rb

@@ -1,103 +1,118 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
+require 'singleton'
+
 module Lenna
-  module Middleware
-    # The MiddlewareManager class is responsible for managing the middlewares.
-    #
-    # @attr mutex                   [Mutex] the mutex used to synchronize the
-    #                                       access to the global middlewares and
-    #                                       the middleware chains cache.
-    # @attr global_middlewares      [Array] the global middlewares
-    # @attr middleware_chains_cache [Hash]  the middleware chains cache
-    #
-    # @note Middleware chains are cached by action.
-    #       The middlewares that are added to a specific route are added to the
-    #       global middlewares.
-    #
-    # @api private
-    #
-    # @since 0.1.0
-    class App
-      # @return [Mutex] the mutex used to synchronize the access to the global
-      attr_reader :global_middlewares
+	module Middleware
+		# The MiddlewareManager class is responsible for managing the middlewares.
+		#
+		# @attr global_middlewares      [Array] the global middlewares
+		# @attr middleware_chains_cache [Hash]  the middleware chains cache
+		#
+		# Middleware chains are cached by action.
+		# The middlewares that are added to a specific route are added to the
+		#   global middlewares.
+		#
+		# @private Since `v0.1.0`
+		#
+		class App
+			include Singleton
+
+			# @return [Array] the global middlewares.
+			#
+			attr_accessor :global_middlewares
+			# @return [Hash]  the middleware chains cache.
+			#
+			attr_accessor :middleware_chains_cache
 
-      # @return [Hash] the middleware chains cache
-      attr_reader :middleware_chains_cache
+			# This method will initialize the global middlewares and the
+			# middleware chains cache.
+			#
+			# @return [void]
+			#
+			def initialize
+				@global_middlewares = []
+				@middleware_chains_cache = {}
+			end
 
-      # This method will initialize the global middlewares and the
-      # middleware chains cache.
-      #
-      # @return [void]
-      #
-      # @since 0.1.0
-      def initialize
-        @mutex = ::Mutex.new
-        @global_middlewares      = []
-        @middleware_chains_cache = {}
-      end
+			# This method is used to reset the global middlewares and the middleware
+			# chains cache.
+			#
+			# @return [void]
+			#
+			def reset!
+				@global_middlewares = []
+				@middleware_chains_cache = {}
+			end
 
-      # This method is used to add a middleware to the global middlewares.
-      # @param middlewares [Array] the middlewares to be used
-      # @return            [void]
-      #
-      # @since 0.1.0
-      def use(middlewares)
-        @mutex.synchronize do
-          @global_middlewares += Array(middlewares)
-          @middleware_chains_cache = {}
-        end
-      end
+			# This method is used to add a middleware to the global middlewares.
+			# @parameter middlewares [Array] the middlewares to be used
+			# @return                [void]
+			#
+			def use(middlewares)
+				@global_middlewares += Array(middlewares)
+				@middleware_chains_cache = {}
+			end
 
-      # This method is used to fetch or build the middleware chain for the given
-      # action and route middlewares.
-      #
-      # @param action            [Proc]  the action to be executed
-      # @param route_middlewares [Array] the middlewares to be used
-      # @return                  [Proc]  the middleware chain
-      #
-      # @see #build_middleware_chain
-      #
-      # @since 0.1.0
-      def fetch_or_build_middleware_chain(action, route_middlewares)
-        middleware_signature = action.object_id.to_s
+			# This method is used to fetch or build the middleware chain for the given
+			# action and route middlewares.
+			#
+			# @parameter action            [Proc]  the action to be executed
+			# @parameter route_middlewares [Array] the middlewares to be used
+			# @return                      [Proc]  the middleware chain
+			#
+			#
+			def fetch_or_build_middleware_chain(
+				action,
+				route_middlewares,
+				http_method: nil,
+				path: nil
+			)
+				signature =
+					if http_method && path
+						[http_method, path, route_middlewares].hash.to_s
+					else
+						['global', route_middlewares].hash.to_s
+					end
 
-        @mutex.synchronize do
-          @middleware_chains_cache[middleware_signature] ||=
-            build_middleware_chain(action, route_middlewares)
-        end
-      end
+				@middleware_chains_cache[signature] ||=
+					build_middleware_chain(action, route_middlewares)
+			end
 
-      # This method is used to build the middleware chain for the given action
-      # and middlewares.
-      #
-      # @param action      [Proc]  the action to be executed
-      # @param middlewares [Array] the middlewares to be used
-      # @return            [Proc]  the middleware chain
-      #
-      # @since 0.1.0
-      #
-      # @example                   Given the action:
-      #                            `->(req, res) { res << 'Hello' }` and the
-      #                            middlewares [mw1, mw2], the middleware
-      #                            chain will be:
-      #                            mw1 -> mw2 -> action
-      #                            The action will be the last middleware in the
-      #                            chain.
-      def build_middleware_chain(action, middlewares)
-        all_middlewares = @global_middlewares + Array(middlewares)
+			# This method is used to build the middleware chain for the given action
+			# and middlewares.
+			#
+			# @parameter action      [Proc]  the action to be executed
+			# @parameter middlewares [Array] the middlewares to be used
+			# @return                [Proc]  the middleware chain
+			#
+			# ex.
+			#     Given the action:
+			#     `->(req, res) { res << 'Hello' }` and the
+			#     middlewares [mw1, mw2], the middleware
+			#     chain will be:
+			#     mw1 -> mw2 -> action
+			#     The action will be the last middleware in the
+			#     chain.
+			#
+			def build_middleware_chain(action, middlewares)
+				all_middlewares = (@global_middlewares + Array(middlewares))
 
-        all_middlewares.reverse.reduce(action) do |next_middleware, middleware|
-          ->(req, res) {
-            middleware.call(
-              req,
-              res,
-              -> {
-                next_middleware.call(req, res)
-              }
-            )
-          }
-        end
-      end
-    end
-  end
+				all_middlewares.reverse.reduce(action) do |next_middleware, middleware|
+					->(req, res) {
+						middleware.call(
+							req,
+							res,
+							-> {
+								next_middleware.call(req, res)
+							}
+						)
+					}
+				end
+			end
+		end
+	end
 end