lennarb 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fafe6e0a4a4fcb12d0cb7d75187b89c5ff2a8f4847bdab4db666d670fd1d40e
-  data.tar.gz: 43739df71271e6410f691b19d0e31c64ea5e883ae79150a3d0055d17a200fe8a
+  metadata.gz: cd39c745c65bf722a7075f57bbd36a2a603b659ddecb23bac33b7733c0b912e2
+  data.tar.gz: 723a60bc0e9cf0ed60c3f548e8e9004310a29c3c36c63b6ab55308ca99c83da3
 SHA512:
-  metadata.gz: 8015dceb914f8bf52ee77eff7faf3adca26cdb020a3acba0ce3cc58ecd7eec338e84afe87fcd691867e087a646875b06a9f278c220b25f4f627bc87ff7288306
-  data.tar.gz: c9a7b74731ac3fe4e607396647931656628e1df03968069891d65189b0f387df44d89054191a34a41bdaf7a3381ad6c2486f91fba13dfd4b5a3b04a79f299af7
+  metadata.gz: 901cfe54fe27ea6addd4b48690f3cd12b73a9f85e05066f9382f6467e65e537760509958bfb4ffd23cc2ab523168428dd3c2b50027c523b8cfb15b3c1af1b4a0
+  data.tar.gz: c877fb10d4a3f918016390b43fcc54ed3b70fb8c38577b23a4c34b1820f3c2d898c685f738de1f6c7ff6e2c25066b2fb95e8020ef7a00c22a02f0c5f847fa76b

data/.devcontainer/Dockerfile

@@ -0,0 +1,8 @@
+# Released under the MIT License.
+# Copyright, 2023, by Aristóteles Coutinho.
+
+# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6
+ARG VARIANT="3"
+FROM mcr.microsoft.com/devcontainers/ruby:${VARIANT}
+
+RUN apt-get update

data/.devcontainer/devcontainer.json

@@ -0,0 +1,20 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Lennarb project development",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	// "image": "mcr.microsoft.com/devcontainers/ruby:1-3.2-bullseye"
+	"build": {
+		"dockerfile": "Dockerfile"
+	}
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+	// Configure tool-specific properties.
+	// "customizations": {},
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

data/.github/workflows/coverage.yaml

@@ -0,0 +1,58 @@
+name: Coverage
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+  COVERAGE: PartialSummary
+  BUNDLE_WITH: maintenance
+
+jobs:
+  test:
+    name: ${{matrix.ruby}} on ${{matrix.os}}
+    runs-on: ${{matrix.os}}-latest
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+
+        ruby:
+          - '3.4'
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+
+      - name: Run tests
+        timeout-minutes: 5
+        run: bundle exec rake
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{matrix.os}}-${{matrix.ruby}}
+          path: .covered.db
+
+  validate:
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - uses: actions/download-artifact@v4
+
+      - name: Validate coverage
+        timeout-minutes: 5
+        run: bundle exec bake covered:validate --paths */.covered.db \;

data/.github/workflows/documentation.yaml

@@ -0,0 +1,47 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+    workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
+env:
+  CONSOLE_OUTPUT: XTerm
+  BUNDLE_WITH: maintenance
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Installing packages
+        run: sudo apt-get install wget
+
+      - name: Prepare GitHub Pages
+        run: bundle exec bake github:pages:prepare --directory docs
+
+      - name: Generate documentation
+        timeout-minutes: 5
+        run: bundle exec bake utopia:project:static --force no
+
+      - name: Deploy GitHub Pages
+        run: bundle exec bake github:pages:commit --directory docs
+

data/.github/workflows/main.yaml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.4'
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run the default task
+        run: bundle exec rake test

data/.github/workflows/test.yaml

@@ -0,0 +1,50 @@
+name: Test
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+
+jobs:
+  test:
+    name: ${{matrix.ruby}} on ${{matrix.os}}
+    runs-on: ${{matrix.os}}-latest
+    continue-on-error: ${{matrix.experimental}}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+
+        ruby:
+          - '3.4'
+
+        experimental: [false]
+
+        include:
+          - os: ubuntu
+            ruby: truffleruby
+            experimental: true
+          - os: ubuntu
+            ruby: jruby
+            experimental: true
+          - os: ubuntu
+            ruby: head
+            experimental: true
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+
+      - name: Run tests
+        timeout-minutes: 10
+        run: bundle exec rake test
+      - name: Run linter
+        run: bundle exec rake standard

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/pkg/
+/gems.locked
+/.covered.db
+/external
+/docs
+.DS_Store
+*.gem
+*.rbc
+.git
+.ruby-lsp
+coverage/

data/.standard.yml

@@ -0,0 +1,23 @@
+ruby_version: 3.4.1
+
+ignore:
+  - 'bin/**/*'
+  - 'vendor/**/*'
+  - 'db/schema.rb'
+
+plugins:
+  - standard-custom
+  - standard-performance
+
+standard_custom:
+  rules:
+    lambda_call_style: 
+      enabled: false
+      style: "call"
+    
+    lambda_syntax:
+      enabled: false
+      style: "line_count_dependent"
+    
+    copyright_notice:
+      enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.1

data/LICENCE

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) 2023, Aristóteles Coutinho costa
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "standard/rake"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/lennarb"
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/release

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'lennarb/version'
+require 'colorize'
+
+puts 'Generating gem version...'.green
+system('bundle exec gem build lennarb.gemspec')
+puts 'Gem version generated successfully'.green
+
+puts 'Installing gem version...'.green
+
+version = Lennarb::VERSION
+system("gem install ./lennarb-#{version}.gem")
+puts 'Lenna installed successfully'.green
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/changelog.md

@@ -7,6 +7,77 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.4.1] - 2025-02-23
+
+### Added
+
+- Add support to mount routes. Now, you can centralize the routes in a single file and mount them in the main application. Ex.
+
+```rb
+class PostsController
+  extend Lennarb::Routes::Mixin
+
+  get '/posts' do |req, res|
+    res.html('Posts')
+  end
+end
+
+SampleApp = Lennarb.new do |router|
+  mount PostsController
+end
+```
+
+The `mount` method will add the routes from the `PostsController` class to the main application. You can use the `mount` method with multiple classes, ex. `mount PostsController, CommentsController`.
+
+- Add `Lennarb::Environment` module to manage the environment variables in the project. Now, the `Lennarb` class is the main class of the project.
+- Add `Lennarb::Config` module to manage the configuration in the project. Now, the `Lennarb` class is the main class of the project.
+- Add `Lennarb::App` class.
+- Lint the code with `standard` gem on the CI/CD pipeline.
+
+### Changed
+
+- Convert the `Lennarb` class to a module. Now, the `App` class is the main class of the project.
+- Move the request process to `Lennarb::RequestHandler` class.
+- Improve the method `merge!` from `Lennarb::RouterNode` to prevent the duplication of the routes.
+
+### Fixed
+
+- Software design issues.
+
+## [1.4.0] - 2025-02-09
+
+### Changed
+
+- The `freeze!` method was removed from the `Lennarb` class. Use `initializer!` to build and freeze the application.
+
+```rb
+# app.rb
+
+require 'lennarb'
+
+MyApp = Lennarb.new do |router|
+  router.get '/hello' do |req, res|
+    res.html('Hello World')
+  end
+end
+
+MyApp.initializer!
+
+run MyApp
+```
+
+### Remove
+
+- Removes bake scripts from the project. Use `rack'` to run tasks.
+- Removes `plugin` module and basic plugins from the project. Now, the `Lennarb` class is the main class of the project.
+- Removes unnecessary tests.
+- Removes `.rubocop.yml` file from the project. Now, the project uses the default configuration of the `standard` gem.
+
+### Added
+
+- Add `simplecov` gem to generate the test coverage report.
+- Add `m` gem to run the tests.
+
 ## [1.3.0] - 2024-11-21
 
 ### Added
@@ -78,9 +149,9 @@ That permits to create a new application with the `Lennarb::ApplicationBase` cla
 require 'lennarb'
 
 class MyApp < Lennarb::ApplicationBase
-	get '/hello' do |req, res|
-		res.html('Hello World')
-	end
+ get '/hello' do |req, res|
+  res.html('Hello World')
+ end
 end
 ```
 
@@ -88,7 +159,6 @@ end
 
 - Remove `Lennarb::Application` module from the project. Now, the `Lennarb` class is the main class of the project.
 
-
 ## [0.4.0] - 2024-07-02
 
 ### Added
@@ -105,9 +175,9 @@ require 'lennarb'
 class MyApp
   include Lennarb::ApplicationBase
 
-	get '/hello' do |req, res|
-		res.html('Hello World')
-	end
+ get '/hello' do |req, res|
+  res.html('Hello World')
+ end
 end
 ```
 
@@ -144,6 +214,7 @@ end
 - 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.
 

data/exe/lenna

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Aristóteles Coutinho.
+# Copyright, 2023-2025, by Aristóteles Coutinho.
 
 # Require the main file
 #
 # @private `Since v0.1`
 #
-require 'lennarb'
+require "lennarb"
 
 # Show the version
 #

data/gems.rb

@@ -0,0 +1,29 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lennarb.gemspec
+gemspec
+
+group :maintenance, optional: true do
+  # [https://rubygems.org/gems/bake]
+  # Bake is a Ruby library that helps you to create a new project.
+  gem "bake"
+  # [https://rubygems.org/gems/covered]
+  # Covered is a Ruby library that helps you to test your project.
+  gem "covered"
+  # [https://rubygems.org/gems/bake-gem]
+  # Bake Gem is a Bake extension that helps you to create a new Ruby
+  # gem.
+  gem "bake-gem"
+  # [https://rubygems.org/gems/bake-modernize]
+  # Bake Modernize is a Bake extension that helps you to modernize your
+  # Ruby code.
+  gem "bake-modernize"
+  # [https://rubygems.org/gems/bake-github-pages]
+  # Bake Github Pages is a Bake extension that helps you to publish your
+  # project documentation to Github Pages.
+  gem "bake-github-pages"
+  # [https://rubygems.org/gems/utpia-project]
+  # Utopia Project is a Bake extension that helps you to create a new
+  # project.
+  gem "utopia-project"
+end