Ruby Rails

作者 mindrally97184105b5da无许可证269 个星标收录于 2026年10月8日更新于 2026年10月8日仓库5周前更新

Conventions and best practices for building web applications with Ruby on Rails. Use when scaffolding Rails apps or generators, designing ActiveRecord models and migrations, wiring up Hotwire/Turbo/Stimulus interactivity, setting up background jobs or caching, or writing RSpec/Minitest coverage for Rails code.

AI 生成的概览

提供构建 Ruby on Rails Web 应用的约定与最佳实践,涵盖模型、迁移、Hotwire、后台任务与测试。

功能
提供符合 Ruby 与 Rails 惯例的指导,包括命名规范、MVC 架构、ActiveRecord 建模、索引、预加载与缓存。内容涵盖 Rails 8 默认组件,如 Solid Queue、Solid Cache、Solid Cable、Propshaft 与 Kamal,以及使用 Hotwire、Tailwind CSS 和 ViewComponents 的前端集成。还涉及安全实践,如强参数、CSRF 防护与身份验证,以及使用 Minitest 或 RSpec、FactoryBot 和 TDD 的测试方法。
适用场景
适用于搭建 Rails 应用或生成器、设计 ActiveRecord 模型与迁移、接入 Hotwire/Turbo/Stimulus 交互、配置后台任务或缓存,以及为 Rails 代码编写 RSpec/Minitest 测试。适合希望遵循框架约定与最佳实践的 Rails 开发者。它本身不会运行命令或生成文件。
运行要求
无需脚本或工具,仅为说明性内容。若要实践其中的建议,需要 Ruby on Rails 项目、Ruby 3.x、PostgreSQL 等数据库,以及可选的测试与前端库,如 RSpec、Minitest、FactoryBot、Hotwire、Tailwind CSS 和 ViewComponents。

Ruby on Rails

This skill covers Ruby and Ruby on Rails development, including Rails conventions, ActiveRecord patterns, frontend integration, security, and testing.

Core Principles

  • Write concise, idiomatic Ruby code with accurate examples
  • Adhere to Rails conventions (Convention over Configuration)
  • Follow the Ruby Style Guide for formatting consistency
  • Leverage Ruby 3.x features like pattern matching and endless methods
  • Prefer Rails command-line generators (bin/rails generate ...) over hand-written boilerplate — they keep files consistent with framework conventions and wire up tests/routes automatically
  • Use bin/dev to run the local development server (it boots the web process plus any configured watchers) and check logs after significant changes

Naming Conventions

  • Use snake_case for files, methods, and variables
  • Use CamelCase for classes and modules
  • Follow Rails naming conventions for models, controllers, views

Architecture & Performance

  • Utilize ActiveRecord for database operations with proper indexing
  • Use PostgreSQL in production, with proper indexes, connection pooling, and safe/reversible migrations
  • Implement eager loading to prevent N+1 query problems
  • Apply fragment caching and Russian Doll caching strategies
  • Use service objects for complex business logic
  • Follow MVC architecture strictly
  • Keep controllers RESTful and focused

Rails 8 Defaults

Rails 8 ships with a "no PaaS needed" stack — favor these built-ins over adding external services unless there's a specific reason not to:

  • Solid Queue — database-backed ActiveJob adapter; use it as the default background job backend instead of standing up Redis/Sidekiq unless job volume or feature needs (e.g., Sidekiq Pro batches) require it
  • Solid Cache — database-backed cache store; a reasonable default for Rails.cache without a separate Redis/Memcached deployment
  • Solid Cable — database-backed Action Cable adapter for WebSockets without Redis
  • Propshaft — the default asset pipeline; simpler than Sprockets, just serves fingerprinted files without a bundling step
  • Kamal — the default deployment tool for shipping containerized Rails apps to your own servers

Frontend & UI

  • Employ Hotwire (Turbo and Stimulus) for standard Rails interactivity and dynamic interactions without full page reloads
  • Reach for a Vite-managed JS pipeline (e.g., vite_rails) only when you actually need npm-managed JavaScript (React/Vue components, complex bundling) — don't add it by default
  • Design responsively with Tailwind CSS
  • Maintain DRY views through helpers and partials
  • Use ViewComponents for reusable UI components

Security

  • Implement authentication/authorization via Devise or Pundit
  • Use strong parameters in controllers to prevent mass assignment vulnerabilities
  • Sanitize user inputs appropriately
  • Use CSRF protection tokens
  • Implement proper session management

Testing

  • Write comprehensive Minitest or RSpec coverage for models, controllers, and integration flows, following TDD practices
  • Use FactoryBot for test data generation rather than fixtures
  • Mock external services; stub predefined return values
  • Use shared examples for common behaviors across different contexts
  • Ensure each test is independent; avoid shared state between tests

Best Practices

  • Keep controllers thin, models fat (but not too fat)
  • Use concerns for shared functionality
  • Implement background jobs with Sidekiq or ActiveJob
  • Use proper database migrations
  • Follow RESTful routing conventions

来源与署名

来源:mindrally/skills位于ruby-rails提交9718410

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架