DocsCadres Fullstack

De Ruby on Rails à Nexy

Dans Nexy, une route Rails et son action de contrôleur deviennent un seul fichier sous src/routes/ : les vues ERB deviennent des .nexy pages avec Jinja2, les paramètres forts deviennent des modèles Pydantic et before_action devient un dependencies.py.

Chaque section ci-dessous montre une habitude Rails, puis la même chose dans Nexy.

Un itinéraire et son action

config/routes.rb
get "/api/hello", to: "hello#show"
app/controllers/hello_controller.rb
class HelloController < ApplicationController  def show    render json: { message: "Hello" }  endend

Il n'y a pas de routes.rb : le chemin du fichier est l'URL, le nom de la fonction est la méthode HTTP.

src/routes/api/hello.py
async def GET():    return {"message": "Hello"}

resources

config/routes.rb
resources :notes, only: [:index, :create, :show, :destroy]

Les sept actions REST sont réparties sur deux fichiers, un par URL :

src/routes/api/notes/index.py
from pydantic import BaseModel NOTES: dict[int, str] = {}  class NewNote(BaseModel):    title: str  async def GET():    return [{"id": id, "title": title} for id, title in NOTES.items()]  async def POST(note: NewNote):    id = max(NOTES, default=0) + 1    NOTES[id] = note.title    return {"id": id, "title": note.title}
src/routes/api/notes/[id].py
from nexy.http import HTTPException from .index import NOTES  async def GET(id: int):    if id not in NOTES:        raise HTTPException(status_code=404, detail="No such note")    return {"id": id, "title": NOTES[id]}  async def DELETE(id: int):    NOTES.pop(id, None)    return {"deleted": id}
Action ferroviaire Nexy
index, create GET, POST dans notes/index.py
show, update, destroy GET, PATCH, DELETE dans notes/[id].py
new, edit .nexy pages, notes/new.nexy et notes/[id]/edit.nexy

params et paramètres forts

app/controllers/items_controller.rb
def create  item = params.require(:item).permit(:name, :price)  render json: item, status: :createdend

Le modèle est la liste des permis et la validation : les champs inconnus sont supprimés, les mauvais répondent 422.

src/routes/api/items.py
from pydantic import BaseModel, Field from nexy.http import JSONResponse  class NewItem(BaseModel):    name: str    price: float = Field(gt=0)  async def POST(item: NewItem):    return JSONResponse(item.model_dump(), status_code=201)

Un paramètre de chaîne de requête, params[:q], est un paramètre de fonction :

src/routes/api/search.py
async def GET(q: str = "", page: int = 1):    return {"q": q, "page": page}

namespace et before_action

config/routes.rb
namespace :admin do  get "stats", to: "stats#show"end
app/controllers/admin/base_controller.rb
class Admin::BaseController < ApplicationController  before_action :require_admin   private   def require_admin    head :forbidden unless request.headers["X-Role"] == "admin"  endend

L'espace de noms est le dossier, et son dependencies.py est le before_action de chaque route qu'il contient :

src/routes/admin/stats.py
async def GET():    return {"users": 3}
src/routes/admin/dependencies.py
from nexy.http import Header, HTTPException  def require_admin(x_role: str = Header("")) -> None:    if x_role != "admin":        raise HTTPException(status_code=403, detail="Admins only")  dependencies = [require_admin]

after_action et middleware Rack

app/controllers/application_controller.rb
after_action { response.set_header("X-App", "demo") }
src/routes/middleware.py
from nexy.http import Request  async def middleware(request: Request, call_next):    response = await call_next(request)    response.headers["x-app"] = "demo"    return response

Vues de l'ERB

app/controllers/users_controller.rb
def index  @users = [{ name: "Ada" }, { name: "Alan" }]end
app/views/users/index.html.erb
<ul>  <% @users.each do |user| %>  <li><%= user[:name] %></li>  <% end %></ul>

L'action et la vue forment un seul fichier .nexy ; les variables d'instance deviennent des noms simples :

src/routes/users.nexy
---users = [{"name": "Ada"}, {"name": "Alan"}]---<ul>  {% for user in users %}  <li>{{ user.name }}</li>  {% endfor %}</ul>

<%= %> s'échappe et {{ }} ne le fait pas : échappe à ce qu'un visiteur a tapé avec {{ value | e }}. <%== %> et raw sont | safe.

Mises en page et yield

app/views/layouts/application.html.erb
<!DOCTYPE html><html>  <body><%= yield %></body></html>
src/routes/layout.nexy
---children: prop[NexyElement]---<!DOCTYPE html><html>  <body>{{ children | safe }}</body></html>

Un layout.nexy dans un sous-dossier s'imbrique dans celui-ci, comme le fait une disposition par contrôleur.

Partiels

app/views/shared/_card.html.erb
<article><h2><%= title %></h2><%= yield %></article>
<%= render "shared/card", title: "Latest" do %><p>This week</p><% end %>
src/components/Card.nexy
---title: prop[str]---<article>  <h2>{{ title }}</h2>  <Slot /></article>
src/routes/index.nexy
---from "@/components/Card.nexy" import Card---<Card title="Latest">  <p>This week</p></Card>

@ est src/ : nx new écrit useAliases = {"@": "src"} dans nexyconfig.py.

form_with et redirect_to

app/views/notes/index.html.erb
<%= form_with url: notes_path do |form| %>  <%= form.text_field :title %>  <%= form.submit "Add" %><% end %>
app/controllers/notes_controller.rb
def create  Note.create!(title: params[:title])  redirect_to notes_pathend

Une action est le create sur lequel le formulaire est publié. Ses paramètres sont les champs, et le visiteur est redirigé vers la page avec un 303 :

src/actions/notes.py
from nexy.decorators import Action TITLES: list[str] = []  @Actionasync def add_note(title: str) -> None:    TITLES.append(title)
src/routes/notes.nexy
---from src.actions.notes import TITLES---<form method="post" action="{{ __actions_path['add_note'] }}">  <input name="title">  <button type="submit">Add</button></form><ul>  {% for title in TITLES %}  <li>{{ title }}</li>  {% endfor %}</ul>

Enregistrement actif et migrations

app/models/post.rb
class Post < ApplicationRecord  scope :published, -> { where(published: true) }end

Nexy n'a pas d'ORM propre ; nx new peut échafauder SQLModel, SQLAlchemy ou Tortoise-ORM. Avec SQLModel :

src/models/post_model.py
from sqlmodel import Field, SQLModel  class Post(SQLModel, table=True):    id: int | None = Field(default=None, primary_key=True)    title: str    published: bool = False
src/routes/api/posts/published.py
from sqlmodel import Session, select from src.configs.db import enginefrom src.models.post_model import Post  async def GET():    with Session(engine) as session:        posts = session.exec(select(Post).where(Post.published)).all()    return {"titles": [post.title for post in posts]}
Rails Nexy
rails generate migration AddPosts nx migrate -m "add posts"
rails db:migrate nx migrate --upgrade

ActiveRecord::RecordNotFound et public/404.html

app/controllers/posts_controller.rb
def show  @post = POSTS.fetch(params[:slug]) { raise ActiveRecord::RecordNotFound }end
src/routes/posts/[slug].nexy
---from nexy import notFound POSTS = {"hello": "Hello, world"} slug: prop[str]if slug not in POSTS:    notFound()---<h1>{{ POSTS[slug] }}</h1>

notfound.nexy à la racine des routes est public/404.html, rendu comme n'importe quelle page :

src/routes/notfound.nexy
<h1>Not found</h1>

Séances

app/controllers/sessions_controller.rb
def create  session[:user] = params[:name]  render json: { user: session[:user] }end
nexyconfig.py
from nexy.core.models import NexyConfigModel  class NexyConfig(NexyConfigModel):    useAliases = {"@": "src"}    useSession = {"secret_key": "change-me"}
src/routes/api/login.py
from pydantic import BaseModel from nexy.http import Request  class Login(BaseModel):    name: str  async def POST(request: Request, body: Login):    request.session["user"] = body.name    return {"user": body.name}

Une page le lit avec useSession().

Mise en cache

app/controllers/blog_controller.rb
def index  expires_in 1.minute, public: trueend
src/routes/blog/index.nexy
---revalidate = 60---<h1>Blog</h1>

Emploi actif

app/controllers/signups_controller.rb
WelcomeMailerJob.perform_later(params[:email])head :accepted
src/routes/api/signup.py
from nexy.http import BackgroundTasks, JSONResponse  def send_welcome(email: str) -> None: ...  async def POST(email: str, tasks: BackgroundTasks):    tasks.add_task(send_welcome, email)    return JSONResponse({"queued": True}, status_code=202)

Pour les tentatives et les travailleurs séparés, comme avec Sidekiq, utilisez Celery, RQ ou arq.

Câble d'action

app/channels/echo_channel.rb
class EchoChannel < ApplicationCable::Channel  def receive(data)    transmit(data)  endend
src/routes/ws/echo.py
from fastapi import WebSocket  async def SOCKET(websocket: WebSocket):    await websocket.accept()    await websocket.send_text(await websocket.receive_text())

Fil chaud

Les échanges de pages de Turbo Drive correspondent au routeur client d'un projet en mode client, et les contrôleurs Stimulus correspondent aux îlots : un petit composant qui s'hydrate à l'intérieur d'une page de serveur. Voir Îles et CSR.

Essais

spec/requests/hello_spec.rb
RSpec.describe "Hello", type: :request do  it "says hello" do    get "/api/hello"    expect(response.parsed_body).to eq("message" => "Hello")  endend
tests/test_hello.py
from fastapi.testclient import TestClient from nexy.app import app  def test_hello():    assert TestClient(app).get("/api/hello").json() == {"message": "Hello"}

Courir

Rails Nexy
rails new nx new
bin/rails server nx dev
bin/rails routes /docs
RAILS_ENV=production bin/rails server nx build, puis nx start
bin/rails test / rspec nx test

Prochaines étapes

Modifier sur GitHub

Entrée ouvre le résultat, Échap ferme.