lennarb 0.1.7 → 0.2.0

data/lib/lenna/application.rb

@@ -1,53 +0,0 @@
-# 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/cli/app.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023, by Aristóteles Coutinho.
-
-module Lenna
-	module Cli
-		# Mediator class for CLI
-		#
-		# @private `Since v0.1.0`
-		#
-		module App
-			extend self
-			# Execute the command
-			#
-			# @return [void]
-			#
-			def run!(args)
-				subcommand = args.shift
-
-				strategy = parse_options(subcommand, args)
-
-				strategy.is_a?(Lenna::Cli::Commands::Interface) or fail ::ArgumentError
-
-				strategy.call
-			end
-
-			private
-
-			def parse_options(command, args)
-				case command
-				in 'new'    | 'start' then Lenna::Cli::Commands::CreateProject.new(args)
-				in 'server' | 's'     then Lenna::Cli::Commands::StartServer.new(args)
-				else 'help'
-				end
-			end
-		end
-	end
-end

data/lib/lenna/cli/commands/create_project.rb

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023, by Aristóteles Coutinho.
-
-require 'console'
-require 'erb'
-require 'fileutils'
-
-module Lenna
-	module Cli
-		module Commands
-			# Command for creating a new app
-			#
-			# @private `Since v0.1.0`
-			#
-			class CreateProject
-				include ::Lenna::Cli::Commands::Interface
-
-				# @!attribute [r] app_name
-				#
-				private attr_accessor :app_name
-
-				# Initialize the command
-				#
-				# @parameter app_name [Array<String>] The name of the app
-				#
-				def initialize(app_name)
-					self.app_name = app_name[0]
-				end
-
-				# Execute the command
-				#
-				# @parameter app_name [String] The name of the app
-				#
-				# @return [void]
-				#
-				def call
-					return puts 'Please specify an app name'.red if app_name.nil?
-
-					create_app(app_name) do
-						create_gemfile
-						create_config_ru
-						create_app_directory
-					end
-				end
-
-				private
-
-				# Create a directory for the app
-				#
-				# @parameter app_name [String] The name of the app
-				#
-				# @yield { ... } The block to be executed after the directory
-				#
-				# @return [void]
-				#
-				def create_app(app_name)
-					::Console.info("Creating a new app named #{app_name}")
-
-					::FileUtils.mkdir_p(app_name)
-
-					::FileUtils.cd(app_name).tap { yield app_name } if block_given?
-
-					app_name
-				end
-
-				# Create a new Gemfile for the app. This will be use template
-				# file in the `templates` directory.
-				#
-				# @parameter app_name [String] The name of the app
-				#
-				# @return [void]
-				#
-				def create_gemfile
-					{ version: Lennarb::VERSION }.then { create_template('gemfile', _1, 'Gemfile') }
-				end
-
-				# Create a new config.ru for the app. This will be use template
-				# file in the `templates` directory.
-				#
-				# @return [void]
-				#
-				def create_config_ru
-					create_template('config.ru', {})
-				end
-
-				# Create a new application.rb for the app. This will be use template
-				# file in the `templates` directory.
-				#
-				# @return [void]
-				#
-				# @See #create_template
-				# @See lenna/cli/templates/application
-				#
-				def create_app_directory
-					simple_template = <<~HTML.strip
-      '<h2>Hello, welcome to Lenna! #{Lennarb::VERSION}</h1>'
-					HTML
-					create_template('application', { simple_template: }, 'app/application.rb')
-				end
-
-				# Method for creating file based on a template
-				#
-				# @parameter template_name [String] The name of the template
-				# @parameter template_data [Hash] The data to be used in the template
-				#
-				# @return [void]
-				#
-				def create_template(template_name, template_data, file_name = template_name)
-					Lennarb # rubocop:disable Lint
-						.root
-						.join("lib/lenna/cli/templates/#{template_name}.erb")
-						.then { ::File.read(_1) }
-						.then { ::ERB.new(_1).result_with_hash(template_data) }
-						.then do |content|
-							return ::File.write(file_name, content) unless file_name.include?('/')
-
-							::FileUtils.mkdir_p(::File.dirname(file_name)) && ::File.write(file_name, content)
-						end
-				end
-			end
-		end
-	end
-end

data/lib/lenna/cli/commands/interface.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023, by Aristóteles Coutinho.
-
-module Lenna
-	module Cli
-		module Commands
-			module Interface
-				def new(args)
-					raise NotImplementedError
-				end
-
-				def call
-					raise NotImplementedError
-				end
-			end
-		end
-	end
-end

data/lib/lenna/cli/commands/start_server.rb

@@ -1,143 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2023, by Aristóteles Coutinho.
-
-require 'console'
-require 'optparse'
-
-module Lenna
-	module Cli
-		module Commands
-			# Command for creating a new app
-			#
-			# @private `Since v0.1.0`
-			#
-			class StartServer
-				include Lenna::Cli::Commands::Interface
-
-				# @!attribute [rw] port
-				#   @return [Integer] Port to start the server
-				#
-				private attr_accessor :port
-				# @!attribute [rw] server
-				#   @return [String] Server to start
-				#
-				private attr_accessor :server
-				# @!attribute [rw] command
-				#   @return [String] Command to execute
-				#
-				private attr_accessor :command
-
-				def initialize(args)
-					self.command = args.shift
-
-					options = parse_options!(args)
-
-					self.port   = options[:port]
-					self.server = options[:server]
-				end
-
-				# Execute the command
-				#
-				# @return [void]
-				#
-				def call
-					::Console.debug("Starting server on port #{port}...")
-
-					case server
-					in 'puma' | 'falcon' => server then start_server(port:, server:)
-					else fail ::ArgumentError, ::Console.error("The server '#{server}' is not supported yet.")
-					end
-				end
-
-				private
-
-				# Parse the options
-				#
-				# @parameter args [Array<String>] The arguments
-				#
-				# @return [Hash] The options
-				#
-				def parse_options!(args)
-					options = { port: 4000, server: 'puma' }
-
-					::OptionParser.new do |opts|
-						opts.banner = "Usage: lenna #{command} [options]"
-
-						opts.on('-p', '--port [PORT]', Integer, 'Port to start the server') do |port|
-							options[:port] = port
-						end
-
-						opts.on('-s', '--server [SERVER]', String, 'Server to start') do |server|
-							options[:server] = server
-						end
-					end.parse!(args)
-
-					options
-				end
-
-				# Start the server
-				#
-				# @paramaeter port   [Integer] Port to start the server
-				# @paramaeter server [String] Server to start
-				#
-				# @return [void]
-				#
-				def start_server(port:, server:)
-					return warn_not_installed(server) unless instaled_gem?(server)
-
-					::File.exist?(config_file) or fail ::StandardError, ::Console.error("'config.ru' not found in #{poroject_name}.")
-
-					system("bundle exec #{server} #{config_file} --port #{port}", chdir: current_path)
-				rescue ::ArgumentError
-					::Console.error("The server '#{server}' is not supported yet.")
-				rescue ::Interrupt
-					::Console.info("\nServer stopped.")
-				rescue ::StandardError => e
-					::Console.error(self, e.message)
-				end
-
-				# Check if the gem is installed
-				#
-				# @parameter name [String] Name of the gem
-				#
-				# @return [Boolean]
-				#
-				def instaled_gem?(name)
-					::Gem::Specification.find_by_name(name)
-				rescue ::Gem::LoadError
-					false
-				end
-
-				# Get the name of the project
-				#
-				# @return [String] Name of the project
-				#
-				def poroject_name = @current_path.split('/').last
-
-				# Get the path of the project
-				#
-				# @return [String] Path of the project
-				#
-				def current_path = @current_path ||= ::Dir.pwd
-
-				# Get the path of the config file
-				#
-				# @return [String] Path of the config file
-				#
-				def config_file = "#{current_path}/config.ru"
-
-				# Warn the user that the gem is not installed
-				#
-				# @parameter name [String] Name of the gem
-				#
-				# @return [void]
-				#
-				def warn_not_installed(name)
-					::Console.warn("The gem '#{name}' is not installed. Please install it and try again.")
-				end
-			end
-		end
-	end
-end

data/lib/lenna/cli/templates/application.erb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'lennarb'
-
-class Application
-  include Lenna::Base
-
-	app.get '/' do |req, res|
-		res.html(<%= simple_template %>)
-	end
-end

data/lib/lenna/cli/templates/config.ru.erb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'app/application'
-
-run Application.app

data/lib/lenna/cli/templates/gemfile.erb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# [https://rubygems.org/gems/lennarb]
-# Lenna is a lightweight and experimental web framework for Ruby. It's designed
-# to be modular and easy to use. Also, that's how I affectionately call my wife.
-gem 'lennarb', '~> <%= version %>'
-# [https://rubygems.org/gems/puma]
-# Puma is a simple, fast, threaded, and highly parallel HTTP 1.1 server for Ruby/Rack applications.
-gem 'puma', '~> 6.4'
-
-group :development, :test do
-end

data/lib/lenna/middleware/app.rb

@@ -1,118 +0,0 @@
-# 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 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
-
-			# This method will initialize the global middlewares and the
-			# middleware chains cache.
-			#
-			# @return [void]
-			#
-			def initialize
-				@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.
-			# @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.
-			#
-			# @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
-
-				@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.
-			#
-			# @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
-end