lennarb 1.4.0 → 1.5.0

data/readme.md

@@ -1,65 +1,214 @@
 <div align="center">
   <picture>
-    <img alt="Lennarb" src="logo/lennarb.png" width="250">
+    <img alt="Lennarb" src="https://raw.githubusercontent.com/aristotelesbr/lennarb/refs/heads/main/logo/lennarb.svg" width="250">
   </picture>
 
----
+  <hr>
+
+  <p>A lightweight, fast, and modular web framework for Ruby based on Rack. <strong>Lennarb</strong> supports Ruby (MRI) 3.4+</p>
+
+  <a href="https://github.com/aristotelesbr/lennarb/actions/workflows/test.yaml">
+    <img src="https://github.com/aristotelesbr/lennarb/actions/workflows/test.yaml/badge.svg" alt="Test">
+  </a>
+  <a href="https://rubygems.org/gems/lennarb">
+    <img src="https://img.shields.io/gem/v/lennarb.svg" alt="Gem">
+  </a>
+  <a href="https://rubygems.org/gems/lennarb">
+    <img src="https://img.shields.io/gem/dt/lennarb.svg" alt="Gem">
+  </a>
+  <a href="https://tldrlegal.com/license/mit-license">
+    <img src="https://img.shields.io/:License-MIT-blue.svg" alt="MIT License">
+  </a>
+</div>
 
-A lightweight, fast, and modular web framework for Ruby based on Rack. The **Lennarb** supports Ruby (MRI) 3.4+
+## Table of Contents
 
-[![Tests](https://github.com/aristotelesbr/lennarb/workflows/rubyby-tests/badge.svg)](https://github.com/aristotelesbr/lennarb)
-[![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>
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Basic Usage](#basic-usage)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- Lightweight and modular architecture
+- High-performance routing system
+- Simple and intuitive API
+- Support for middleware
+- Flexible configuration options
+- Two implementation options:
+  - `Lennarb::App`: Minimalist approach for single applications
+  - `Lennarb::Base`: Extended version for mounting multiple applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lennarb'
+```
+
+Or install it directly:
+
+```bash
+gem install lennarb
+```
+
+## Quick Start
+
+Create a simple application with routes:
+
+```ruby
+require "lennarb"
+
+app = Lennarb::App.new do
+  routes do
+    get("/") do |req, res|
+      res.html("<h1>Welcome to Lennarb!</h1>")
+    end
+
+    get("/hello/:name") do |req, res|
+      name = req.params[:name]
+      res.html("Hello, #{name}!")
+    end
+  end
+end
+
+app.initialize!
+run app  # In config.ru
+```
+
+Start with: `rackup`
 
 ## Basic Usage
 
+### Creating a Simple Application
+
+The `Lennarb::App` class is the core of the framework:
+
 ```ruby
 require "lennarb"
 
-Lennarb.new do |router|
-  router.get("/hello/:name") do |req, res|
-    name = req.params[:name]
-    res.html("Hello, #{name}!")
+class MyApp < Lennarb::App
+  # Define configuration
+  config do
+    mandatory :database_url, string
+    optional :port, int, 9292
+  end
+
+  # Define routes
+  routes do
+    get("/") do |req, res|
+      res.html("<h1>Welcome!</h1>")
+    end
+
+    post("/users") do |req, res|
+      # Access request data
+      data = req.body
+      res.json({status: "created", data: data})
+    end
+  end
+
+  # Define hooks
+  before do |req, res|
+    # Run before every request
+    puts "Processing request: #{req.path}"
+  end
+
+  after do |req, res|
+    # Run after every request
+    puts "Completed request: #{req.path}"
+  end
+
+  # Define helper methods
+  helpers do
+    def format_date(date)
+      date.strftime("%Y-%m-%d")
+    end
   end
 end
+
+run MyApp.new.initialize!
 ```
 
-## Performance
+### Response Types
+
+Lennarb provides various response methods:
 
-### 1. Requests per Second (RPS)
+```ruby
+# HTML response
+res.html("<h1>Hello World</h1>")
+
+# JSON response
+res.json({message: "Hello World"})
 
-![RPS](https://raw.githubusercontent.com/aristotelesbr/lennarb/main/benchmark/rps.png)
+# Plain text response
+res.text("Plain text response")
 
-See all [graphs](https://github.com/aristotelesbr/lennarb/blob/main/benchmark)
+# Redirect
+res.redirect("/new-location")
 
-| Position | Application | 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  |
+# Custom status code
+res.json({error: "Not found"}, status: 404)
+```
 
-This table ranks the routers by the number of requests they can process per second. Higher numbers indicate better performance.
+### Mounting Applications
 
-Plese see [Performance](https://aristotelesbr.github.io/lennarb/guides/performance/index.html) for more information.
+For larger applications, use `Lennarb::Base` to mount multiple apps:
 
-## Usage
+```ruby
+class API < Lennarb::App
+  routes do
+    get("/users") do |req, res|
+      res.json([{id: 1, name: "Alice"}, {id: 2, name: "Bob"}])
+    end
+  end
+end
+
+class Admin < Lennarb::App
+  routes do
+    get("/dashboard") do |req, res|
+      res.html("<h1>Admin Dashboard</h1>")
+    end
+  end
+end
+
+class Application < Lennarb::Base
+  # Add common middleware
+  middleware do
+    use Rack::Session::Cookie, secret: "your_secret"
+  end
+
+  # Mount applications at specific paths
+  mount(API, at: "/api")
+  mount(Admin, at: "/admin")
+end
+
+run Application.new.initialize!
+```
 
-- [Getting Started](https://aristotelesbr.github.io/lennarb/guides/getting-started/index) - This guide covers getting up and running with **Lennarb**.
+## Documentation
 
-- [Performance](https://aristotelesbr.github.io/lennarb/guides/performance/index.html) - The **Lennarb** is very fast. The following benchmarks were performed on a MacBook Pro (Retina, 13-inch, Early 2013) with 2,7 GHz Intel Core i7 and 8 GB 1867 MHz DDR3. Based on [jeremyevans/r10k](https://github.com/jeremyevans/r10k) using the following [template build](static/r10k/build/lennarb.rb).
+For more detailed information, please see:
 
-- [Plugin](https://aristotelesbr.github.io/lennarb/guides/plugin/index.html) - You can create your plugins to extend the functionality of the framework.
+- [Getting Started](https://aristotelesbr.github.io/lennarb/guides/getting-started/index) - Setup and first steps
+- [Response](https://aristotelesbr.github.io/lennarb/guides/response/index.html) - Response handling
+- [Request](https://aristotelesbr.github.io/lennarb/guides/request/index.html) - Request handling
+- [Mounting Applications](https://aristotelesbr.github.io/lennarb/guides/mounting-applications/index.html) - Working with multiple apps
+- [Performance](https://aristotelesbr.github.io/lennarb/guides/performance/index.html) - Benchmarks showing Lennarb's routing algorithm efficiency
 
-- [Response](https://aristotelesbr.github.io/lennarb/guides/response/index.html) - This is the response guide.
-    The `res` object is used to send a response to the client. The Lennarb use a custom response object to send responses to the client. The `res` object is an instance of `Lennarb::Response`.
+## Contributing
 
-### Developer Certificate of Origin
+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
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/) and is governed by the [Contributor Covenant](https://www.contributor-covenant.org/).
 
-### Contributor Covenant
+## License
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+MIT License - see the [LICENSE](LICENSE) file for details.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lennarb
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Aristóteles Coutinho
 bindir: exe
 cert_chain: []
-date: 2025-02-09 00:00:00.000000000 Z
+date: 2025-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -51,6 +51,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: superconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -107,6 +135,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +220,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: m
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -206,7 +248,11 @@ files:
 - ".gitignore"
 - ".standard.yml"
 - ".tool-versions"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENCE
+- README.pt-BR.md
 - Rakefile
 - benchmark/memory.png
 - benchmark/rps.png
@@ -219,17 +265,31 @@ files:
 - gems.rb
 - guides/getting-started/readme.md
 - guides/links.yaml
+- guides/mounting-applications/readme.md
 - guides/performance/readme.md
 - guides/response/readme.md
 - lennarb.gemspec
 - lib/lennarb.rb
-- lib/lennarb/constansts.rb
+- lib/lennarb/app.rb
+- lib/lennarb/base.rb
+- lib/lennarb/config.rb
+- lib/lennarb/constants.rb
+- lib/lennarb/environment.rb
+- lib/lennarb/errors.rb
+- lib/lennarb/helpers.rb
+- lib/lennarb/hooks.rb
+- lib/lennarb/logger.rb
+- lib/lennarb/middleware/request_logger.rb
+- lib/lennarb/middleware_stack.rb
+- lib/lennarb/parameter_filter.rb
 - lib/lennarb/request.rb
+- lib/lennarb/request_handler.rb
 - lib/lennarb/response.rb
 - lib/lennarb/route_node.rb
+- lib/lennarb/routes.rb
 - lib/lennarb/version.rb
 - license.md
-- logo/lennarb.png
+- logo/lennarb.svg
 - readme.md
 homepage: https://aristotelesbr.github.io/lennarb
 licenses:

data/lib/lennarb/constansts.rb

@@ -1 +0,0 @@
-HTTP_METHODS = %i[GET POST PUT PATCH DELETE HEAD OPTIONS].freeze