lennarb 0.1.5 → 0.1.6

data/lib/lenna/router/builder.rb

@@ -1,99 +1,124 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module Lenna
-  class Router
-    # The Route::Builder class is responsible for building the tree of routes.
-    #
-    # The tree of routes is built by adding routes to the tree. Each route is
-    # represented by a node in the tree and each node has a path and an
-    # endpoint. The path is the path of the route and the endpoint is then
-    # action to be executed when the route is matched.
-    #
-    # Those nodes are stored in a cache to avoid rebuilding the tree of routes
-    # for each request.
-    #
-    # The tree use `Trie` data structures to optimize the search for a route.
-    # The trie is a tree where each node is a character of the path.
-    # This way, the search for a route is O(n) where n is the length of the
-    # path.
-    #
-    class Builder
-      def initialize(root_node) = @root_node = root_node
+	class Router
+		# The Route::Builder class is responsible for building the tree of routes.
+		#
+		# The tree of routes is built by adding routes to the tree. Each route is
+		# represented by a node in the tree and each node has a path and an
+		# endpoint. The path is the path of the route and the endpoint is then
+		# action to be executed when the route is matched.
+		#
+		# Those nodes are stored in a cache to avoid rebuilding the tree of routes
+		# for each request.
+		#
+		# The tree use `Trie` data structures to optimize the search for a route.
+		# The trie is a tree where each node is a character of the path.
+		# This way, the search for a route is O(n) where n is the length of the
+		# path.
+		#
+		# @private
+		#
+		class Builder
+			def initialize(root_node) = @root_node = root_node
 
-      # @param method [String] the HTTP method
-      # @param path   [String] the path to be matched
-      # @param action [Proc]   the action to be executed
-      # @param cache  [Cache]  the cache to be used
-      # @return       [void]
-      def call(method, path, action, cache)
-        path_key = cache.cache_key(method, path)
+			# This method will add a route to the tree of routes.
+			#
+			# @parameter method  [String] the HTTP method
+			# @parameter path    [String] the path to be matched
+			# @parameter action  [Proc]   the action to be executed
+			# @parameter cache   [Cache]  the cache to be used
+			#
+			# @return            [void]
+			#
+			def call(method, path, action, cache)
+				path_key = cache.cache_key(method, path)
 
-        return if cache.exist?(path_key)
+				return if cache.exist?(path_key)
 
-        current_node = find_or_create_route_node(path)
-        setup_endpoint(current_node, method, action)
+				current_node = find_or_create_route_node(path)
+				setup_endpoint(current_node, method, action)
 
-        cache.add(path_key, current_node)
-      end
+				cache.add(path_key, current_node)
+			end
 
-      private
+			private
 
-      # This method will create routes that are missing.
-      # @param path [String] the path to be matched
-      # @return     [Node]   the node that matches the path
-      def find_or_create_route_node(path)
-        current_node = @root_node
-        split_path(path).each do |part|
-          current_node = find_or_create_node(current_node, part)
-        end
-        current_node
-      end
+			# This method will create routes that are missing.
+			# @parameter path [String] the path to be matched
+			#
+			# @return         [Node]   the node that matches the path
+			#
+			def find_or_create_route_node(path)
+				current_node = @root_node
+				split_path(path).each do |part|
+					current_node = find_or_create_node(current_node, part)
+				end
+				current_node
+			end
 
-      # @param current_node [Node]  the current node
-      # @param part         [String] the part of the path
-      # @return             [Node]  the node that matches the part of the path
-      # @note               This method will create the nodes that are missing.
-      #                     This way, the tree of routes is built.
-      # @example            Given the part ':id' and the tree bellow:
-      #                     root
-      #                     └── users
-      #                         └── :id
-      #                     The method will return the node :id.
-      #                     If the node :id does not exist, it will be created.
-      #                     The tree will be:
-      #                     root
-      #                     └── users
-      #                         └── :id
-      def find_or_create_node(current_node, part)
-        if part.start_with?(':')
-          # If it is a placeholder, then we just create or update
-          # the placeholder node with the placeholder name.
-          placeholder_name = part[1..].to_sym
-          current_node.children[:placeholder] ||= Node.new(
-            {},
-            nil,
-            placeholder_name
-          )
-        else
-          current_node.children[part] ||= Node.new
-        end
-        current_node.children[part.start_with?(':') ? :placeholder : part]
-      end
+			# This method will create the nodes that are missing.
+			#
+			# @parameter current_node [Node]  the current node
+			# @parameter part         [String] the part of the path
+			#
+			# @return                 [Node]  the node that matches the part of the path
+			#
+			#                     This way, the tree of routes is built.
+			# @example            Given the part ':id' and the tree bellow:
+			#                     root
+			#                     └── users
+			#                         └── :id
+			#                     The method will return the node :id.
+			#                     If the node :id does not exist, it will be created.
+			#                     The tree will be:
+			#                     root
+			#                     └── users
+			#                         └── :id
+			#
+			def find_or_create_node(current_node, part)
+				if part.start_with?(':')
+					# If it is a placeholder, then we just create or update
+					# the placeholder node with the placeholder name.
+					placeholder_name = part[1..].to_sym
+					current_node.children[:placeholder] ||= Node.new(
+						{},
+						nil,
+						placeholder_name
+					)
+				else
+					current_node.children[part] ||= Node.new
+				end
+				current_node.children[part.start_with?(':') ? :placeholder : part]
+			end
 
-      # @param current_node [Node]  the current node
-      # @param method       [String] the HTTP method
-      # @param action       [Proc]   the action to be executed
-      def setup_endpoint(current_node, method, action)
-        current_node.endpoint ||= {}
-        current_node.endpoint[method] = action
-      end
+			# This method will setup the endpoint of the current node.
+			#
+			# @parameter current_node [Node]  the current node
+			# @parameter method       [String] the HTTP method
+			# @parameter action       [Proc]   the action to be executed
+			#
+			# @return                 [void]
+			#
+			def setup_endpoint(current_node, method, action)
+				current_node.endpoint ||= {}
+				current_node.endpoint[method] = action
+			end
 
-      # @param path [String] the path to be split
-      # @return     [Array]  the splitted path
-      # @todo: Move this to a separate file and require it here.
-      # Maybe utils or something like that.
-      # Use Rack::Utils.split_path_info instead.
-      def split_path(path) = path.split('/').reject(&:empty?)
-    end
-  end
+			# This method will split the path into parts.
+			#
+			# @parameter path [String] the path to be split
+			#
+			# @return         [Array]  the splitted path
+			#
+			# TODO: Move this to a separate file and require it here.
+			# Maybe utils or something like that.
+			# Use Rack::Utils.split_path_info instead.
+			#
+			def split_path(path) = path.split('/').reject(&:empty?)
+		end
+	end
 end

data/lib/lenna/router/cache.rb

@@ -1,38 +1,52 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module Lenna
-  class Router
-    # @api public
-    # @note This class is used to cache the routes.
-    class Cache
-      def initialize = @cache = {}
+	class Router
+		# This class is used to cache the routes.
+		#
+		# @private
+		#
+		class Cache
+			def initialize = @cache = {}
 
-      # @api public
-      # @param [String] method
-      # @param [String] path
-      # @return [String]
-      # @note This method is used to generate a key for the cache.
-      def cache_key(method, path) = "#{method} #{path}"
+			# This method is used to generate a key for the cache.
+			#
+			# @parameter [String] method
+			# @parameter [String] path
+			#
+			# @return [String]
+			#
+			def cache_key(method, path) = "#{method} #{path}"
 
-      # @api public
-      # @param route_key [String] The key for the route.
-      # @param node      [Lenna::Route::Node] The node for the route.
-      # @return          [Lenna::Route::Node]
-      # @note            This method is used to add a route to the cache.
-      def add(route_key, node) = @cache[route_key] = node
+			# This method is used to add a route to the cache.
+			#
+			# @parameter route_key [String] The key for the route.
+			# @parameter node      [Lenna::Route::Node] The node for the route.
+			#
+			# @return              [Lenna::Route::Node]
+			#
+			def add(route_key, node) = @cache[route_key] = node
 
-      # @api public
-      # @param route_key [String] The key for the route.
-      # @return          [Lenna::Route::Node]
-      # @note            This method is used to get a route from the cache.
-      def get(route_key) = @cache[route_key]
+			# This method is used to get a route from the cache.
+			#
+			# @parameter route_key [String] The key for the route.
+			#
+			# @return              [Lenna::Route::Node]
+			#
+			def get(route_key) = @cache[route_key]
 
-      # @api public
-      # @param route_key [String] The key for the route.
-      # @return          [Boolean]
-      # @note            This method is used to check if a route exists
-      #                  in the cache.
-      def exist?(route_key) = @cache.key?(route_key)
-    end
-  end
+			# This method is used to check if a route is in the cache.
+			#
+			# @api public
+			#
+			# @parameter route_key [String] The key for the route.
+			#
+			# @return              [Boolean]
+			#
+			def exist?(route_key) = @cache.key?(route_key)
+		end
+	end
 end

data/lib/lenna/router/namespace_stack.rb

@@ -1,73 +1,77 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
 module Lenna
-  class Router
-    # This class is used to manage the namespaces.
-    #
-    # @api private
-    class NamespaceStack
-      # @return [Array] The stack of namespaces
-      #
-      # @api private
-      attr_reader :stack
+	class Router
+		# This class is used to manage the namespaces.
+		#
+		# @private `Since v0.1.0`
+		#
+		class NamespaceStack
+			# @return [Array] The stack of namespaces
+			#
+			# @private
+			#
+			attr_reader :stack
 
-      # @return [void]
-      #
-      # @api private
-      def initialize = @stack = ['']
+			# The initialize method is used to initialize the stack of namespaces.
+			#
+			# @private
+			#
+			# @attibute stack [Array] The stack of namespaces
+			#
+			# @return [void]
+			#
+			def initialize = @stack = ['']
 
-      # This method is used to push a prefix to the stack.
-      #
-      # @param prefix [String] The prefix to be pushed
-      # @return       [void]
-      #
-      # @example:
-      #
-      #  stack = NamespaceStack.new
-      #  stack.push('/users')
-      #  stack.current_prefix # => '/users'
-      #
-      # @see #resolve_prefix
-      #
-      # @api private
-      def push(prefix)
-        @stack.push(resolve_prefix(prefix))
-      end
+			# This method is used to push a prefix to the stack.
+			#
+			# @parameter prefix [String] The prefix to be pushed
+			#
+			# @return           [void]
+			#
+			# ex.
+			#
+			#  stack = NamespaceStack.new
+			#  stack.push('/users')
+			#  stack.current_prefix # => '/users'
+			#
+			# @see #resolve_prefix
+			#
+			def push(prefix)
+				@stack.push(resolve_prefix(prefix))
+			end
 
-      # @return [String] The popped prefix
-      #
-      # @api private
-      def pop
-        @stack.pop unless @stack.size == 1
-      end
+			# This method is used to remove the last prefix from the stack.
+			#
+			# @return [String] The popped prefix
+			#
+			def pop
+				@stack.pop unless @stack.size == 1
+			end
 
-      # @return [String] The current prefix
-      #
-      # @api private
-      #
-      # @since 0.1.0
-      def current_prefix = @stack.last
+			# @return [String] The current prefix
+			#
+			def current_prefix = @stack.last
 
-      # The to_s method is used to return the current prefix.
-      #
-      # @return [String] The current prefix
-      #
-      # @api private
-      def to_s = current_prefix
+			# The to_s method is used to return the current prefix.
+			#
+			# @return [String] The current prefix
+			#
+			def to_s = current_prefix
 
-      private
+			private
 
-      # The resolve_prefix method is used to resolve the prefix.
-      #
-      # @param prefix [String] The prefix to be resolved
-      # @return       [String] The resolved prefix
-      #
-      # @see #current_prefix
-      #
-      # @since 0.1.0
-      def resolve_prefix(prefix)
-        current_prefix + prefix
-      end
-    end
-  end
+			# The resolve_prefix method is used to resolve the prefix.
+			#
+			# @parameter prefix [String] The prefix to be resolved
+			# @return           [String] The resolved prefix
+			#
+			def resolve_prefix(prefix)
+				current_prefix + prefix
+			end
+		end
+	end
 end