lennarb 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133bc5b7fbe787ae7bf9d17f79cddb09d75f3e1d12e99deff891edae698b109a
-  data.tar.gz: de9d4b466c30c19b1fd84e6d55c162f144904aa09d22d4bc874bb7291eb72ce8
+  metadata.gz: b3b1fe759bb5de90ef757201a4023c441a9c40146f31a318aecc5c5c08cd04bb
+  data.tar.gz: 8137ee838ca5636d7013cbfa5aa5f7e83d66e3b28d3387255b702d82becd884a
 SHA512:
-  metadata.gz: 1aa540d8f1f3d7d82104f441f4d141249485597d34d80072bb2c5df38237ea2651dba35b4f2499f00be7c9d1a94755c2400aefbe102283ff5a0ea3341dc74e97
-  data.tar.gz: 5660b98b90c019ff4501076845668ddea45210e701d91eae9b99c38a36ee7605511903178e986239934078d22aa8d7156d6efe4c73560e5c4951d7c734fa6f77
+  metadata.gz: 3216bc56c89485d3292b621dcdfb26082957bea1ecfc622107b2f631f86508d7eb5318ce5bc43889ccf0db59775dcefd34e7e4ac00f5b023f34c4f371bab83b9
+  data.tar.gz: 944b432173eeeee78c2fc8d546ee74f6768ab3581a61babfdad27f8e54969afd96581259d8866126a3e6e26c2418f92355af8cc07d3aa215b0f9fb9a6bceccc0

data/changelog.md

@@ -5,6 +5,51 @@ 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.7] - 2023-23-12
+
+### Added
+
+- Add `console` gem to print the logs in the console.
+
+- Add CLI module to:
+  - Create a new project with `lennarb new` command.
+  - Run the server with `lennarb server` command.
+
+- Add simple guide to create and run a project with Lennarb. See [guides/command-line/readme.md](guides/command-line/readme.md) for more details.
+
+- Add `Reload` middleware to reload the application in development environment. You can import and use this middleware in your application. Ex.
+
+```rb
+# app.rb
+
+require 'lenna/middleware/default/reload'
+
+app = Lenna::Application.new
+
+app.use Lenna::Middleware::Default::Reload
+```
+
+In the next version, this middleware will be available by default in development environment.
+
+- Add `root` method to `Lennarb` module to get the root path of the project. Ex.
+
+```rb
+# app.rb
+
+Lennarb.root.join('app.rb')
+# => /home/user/project/app.rb
+```
+
+- Add `zeitwerk` gem to load the files in the project.
+
+### Remove
+
+- Remove `Logging` and `ErrorHandling` middlewares from any environment. Now, theses middlewares are only available in development environment.
+
+### Changed
+
+- Change log level to `fatal` in test environment.
+
 ## [0.1.6] - 2023-21-12
 
 ### Changed
@@ -81,16 +126,16 @@ request.params = { name: 'John' }
 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
+  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

data/exe/lenna

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
+# Require the main file
+#
+# @private `Since v0.1`
+#
+require 'lennarb'
+
+# Call the CLI to start the server
+#
+# @private `Since v0.1`
+#
+Lenna::Cli::App.run!(ARGV)

data/lib/lenna/cli/app.rb

@@ -0,0 +1,39 @@
+# 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

@@ -0,0 +1,125 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,143 @@
+# 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

@@ -0,0 +1,11 @@
+# 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

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

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

@@ -0,0 +1,14 @@
+# 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/default/reload.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
+require 'console'
+
+# This middleware is used to reload files in development mode.
+#
+module Lenna
+	module Middleware
+		module Default
+			class Reload
+				attr_accessor :directories, :files_mtime
+
+				# Initializes a new instance of Middleware::Default::Reload.
+				#
+				# @parameter directories [Array] An array of directories to monitor.
+				#
+				# @return [Middleware::Default::Reload] A new instance of Middleware::Default::Reload.
+				def initialize(directories = [])
+					self.files_mtime = {}
+					self.directories = directories
+
+					monitor_directories(directories)
+				end
+
+				# Calls the middleware.
+				#
+				# @parameter req             [Rack::Request] The request.
+				# @parameter _res            [Rack::Response] The response.
+				# @parameter next_middleware [Proc] The next middleware.
+				#
+				# @return [void]
+				#
+				def call(_req, _res, next_middleware)
+					reload_if_needed
+
+					next_middleware.call
+				rescue ::StandardError => error
+					::Console.error(self, error)
+				end
+
+				private
+
+				# Reloads files if needed.
+				#
+				# @return [void]
+				#
+				def reload_if_needed
+					modified_files = check_for_modified_files
+
+					reload_files(modified_files) unless modified_files.empty?
+				end
+
+				# Monitors directories for changes.
+				#
+				# @parameter directories [Array] An array of directories to monitor.
+				#
+				# @return [void]
+				#
+				def monitor_directories(directories)
+					directories.each do |directory|
+						::Dir.glob(directory).each { |file| files_mtime[file] = ::File.mtime(file) }
+					end
+				end
+
+				# Checks for modified files.
+				#
+				# @return [Array] An array of modified files.
+				#
+				# @example
+				#   check_for_modified_files #=> ["/path/to/file.rb"]
+				#
+				def check_for_modified_files
+					@files_mtime.select do |file, last_mtime|
+						::File.mtime(file) > last_mtime
+					end.keys
+				end
+
+				# Reloads files.
+				#
+				# @parameter files [Array] An array of files(paths) to reload.
+				#
+				# @return [void]
+				#
+				def reload_files(files)
+					files.each do |file|
+						::Console.debug("Reloading #{file}")
+						::Kernel.load file
+						@files_mtime[file] = ::File.mtime(file)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/lenna/router.rb

@@ -67,10 +67,7 @@ module Lenna
 		#
 		# @return [void]
 		#
-		def initialize(
-			middleware_manager: Middleware::App.instance,
-			cache: Cache.new
-		)
+		def initialize(middleware_manager: Middleware::App.instance, cache: Cache.new)
 			@cache = cache
 			@root_node = Node.new({}, nil)
 			@middleware_manager = middleware_manager
@@ -142,12 +139,21 @@ module Lenna
 		# @return        [Array] the Lennarb::Response
 		#
 		def call!(env)
+			# TODO: Use pifano to set middlewares by environment.
+			#
+			middlewares_by_enviroment =
+				if ENV['RACK_ENV'] == 'development'
+					[
+						Middleware::Default::Logging,
+						Middleware::Default::ErrorHandler
+					]
+				else
+					[]
+				end
+
 			middleware_pipeline = @middleware_manager.fetch_or_build_middleware_chain(
 				method(:process_request),
-				[
-					Middleware::Default::Logging,
-					Middleware::Default::ErrorHandler
-				]
+				middlewares_by_enviroment
 			)
 
 			req = Request.new(env)
@@ -177,12 +183,7 @@ module Lenna
 		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:
-			)
+			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

data/lib/lennarb/version.rb

@@ -4,7 +4,7 @@
 # Copyright, 2023, by Aristóteles Coutinho.
 
 module Lennarb
-	VERSION = '0.1.6'
+	VERSION = '0.1.7'
 
 	public_constant :VERSION
 end

data/lib/lennarb.rb

@@ -13,3 +13,34 @@ require 'lennarb/array_extensions'
 #
 require 'lenna/application'
 require 'lennarb/version'
+
+# Core extensions
+#
+require 'pathname'
+
+# Zeitwerk
+#
+require 'zeitwerk'
+
+# Zeitwerk loader
+#
+Zeitwerk::Loader.new.tap do |loader|
+	loader.inflector.inflect('Version' => 'VERSION')
+	loader.push_dir(__dir__)
+	loader.setup
+end
+
+# Lennarb module
+#
+module Lennarb
+	module_function
+
+	# Lennarb root path
+	#
+	# @return [Pathname] the root path
+	#
+	def root
+		File.expand_path('..', __dir__)
+		Pathname.new(File.expand_path('..', __dir__))
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lennarb
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Aristóteles Coutinho
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -44,10 +58,33 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.8
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.12
 - !ruby/object:Gem::Dependency
   name: bake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.2
@@ -55,6 +92,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.2
@@ -130,15 +170,25 @@ dependencies:
         version: 0.33.0
 description:
 email:
-executables: []
+executables:
+- lenna
 extensions: []
 extra_rdoc_files: []
 files:
 - changelog.md
+- exe/lenna
 - lib/lenna/application.rb
+- lib/lenna/cli/app.rb
+- lib/lenna/cli/commands/create_project.rb
+- lib/lenna/cli/commands/interface.rb
+- lib/lenna/cli/commands/start_server.rb
+- lib/lenna/cli/templates/application.erb
+- lib/lenna/cli/templates/config.ru.erb
+- lib/lenna/cli/templates/gemfile.erb
 - lib/lenna/middleware/app.rb
 - lib/lenna/middleware/default/error_handler.rb
 - lib/lenna/middleware/default/logging.rb
+- lib/lenna/middleware/default/reload.rb
 - lib/lenna/router.rb
 - lib/lenna/router/builder.rb
 - lib/lenna/router/cache.rb
@@ -175,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A lightweight and experimental web framework for Ruby.