lennarb 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fafe6e0a4a4fcb12d0cb7d75187b89c5ff2a8f4847bdab4db666d670fd1d40e
-  data.tar.gz: 43739df71271e6410f691b19d0e31c64ea5e883ae79150a3d0055d17a200fe8a
+  metadata.gz: fb597d27bfaffebc72a4b7aa52f74dd0c5e94c60d401c4f8c30558246509a59d
+  data.tar.gz: 0a49adeeb50aee3f5d09a641535d9e230aadeb40d69dc9a1883551641f045999
 SHA512:
-  metadata.gz: 8015dceb914f8bf52ee77eff7faf3adca26cdb020a3acba0ce3cc58ecd7eec338e84afe87fcd691867e087a646875b06a9f278c220b25f4f627bc87ff7288306
-  data.tar.gz: c9a7b74731ac3fe4e607396647931656628e1df03968069891d65189b0f387df44d89054191a34a41bdaf7a3381ad6c2486f91fba13dfd4b5a3b04a79f299af7
+  metadata.gz: 4a682640f80f02dc84fba9e1f9aa7f666b68b08101c19e2ab406dc9e5367352be25bf7f9f91b26b39ff2f92f9a2c472cc7ba1c306679970fa510fbca73806a04
+  data.tar.gz: cb431441f0481b65774ed39f83bf12bb19a2316e3815bfba88388cefc7a641c712777727de51a3a03f60fde4a6de078b2c34d4abb25481835958cc9bb4eb2377

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,49 @@
+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.3'
+          - '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

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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: %i[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,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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 +112,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 +122,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 +138,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
 ```
 

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

data/guides/getting-started/readme.md

@@ -0,0 +1,201 @@
+# Getting Started with Lennarb
+
+## Overview
+
+Lennarb is a minimalist, thread-safe Rack-based web framework for Ruby that focuses on simplicity and performance. It provides a clean routing DSL and straightforward request/response handling.
+
+## Installation
+
+Add Lennarb to your project's Gemfile:
+
+```ruby
+gem 'lennarb'
+```
+
+Or install it directly via RubyGems:
+
+```bash
+gem install lennarb
+```
+
+## Quick Start
+
+### Basic Application
+
+Create a new file named `config.ru`:
+
+```ruby
+require 'lennarb'
+
+app = Lennarb.new do |app|
+  app.get '/' do |req, res|
+    res.status = 200
+    res.html('<h1>Welcome to Lennarb!</h1>')
+  end
+end
+
+app.initializer!
+run app
+```
+
+Start the server:
+
+```bash
+rackup
+```
+
+Your application will be available at `http://localhost:9292`.
+
+## Core Concepts
+
+### Request Handling
+
+Each route handler receives two arguments:
+
+- `req`: A Request object wrapping the Rack environment
+- `res`: A Response object for building the HTTP response
+
+### Response Types
+
+Lennarb provides three main response helpers:
+
+```rb
+app.get '/text' do |req, res|
+  res.text('Plain text response')
+end
+
+app.get '/html' do |req, res|
+  res.html('<h1>HTML response</h1>')
+end
+
+app.get '/json' do |req, res|
+  res.json('{"message": "JSON response"}')
+end
+```
+
+### Redirects
+
+```ruby
+app.get '/redirect' do |req, res|
+  res.redirect('/new-location', 302) # 302
+end
+```
+
+Routes are defined using HTTP method helpers:
+
+```ruby
+app = Lennarb.new do |l|
+  # Basic route
+  l.get '/' do |req, res|
+    res.html('Home page')
+  end
+
+  # Route with parameters
+  l.get '/users/:id' do |req, res|
+    user_id = req.params[:id]
+    res.json("{\"id\": #{user_id}}")
+  end
+end
+```
+
+### Route Parameters
+
+Parameters from dynamic route segments are available in `req.params`:
+
+```ruby
+app.get '/hello/:name' do |req, res|
+  name = req.params[:name]
+  res.text("Hello, #{name}!")
+end
+```
+
+## Thread Safety
+
+Lennarb is thread-safe by design:
+
+- All request processing is synchronized using a mutex
+- The router tree is frozen after initialization
+- Response objects are created per-request
+
+## Application Lifecycle
+
+### Initialization
+
+```ruby
+app = Lennarb.new do |l|
+  # Define routes and configuration
+end
+
+# Initialize and freeze the application
+app.initializer!
+```
+
+The `initializer!` method:
+
+- Loads environment-specific dependencies
+- Freezes the route tree
+- Freezes the Rack application
+
+### Environment
+
+Lennarb uses the `LENNA_ENV` environment variable (defaults to "development"):
+
+```bash
+LENNA_ENV=production rackup
+```
+
+## Error Handling
+
+Lennarb provides basic error handling:
+
+```ruby
+app.get '/api' do |req, res|
+  # Errors are caught and return 500 with error message
+  raise "Something went wrong"
+end
+```
+
+Default error responses:
+
+- 404 for unmatched routes
+- 500 for application errors
+
+## Best Practices
+
+1. **Always call initializer!**
+
+   ```ruby
+   app = Lennarb.new { |l| ... }
+   app.initializer!
+   run app
+   ```
+
+2. **Set response status**
+
+   ```ruby
+   app.get '/api' do |req, res|
+     res.status = 200
+     res.json('{"status": "ok"}')
+   end
+   ```
+
+3. **Use appropriate response types**
+
+   ```ruby
+   # HTML for web pages
+   res.html('<h1>Web Page</h1>')
+
+   # JSON for APIs
+   res.json('{"data": "value"}')
+
+   # Text for simple responses
+   res.text('Hello')
+   ```
+
+## Support
+
+For help and bug reports, please visit:
+
+- GitHub Issues: [lennarb/issues](https://github.com/aristotelesbr/lennarb/issues)
+
+Now you can run your app!

data/guides/links.yaml

@@ -0,0 +1,6 @@
+getting-started:
+  order: 1
+performance:
+  order: 2
+response:
+  order: 3