lennarb 0.1.5 → 0.1.6

data/lib/lenna/router/route_matcher.rb

@@ -1,69 +1,68 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module Lenna
-  class Router
-    # @note This class is responsible for matching the request path
-    #   to an endpoint and executing the endpoint action.
-    #
-    # @api private
-    #
-    # @since 0.1.0
-    #
-    # This will match the request path to an endpoint and execute
-    # the endpoint action.
-    class RouteMatcher
-      # @param root_node [Lenna::Node] The root node
-      def initialize(root_node) = @root_node = root_node
+	class Router
+		# This class is responsible for matching the request path
+		#   to an endpoint and executing the endpoint action.
+		#
+		# @private Since `v0.1.0`
+		#
+		# This will match the request path to an endpoint and execute
+		# the endpoint action.
+		#
+		class RouteMatcher
+			# @parameter root_node [Lenna::Node] The root node
+			#
+			def initialize(root_node) = @root_node = root_node
 
-      # This method will match the request path to an endpoint and execute
-      # the endpoint action.
-      #
-      # @param req [Lenna::Request]  The request object
-      # @param res [Lenna::Response] The response object
-      # @return    [Lenna::Response] The response object
-      #
-      # @see #split_path
-      # @see #find_endpoint
-      # @see Lenna::Response#not_found
-      def match_and_execute_route(req, res)
-        params     = {}
-        path_parts = split_path(req.path_info)
-        endpoint   = find_endpoint(@root_node, path_parts, params)
+			# This method will match the request path to an endpoint and execute
+			# the endpoint action.
+			#
+			# @parameter req [Lenna::Request]  The request object
+			# @parameter res [Lenna::Response] The response object
+			# @return        [Lenna::Response] The response object
+			#
+			def match_and_execute_route(req, res)
+				params = {}
+				path_parts = split_path(req.path_info)
+				endpoint = find_endpoint(@root_node, path_parts, params)
 
-        if endpoint && (action = endpoint[req.request_method])
-          req.params.merge!(params)
-          action.call(req, res)
-        else
-          res.not_found
-        end
-      end
+				if endpoint && (action = endpoint[req.request_method])
+					req.assign_params(params)
+					action.call(req, res)
+				else
+					res.not_found
+				end
+			end
 
-      private
+			private
 
-      # @todo: Refactor this method to a module.
-      def split_path(path) = path.split('/').reject(&:empty?)
+			def split_path(path) = path.split('/').reject(&:empty?)
 
-      # @param node   [Lenna::Node] The node to search
-      # @param parts  [Array]       The path parts
-      # @param params [Hash]        The params hash
-      # @return       [Lenna::Node] The node that matches the path
-      #
-      # @note This method is recursive.
-      #
-      # @since 0.1.0
-      def find_endpoint(node, parts, params)
-        return node.endpoint if parts.empty?
+			# @parameter node   [Lenna::Node] The node to search
+			# @parameter parts  [Array]       The path parts
+			# @parameter params [Hash]        The params hash
+			#
+			# @return       [Lenna::Node] The node that matches the path
+			#
+			# This method is recursive.
+			#
+			def find_endpoint(node, parts, params)
+				return node.endpoint if parts.empty?
 
-        part = parts.shift
-        child_node = node.children[part]
+				part = parts.shift
+				child_node = node.children[part]
 
-        if child_node.nil? && (placeholder_node = node.children[:placeholder])
-          params[placeholder_node.placeholder_name] = part
-          child_node = placeholder_node
-        end
+				if child_node.nil? && (placeholder_node = node.children[:placeholder])
+					params[placeholder_node.placeholder_name] = part
+					child_node = placeholder_node
+				end
 
-        find_endpoint(child_node, parts, params) if child_node
-      end
-    end
-  end
+				find_endpoint(child_node, parts, params) if child_node
+			end
+		end
+	end
 end

data/lib/lenna/router.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-# Standard library dependencies
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 require 'erb'
 require 'json'
 
@@ -9,6 +11,8 @@ require 'rack'
 
 # Internal dependencies
 require 'lenna/middleware/app'
+require 'lenna/middleware/default/error_handler'
+require 'lenna/middleware/default/logging'
 require 'lenna/router/builder'
 require 'lenna/router/cache'
 require 'lenna/router/namespace_stack'
@@ -17,157 +21,185 @@ require 'lenna/router/response'
 require 'lenna/router/route_matcher'
 
 module Lenna
-  # The Node struct is used to represent a node in the tree of routes.
-  # @attr children          [Hash]   the children of the node
-  # @attr endpoint          [String] the endpoint of the node
-  # @attr placeholder_name  [String] the name of the placeholder
-  # @attr placeholder       [Bool]   whether the node is a placeholder
-  Node =
-    ::Struct.new(:children, :endpoint, :placeholder_name, :placeholder) do
-      def initialize(children = {}, endpoint = nil, placeholder_name = nil)
-        super(children, endpoint, placeholder_name, !placeholder_name.nil?)
-      end
-    end
-  public_constant :Node
-
-  # The router class is responsible for adding routes and calling the
-  # middleware chain for each request.
-  class Router
-    # @return [Node] the root node of the tree of routes
-    attr_reader :root_node
-
-    # @return [Route::Cache] the cache of routes
-    attr_reader :cache
-
-    # @return [Route::NamespaceStack] the stack of namespaces
-    attr_reader :namespace_stack
-
-    # @return [MiddlewareManager] the middleware manager
-    attr_reader :middleware_manager
-
-    # @return [Route::Builder] the route builder
-    attr_reader :roter_builder
-
-    # @return [void]
-    def initialize(middleware_manager: Middleware::App.new, cache: Cache.new)
-      @cache     = cache
-      @root_node = Node.new({}, nil)
-      @middleware_manager = middleware_manager
-      @namespace_stack    = NamespaceStack.new
-      @roter_builder      = Builder.new(@root_node)
-    end
-
-    # This method is used to add a namespace to the routes.
-    #
-    # @param prefix [String] the prefix to be used
-    # @param block  [Proc]   the block to be executed
-    # @return       [void]
-    # @note                  This method is used to add a namespaces
-    #                        to the routes.
-    #
-    # @since 0.1.0
-    #
-    # @see Route::NamespaceStack#push
-    #
-    # @example:
-    #
-    #   namespace '/api' do |route|
-    #     route.get '/users' do
-    #       # ...
-    #     end
-    #   end
-    def namespace(prefix, &block)
-      @namespace_stack.push(prefix)
-      block.call(self)
-      @namespace_stack.pop
-    end
-
-    # This method is used to add a middleware to the middleware manager.
-    #
-    # @see MiddlewareManager#use
-    #
-    # @since 0.1.0
-    #
-    # @param middlewares [Array] the middlewares to be used
-    # @return            [void]
-    def use(*middlewares)
-      @middleware_manager.use(middlewares)
-    end
-
-    # Proxy methods to add routes
-    #
-    # @see #add_route
-    #
-    # @since 0.1.0
-    #
-    # @param path        [String]         the path to be matched
-    # @param middlewares [Array]          the middlewares to be used
-    # @param action      [Proc]           the action to be executed
-    # @return            [Lennarb::Route] the route that was added
-    def get(path,    *, &) = add_route(::Rack::GET,    path, *, &)
-    def put(path,    *, &) = add_route(::Rack::PUT,    path, *, &)
-    def post(path,   *, &) = add_route(::Rack::POST,   path, *, &)
-    def delete(path, *, &) = add_route(::Rack::DELETE, path, *, &)
-
-    # @see #call!
-    def call(env) = dup.call!(env)
-
-    # This method is used to call the middleware chain for each request.
-    #
-    # @param env [Hash] the Rack env
-    # @return    [Array] the Lennarb::Response
-    #
-    # @since 0.1.0
-    def call!(env)
-      # TODO: - Remove this after.
-      # env.fetch('RACK_ENV', 'development')
-      env['RACK_ENV'] ||= 'development'
-
-      middleware_pipeline = @middleware_manager.fetch_or_build_middleware_chain(
-        method(:process_request), []
-      )
-
-      req = Request.new(env)
-      res = Response.new
-
-      middleware_pipeline.call(req, res)
-
-      res.finish
-    end
-
-    private
-
-    # This method is used to add a route to the tree of routes.
-    #
-    # @see MiddlewareManager#build_middleware_chain
-    # @see Route::Cache#add
-    # @see Route::Builder#call
-    # @see Route::NamespaceStack#current_prefix
-    #
-    # @since 0.1.0
-    #
-    # @return            [Lenna::Route] the route that was added
-    def add_route(http_method, path, *middlewares, &action)
-      full_path = @namespace_stack.current_prefix + path
-
-      middleware_chain = @middleware_manager.build_middleware_chain(
-        action,
-        middlewares
-      )
-
-      @roter_builder.call(http_method, full_path, middleware_chain, @cache)
-    end
-
-    # This method is used to process the request.
-    #
-    # @see Route::Matcher#match_and_execute_route
-    #
-    # @param req  [Request]  the request
-    # @param res  [Response] the response
-    # @return     [void]
-    def process_request(req, res)
-      @route_matcher ||= RouteMatcher.new(@root_node)
-      @route_matcher.match_and_execute_route(req, res)
-    end
-  end
+	# The Node struct is used to represent a node in the tree of routes.
+	#
+	# @attr children          [Hash]   the children of the node
+	# @attr endpoint          [String] the endpoint of the node
+	# @attr placeholder_name  [String] the name of the placeholder
+	# @attr placeholder       [Bool]   whether the node is a placeholder
+	#
+	Node =
+		::Struct.new(:children, :endpoint, :placeholder_name, :placeholder) do
+			def initialize(children = {}, endpoint = nil, placeholder_name = nil)
+				super(children, endpoint, placeholder_name, !placeholder_name.nil?)
+			end
+		end
+	public_constant :Node
+
+	# The router class is responsible for adding routes and calling the
+	# middleware chain for each request.
+	#
+	# @private
+	#
+	class Router
+		# @return [Node] the root node of the tree of routes
+		#
+		attr_reader :root_node
+
+		# @return [Route::Cache] the cache of routes
+		#
+		attr_reader :cache
+
+		# @return [Route::NamespaceStack] the stack of namespaces
+		#
+		attr_reader :namespace_stack
+
+		# @return [MiddlewareManager] the middleware manager
+		#
+		attr_reader :middleware_manager
+
+		# @return [Route::Builder] the route builder
+		#
+		attr_reader :roter_builder
+
+		# This method is used to initialize the router.
+		# By default, it uses the App middleware and the Cache.
+		#
+		# @return [void]
+		#
+		def initialize(
+			middleware_manager: Middleware::App.instance,
+			cache: Cache.new
+		)
+			@cache = cache
+			@root_node = Node.new({}, nil)
+			@middleware_manager = middleware_manager
+			@namespace_stack = NamespaceStack.new
+			@roter_builder = Builder.new(@root_node)
+		end
+
+		# This method is used to add a namespace to the routes.
+		#
+		# @parameter prefix [String] the prefix to be used
+		# @parameter block  [Proc]   the block to be executed
+		#
+		# @return           [void]
+		#
+		# @public `Since v0.1.0`
+		#
+		# see {Route::NamespaceStack#push}
+		#
+		# ex.
+		#
+		#   namespace '/api' do |route|
+		#     route.get '/users' do
+		#       # ...
+		#     end
+		#   end
+		#
+		def namespace(prefix, &block)
+			@namespace_stack.push(prefix)
+			block.call(self)
+			@namespace_stack.pop
+		end
+
+		# This method is used to add a middleware to the middleware manager.
+		#
+		# See {MiddlewareManager#use}
+		#
+		# @public `Since v0.1.0`
+		#
+		#
+		# @parameter middlewares [Array] the middlewares to be used
+		#
+		# @return                [void]
+		#
+		def use(*middlewares) = @middleware_manager.use(middlewares)
+
+		# Proxy methods to add routes
+		#
+		# @parameter path  [String] the path to be matched
+		# @parameter *     [Array]  the middlewares to be used
+		# @yield { ... }            the block to be executed
+		#
+		# @return          [void]
+		#
+		# see {#add_route}
+		#
+		# @public `Since v0.1`
+		def get(path, *, &) = add_route(::Rack::GET, path, *, &)
+		def put(path, *, &) = add_route(::Rack::PUT, path, *, &)
+		def post(path, *, &) = add_route(::Rack::POST, path, *, &)
+		def delete(path, *, &) = add_route(::Rack::DELETE, path, *, &)
+
+		def call(env) = dup.call!(env)
+
+		# This method is used to call the middleware chain for each request.
+		# It also sets the RACK_ENV to development if it is not set.
+		#
+		# @parameter env [Hash] the Rack env
+		#
+		# @return        [Array] the Lennarb::Response
+		#
+		def call!(env)
+			middleware_pipeline = @middleware_manager.fetch_or_build_middleware_chain(
+				method(:process_request),
+				[
+					Middleware::Default::Logging,
+					Middleware::Default::ErrorHandler
+				]
+			)
+
+			req = Request.new(env)
+			res = Response.new
+
+			middleware_pipeline.call(req, res)
+
+			res.finish
+		end
+
+		private
+
+		# This method is used to add a route to the tree of routes.
+		#
+		# @parameter http_method [Rack::Method] the http method to be used
+		# @parameter path        [String]       the path to be matched
+		# @parameter middlewares [Array]        the middlewares to be used
+		# @parameter action      [Proc]         the action to be executed
+		#
+		# see {MiddlewareManager#build_middleware_chain}
+		# see {Route::Cache#add}
+		# see {Route::Builder#call}
+		# see {Route::NamespaceStack#current_prefix}
+		#
+		# @return            [void]
+		#
+		def add_route(http_method, path, *middlewares, &action)
+			full_path = @namespace_stack.current_prefix + path
+
+			middleware_chain = @middleware_manager.fetch_or_build_middleware_chain(
+				action,
+				middlewares,
+				http_method:,
+				path:
+			)
+
+			@roter_builder.call(http_method, full_path, middleware_chain, @cache)
+		end
+
+		# This method is used to process the request.
+		#
+		# It uses the Route::Matcher to match the request to a route and
+		# execute the action.
+		#
+		# @parameter req  [Request]  the request
+		# @parameter res  [Response] the response
+		#
+		# @return         [void]
+		#
+		def process_request(req, res)
+			@route_matcher ||= RouteMatcher.new(@root_node)
+			@route_matcher.match_and_execute_route(req, res)
+		end
+	end
 end

data/lib/lennarb/array_extensions.rb

@@ -1,17 +1,31 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module Lennarb
-  module ArrayExtensions
-    def wrap(object)
-      if object.nil?
-        []
-      elsif object.respond_to?(:to_ary)
-        object.to_ary || [object]
-      else
-        [object]
-      end
-    end
-  end
+	# The ArrayExtensions module is used to add the wrap method to the Array
+	# class.
+	#
+	# @public Since `v0.1.0`
+	#
+	module ArrayExtensions
+		# Wraps the object in an array if it is not already an array.
+		#
+		# @param object [Object] the object to wrap
+		#
+		# @return [Array] the wrapped object
+		#
+		def wrap(object)
+			if object.nil?
+				[]
+			elsif object.respond_to?(:to_ary)
+				object.to_ary || [object]
+			else
+				[object]
+			end
+		end
+	end
 end
 
 Array.extend(Lennarb::ArrayExtensions)

data/lib/lennarb/version.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module Lennarb
-  VERSION = '0.1.5'
+	VERSION = '0.1.6'
 
-  public_constant :VERSION
+	public_constant :VERSION
 end

data/lib/lennarb.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
+ENV['RACK_ENV'] ||= 'development'
+
 # Extension for Array class
+#
 require 'lennarb/array_extensions'
 
 # Base class for Lennarb
-require 'lenna/base'
+#
+require 'lenna/application'
 require 'lennarb/version'

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2023, by Aristóteles Coutinho.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,31 @@
+# Lennarb
+
+Lennarb is a experimental lightweight, fast, and modular web framework for Ruby based on Rack.
+
+## Usage
+
+Please see the [project documentation](https://aristotelesbr.github.io/lennarb) for more details.
+
+  - [Getting Started](https://aristotelesbr.github.io/lennarbguides/getting-started/index) - This guide show you how to use the `lennarb`
+
+  - [Middlewares](https://aristotelesbr.github.io/lennarbguides/middlewares/index) - This guide shows how to use middlewares in Lennarb.
+
+  - [Namespace routes](https://aristotelesbr.github.io/lennarbguides/namespace-routes/index) - This guide show you how to use namespace routes.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.