lennarb 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59a236423ff7acaaeec6bf3b3b2a7dd42bfbc704eac97f7e2c7aa0539ebc0f45
-  data.tar.gz: 19b0a12ce5aa48f252c1ff342987b3c4e42073fe80a584dd983c3739321b316c
+  metadata.gz: b3b1fe759bb5de90ef757201a4023c441a9c40146f31a318aecc5c5c08cd04bb
+  data.tar.gz: 8137ee838ca5636d7013cbfa5aa5f7e83d66e3b28d3387255b702d82becd884a
 SHA512:
-  metadata.gz: 4df198f477ac2fcb3c09efb95ad9ea2699d6a12051cc9bcacd56c65adfe6d7778eed6cc1e920d6df35141d4dbbbb5aab4dfcc4aaea00483666e836b114b9e5e3
-  data.tar.gz: 03a57883380017a70be1974bd98cdd6df3bd851c1944f787db4d97aec1ddc0f8947f3fc8a3179d817585d5a8ce877454f52a539ab8b77403bafe4cdd0321d7c1
+  metadata.gz: 3216bc56c89485d3292b621dcdfb26082957bea1ecfc622107b2f631f86508d7eb5318ce5bc43889ccf0db59775dcefd34e7e4ac00f5b023f34c4f371bab83b9
+  data.tar.gz: 944b432173eeeee78c2fc8d546ee74f6768ab3581a61babfdad27f8e54969afd96581259d8866126a3e6e26c2418f92355af8cc07d3aa215b0f9fb9a6bceccc0

data/changelog.md

@@ -0,0 +1,210 @@
+# 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.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
+
+- 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/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/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/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