lennarb 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd39c745c65bf722a7075f57bbd36a2a603b659ddecb23bac33b7733c0b912e2
-  data.tar.gz: 723a60bc0e9cf0ed60c3f548e8e9004310a29c3c36c63b6ab55308ca99c83da3
+  metadata.gz: b091cfa5731b3dc0b46ecfa6712b9e3ceeae0eedcce9bc97133683162e12ce28
+  data.tar.gz: 49a8957ed5b951e9e9b7d728fb72c9675e1c6d5eb22a897f2d305e106f02dd98
 SHA512:
-  metadata.gz: 901cfe54fe27ea6addd4b48690f3cd12b73a9f85e05066f9382f6467e65e537760509958bfb4ffd23cc2ab523168428dd3c2b50027c523b8cfb15b3c1af1b4a0
-  data.tar.gz: c877fb10d4a3f918016390b43fcc54ed3b70fb8c38577b23a4c34b1820f3c2d898c685f738de1f6c7ff6e2c25066b2fb95e8020ef7a00c22a02f0c5f847fa76b
+  metadata.gz: f494fd50eefbe648c73be463054f14995af8d771d593571ca3908aaa8341502433e925d6df74e99c8427a1cad5473a28495d10e45fe4e54e18a10efd1b22edd9
+  data.tar.gz: 4e858da099b1bdb88ad3593aa8354da285a4e33b4c59545dfb394ea84c6623f4d163c5500143fb86accb76356a1c35b67e9972d0a2667fd925dd79b6852e963c

data/.github/workflows/coverage.yaml

@@ -7,52 +7,30 @@ permissions:
 
 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'
+    name: Coverage Check
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{matrix.ruby}}
+          ruby-version: '3.4'
           bundler-cache: true
 
       - name: Run tests
         timeout-minutes: 5
-        run: bundle exec rake
+        run: bundle exec rake test
 
-      - uses: actions/upload-artifact@v4
-        with:
-          name: coverage-${{matrix.os}}-${{matrix.ruby}}
-          path: .covered.db
-
-  validate:
-    needs: test
-    runs-on: ubuntu-latest
+      - name: Check coverage threshold
+        timeout-minutes: 1
+        run: bundle exec rake coverage:check
 
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
+      - name: Upload coverage reports
+        uses: actions/upload-artifact@v4
         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 \;
+          name: coverage-report
+          path: coverage

data/.github/workflows/documentation.yaml

@@ -4,11 +4,16 @@ on:
   push:
     branches:
       - main
-
-    workflow_dispatch:
+    paths:
+      - 'lib/**'
+      - '*.md'
+      - 'logo/**'
+      - '.yardopts'
+      - '.github/workflows/documentation.yaml'
+  workflow_dispatch:
 
 permissions:
-  contents: read
+  contents: write
   pages: write
   id-token: write
 
@@ -25,23 +30,37 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
-      - uses: ruby/setup-ruby@v1
+      - name: Set up Ruby
+        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: Install dependencies
+        run: bundle install
 
       - name: Generate documentation
         timeout-minutes: 5
-        run: bundle exec bake utopia:project:static --force no
+        run: |
+          bundle exec yard doc
+          echo "Documentation generated successfully"
 
-      - name: Deploy GitHub Pages
-        run: bundle exec bake github:pages:commit --directory docs
+          if [ -f "doc/logo/lennarb.svg" ]; then
+            echo "Logo file successfully included in documentation"
+          else
+            echo "Warning: Logo file not found in generated documentation"
+            exit 1
+          fi
 
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: doc
+          branch: gh-pages
+          clean: true
+          commit-message: "docs: update documentation [skip ci]"

data/.gitignore

@@ -1,12 +1,21 @@
 /.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
 /pkg/
 /gems.locked
 /.covered.db
 /external
 /docs
+/.ruby-lsp
+doc/
 .DS_Store
 *.gem
 *.rbc
 .git
 .ruby-lsp
 coverage/
+tmp/
+!tmp/.keep
+.yardo/
+minitestfailures

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private 
+--verbose
+--debug
+--readme readme.md 'lib/**/*.rb' - CHANGELOG.md CODE_OF_CONDUCT.md LICENSE.md CONTRIBUTING.md logo/lennarb.svg
+--exclude /test/
+--asset logo:logo
+
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,118 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes
+* Focusing on what is best for the community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project team. All complaints will be reviewed and investigated
+promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+---
+
+# Código de Conduta
+
+## Nossa Promessa
+
+Nós, como membros, contribuidores e líderes, comprometemo-nos a fazer a
+participação em nossa comunidade uma experiência livre de assédio para todos,
+independentemente de idade, corpo, deficiência visível ou invisível, etnia,
+características sexuais, identidade de gênero e expressão,
+nível de experiência, educação, situação socioeconômica, nacionalidade,
+aparência pessoal, raça, religião ou identidade e orientação sexual.
+
+Comprometemo-nos a agir e interagir de maneiras que contribuam para uma
+comunidade aberta, acolhedora, diversificada, inclusiva e saudável.
+
+## Nossos Padrões
+
+Exemplos de comportamento que contribuem para um ambiente positivo:
+
+* Demonstrar empatia e bondade com outras pessoas
+* Respeitar opiniões, pontos de vista e experiências divergentes
+* Dar e receber feedback construtivo de forma graciosa
+* Assumir responsabilidade e pedir desculpas aos afetados por nossos erros
+* Focar no que é melhor para a comunidade
+
+Exemplos de comportamento inaceitável:
+
+* Uso de linguagem ou imagens sexualizadas e atenção ou avanços sexuais
+* Comentários insultuosos/depreciativos e ataques pessoais ou políticos
+* Assédio público ou privado
+* Publicar informações privadas de outros sem permissão explícita
+* Outras condutas que possam ser razoavelmente consideradas inadequadas em um
+  ambiente profissional
+
+## Responsabilidades de Aplicação
+
+Os mantenedores do projeto são responsáveis por esclarecer e aplicar
+nossos padrões de comportamento aceitável e tomarão ações corretivas
+apropriadas e justas em resposta a qualquer comportamento que considerem
+inapropriado, ameaçador, ofensivo ou prejudicial.
+
+## Escopo
+
+Este Código de Conduta se aplica em todos os espaços comunitários e também
+quando um indivíduo está representando oficialmente a comunidade em espaços
+públicos.
+
+## Aplicação
+
+Instâncias de comportamento abusivo, assediador ou de outra forma
+inaceitável podem ser reportadas à equipe do projeto. Todas as reclamações
+serão analisadas e investigadas prontamente e de forma justa.
+
+## Atribuição
+
+Este Código de Conduta é adaptado do
+[Contributor Covenant](https://www.contributor-covenant.org),
+versão 2.0, disponível em
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+

data/CONTRIBUTING.md

@@ -0,0 +1,155 @@
+# Contributing to Lennarb
+
+We love your input! We want to make contributing to Lennarb as easy and
+transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Development Process
+
+We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
+
+### Pull Requests
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -am 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+### Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of
+the layer when doing a build.
+2. Update the `README.md` with details of changes to the interface, this
+includes new environment variables, exposed ports, useful file locations,
+and container parameters.
+3. Increase the version numbers in any examples files and the `README.md`
+to the new version that this Pull Request would represent. The versioning
+scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request once you have the sign-off of at least one
+other developer, or if you do not have permission to do that, you may request
+the reviewer to merge it for you.
+
+## Reporting Bugs
+
+We use GitHub issues to track public bugs. Report a bug by opening a new issue;
+it's that easy!
+
+### Bug Report Template
+
+**Title**: Short description of the bug
+
+**Description**:
+
+- **Current Behavior**: A clear and concise description of what the bug is.
+- **Expected Behavior**: A clear and concise description of what you
+expected to happen.
+- **Steps To Reproduce**: Steps to reproduce the behavior:
+    1. Go to '...'
+    2. Click on '....'
+    3. Scroll down to '....'
+    4. See error
+- **Environment**:
+  - Ruby version:
+  - OS:
+  - Lennarb version:
+- **Additional Context**: Add any other context about the problem here.
+
+## Code Style
+
+Maintain the code style used throughout the project:
+
+- Follow Ruby style guidelines
+- Use meaningful variable and function names
+- Comment your code when necessary
+- Keep your code clean and maintainable
+
+## License
+
+By contributing, you agree that your contributions will be licensed under
+the project's MIT License.
+
+---
+
+## Contribuindo para o Lennarb - Português
+
+Adoramos seu input! Queremos tornar a contribuição para o Lennarb o
+mais fácil e transparente possível, seja:
+
+- Reportando um bug
+- Discutindo o estado atual do código
+- Enviando uma correção
+- Propondo novos recursos
+- Tornando-se um mantenedor
+
+## Processo de Desenvolvimento
+
+Usamos o GitHub para hospedar código, rastrear problemas e solicitações de
+recursos, bem como aceitar pull requests.
+
+### Solicitações de Pull Request
+
+1. Faça um fork do repositório
+2. Crie sua branch de recurso (`git checkout -b feature/recurso-incrivel`)
+3. Faça commit de suas alterações (`git commit -am 'Adicionar recurso incrível'`)
+4. Envie para a branch (`git push origin feature/recurso-incrivel`)
+5. Abra um Pull Request
+
+### Processo de Pull Request
+
+1. Certifique-se de que todas as dependências de instalação ou compilação
+sejam removidas antes do fim da camada ao fazer uma compilação.
+2. Atualize o README.md com detalhes das alterações na interface, incluindo
+novas variáveis de ambiente, portas expostas, localizações úteis de arquivos
+e parâmetros de contêiner.
+3. Aumente os números de versão em quaisquer arquivos de exemplos e o
+`README.md` para a nova versão que este Pull Request representaria. O esquema
+de versionamento que usamos é [SemVer](http://semver.org/).
+4. Você pode mesclar o Pull Request depois de ter a aprovação de pelo menos um
+outro desenvolvedor, ou se não tiver permissão para isso, poderá solicitar ao
+revisor que o mescle para você.
+
+## Reportando Bugs
+
+Usamos issues do GitHub para rastrear bugs públicos. Reporte um bug abrindo
+uma nova issue; é simples assim!
+
+### Modelo de Relatório de Bug
+
+**Título**: Breve descrição do bug
+
+**Descrição**:
+
+- **Comportamento Atual**: Uma descrição clara e concisa do bug.
+- **Comportamento Esperado**: Uma descrição clara e concisa do que você
+esperava que acontecesse.
+- **Passos Para Reproduzir**: Passos para reproduzir o comportamento:
+    1. Vá para '...'
+    2. Clique em '....'
+    3. Role para baixo até '....'
+    4. Veja o erro
+- **Ambiente**:
+  - Versão do Ruby:
+  - Sistema Operacional:
+  - Versão do Lennarb:
+- **Contexto Adicional**: Adicione qualquer outro contexto sobre o problema aqui.
+
+## Estilo de Código
+
+Mantenha o estilo de código usado em todo o projeto:
+
+- Siga as diretrizes de estilo Ruby
+- Use nomes significativos para variáveis e funções
+- Comente seu código quando necessário
+- Mantenha seu código limpo e de fácil manutenção
+
+## Licença
+
+Ao contribuir, você concorda que suas contribuições serão licenciadas sob a
+Licença MIT do projeto.
+

data/README.pt-BR.md

@@ -0,0 +1,147 @@
+<div align="center">
+  <picture>
+    <img alt="Lennarb" src="logo/lennarb.svg" width="250">
+  </picture>
+
+---
+
+Um framework web leve, rápido e modular para Ruby baseado em Rack. **Lennarb** suporta Ruby (MRI) 3.4+
+
+[![Test](https://github.com/aristotelesbr/lennarb/actions/workflows/test.yaml/badge.svg)](https://github.com/aristotelesbr/lennarb/actions/workflows/test.yaml)
+[![Gem](https://img.shields.io/gem/v/lennarb.svg)](https://rubygems.org/gems/lennarb)
+[![Gem](https://img.shields.io/gem/dt/lennarb.svg)](https://rubygems.org/gems/lennarb)
+[![MIT License](https://img.shields.io/:License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+
+</div>
+
+## Índice
+
+- [Características](#características)
+- [Instalação](#instalação)
+- [Início Rápido](#início-rápido)
+- [Performance](#performance)
+- [Documentação](#documentação)
+- [Contribuindo](#contribuindo)
+- [Licença](#licença)
+
+## Características
+
+- Arquitetura leve e modular
+- Sistema de roteamento de alta performance
+- API simples e intuitiva
+- Suporte para middleware
+- Opções de configuração flexíveis
+- Duas opções de implementação:
+  - `Lennarb::App`: Abordagem minimalista para controle completo
+  - `Lennarb::Application`: Versão estendida com componentes comuns
+
+## Opções de Implementação
+
+Lennarb oferece duas abordagens de implementação para atender diferentes necessidades:
+
+- **Lennarb::App**: Abordagem minimalista para controle completo
+- **Lennarb::Application**: Versão estendida com componentes comuns
+
+Consulte a [documentação](https://aristotelesbr.github.io/lennarb/guides/getting-started/index) para detalhes sobre cada implementação.
+
+## Instalação
+
+Adicione esta linha ao Gemfile da sua aplicação:
+
+```ruby
+gem 'lennarb'
+```
+
+Ou instale diretamente:
+
+```bash
+gem install lennarb
+```
+
+## Guia Rápido
+
+```ruby
+require "lennarb"
+
+app = Lennarb::App.new do
+  configure do
+    mandary :database_url, string
+    optional :port, integer, 9292
+    optional :env, string, "development"
+  end
+
+  routes do
+    get("/") do |req, res|
+      res.html("<h1>Bem-vindo ao Lennarb!</h1>")
+    end
+
+    get("/hello/:name") do |req, res|
+      name = req.params[:name]
+      res.html("Olá, #{name}!")
+    end
+  end
+end
+
+app.initialize!
+run app  # Em config.ru
+```
+
+Inicie com: `rackup`
+
+## Performance
+
+Lennarb é projetado para alta performance:
+
+![RPS](https://raw.githubusercontent.com/aristotelesbr/lennarb/main/benchmark/rps.png)
+
+| Posição | Aplicação  | 10 RPS     | 100 RPS    | 1.000 RPS | 10.000 RPS |
+| ------- | ---------- | ---------- | ---------- | --------- | ---------- |
+| 1       | Lenna      | 126.252,36 | 108.086,55 | 87.111,91 | 68.460,64  |
+| 2       | Roda       | 123.360,37 | 88.380,56  | 66.990,77 | 48.108,29  |
+| 3       | Syro       | 114.105,38 | 80.909,39  | 61.415,86 | 46.639,81  |
+| 4       | Hanami-API | 68.089,18  | 52.851,88  | 40.801,78 | 27.996,00  |
+
+Veja todos os [gráficos de benchmark](https://github.com/aristotelesbr/lennarb/blob/main/benchmark)
+
+## Documentação
+
+- [Primeiros Passos](https://aristotelesbr.github.io/lennarb/guides/getting-started/index) - Configuração e primeiros passos
+- [Performance](https://aristotelesbr.github.io/lennarb/guides/performance/index.html) - Benchmarks e otimização
+- [Response](https://aristotelesbr.github.io/lennarb/guides/response/index.html) - Tratamento de respostas
+- [Request](https://aristotelesbr.github.io/lennarb/guides/request/index.html) - Tratamento de requisições
+
+## Funcionalidades Principais
+
+```ruby
+# Diferentes tipos de resposta
+res.html("<h1>Olá Mundo</h1>")
+res.json("{\"mensagem\": \"Olá Mundo\"}")
+res.text("Resposta em texto simples")
+
+# Parâmetros de rota
+get("/usuarios/:id") do |req, res|
+  user_id = req.params[:id]
+  res.json("{\"id\": #{user_id}}")
+end
+
+# Redirecionamentos
+res.redirect("/nova-localizacao")
+```
+
+Para mais exemplos e documentação completa, consulte:
+[Documentação Completa do Lennarb](https://aristotelesbr.github.io/lennarb/guides/getting-started/index)
+
+## Contribuindo
+
+1. Faça um fork do repositório
+2. Crie sua branch de feature (`git checkout -b feature/recurso-incrivel`)
+3. Commit suas alterações (`git commit -am 'Adiciona recurso incrível'`)
+4. Push para a branch (`git push origin feature/recurso-incrivel`)
+5. Abra um Pull Request
+
+Este projeto utiliza o [Developer Certificate of Origin](https://developercertificate.org/) e é regido pelo [Contributor Covenant](https://www.contributor-covenant.org/).
+
+## Licença
+
+Licença MIT - veja o arquivo [LICENSE](LICENSE) para detalhes.
+

data/Rakefile

@@ -6,7 +6,38 @@ Rake::TestTask.new do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
+  t.verbose = false
+end
+
+namespace :coverage do
+  desc "Validate code coverage meets minimum threshold (85%)"
+  task :check do
+    require "json"
+
+    puts "Validating code coverage..."
+
+    coverage_dir = "coverage"
+    coverage_json = File.join(coverage_dir, "coverage.json")
+
+    unless File.exist?(coverage_json)
+      puts "Error: Coverage JSON data not found at #{coverage_json}."
+      puts "Run tests with SimpleCov enabled first."
+      exit 1
+    end
+
+    data = JSON.parse(File.read(coverage_json))
+    percent = data["metrics"]["covered_percent"].to_f.round(2)
+
+    puts "Coverage: #{percent}%"
+
+    threshold = 85
+    if percent < threshold
+      puts "Coverage is below the required #{threshold}% threshold!"
+      exit 1
+    else
+      puts "Coverage meets the required threshold. Good job!"
+    end
+  end
 end
 
 task default: :test

data/changelog.md

@@ -7,6 +7,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `Lennarb::Application` class to be the base class of the "standard" implementation of the Lennarb framework.
+- Add middleware support to Lennarb::App class.
+- Add `middleware` support to the `Lennarb::Application` with default middlewares.
+- Add files to centralize the errors of the project.
+- Add CODE_OF_CONDUCT.md in English and Portuguese
+- Add CONTRIBUTING.md in English and Portuguese
+- Add `Lennarb::Logger` class for structured logging with support for tags and colorization
+- Add logger dependency to enhance logging capabilities in the framework
+- Add `Lennarb::ParameterFilter` for sensitive parameter filtering in logs and exceptions
+- Add `Lennarb::RequestLogger` middleware for detailed HTTP request logging
+- Add `Lennarb::Hooks` module for implementing hooks in the framework
+- Add improved request handling and configuration options
+- Add `RoutesFrozenError` for improved route modification handling
+- Add support for defining helpers with both modules and blocks in `Lennarb::App`.
+- Add `Lennarb::Helpers.define` method to handle modules and blocks for helper definitions.
+- Add tests for `Lennarb::Helpers` to validate module inclusion and block evaluation.
+- Add `Lennarb::Hooks` tests to validate hook initialization, addition, and execution.
+
+### Changed
+
+- Lennarb Logo
+- Migrate from utopiaproject to yard for documentation
+- Fix logo SVG display in yard documentation
+- Restructure App class to enhance routing, middleware, and initialization processes
+- Simplify Routes class by removing unnecessary comments and enhancing route definitions
+- Introduce Helpers module for managing application-specific helper methods
+- Update logger tag to use symbol for consistency
+- Enhance logging functionality with improved request logging details
+- Simplify config method by removing block parameter and improving readability
+- Update `Lennarb::App.helpers` to accept a module or block for defining helpers.
+
+### Fixed
+
+- Fix typo in require_relative statement for constants file
+- Fix conditional debug dependency based on Ruby engine
+
 ## [1.4.1] - 2025-02-23
 
 ### Added