Comece aqui
- Começando com Rails
-
Tudo o que você precisa saber para instalar o Rails e criar sua primeira aplicação.
Models
- Active Record Basics
-
O Active Record permite seus models interagirem com o banco de dados da aplicação. Este guia irá ajudá-lo a começar com models, persistência no banco de dados.
- Active Record Migrations
-
As migrations são um recurso do Active Record que permitem que você evolua seu schema do banco de dados ao longo do tempo. Em vez de escrever modificações de schema em SQL puro, as migrações permitem que você use uma DSL Ruby para descrever as mudanças em suas tabelas.
- Active Record Validations
-
As validações são usadas para garantir que apenas dados válidos sejam salvos em seu banco de dados. Este guia ensina como validar o estado de objetos antes de irem para o banco de dados, usando as validações do Active Record.
- Active Record Callbacks
-
Callbacks tornam possível escrever código que será executado sempre que um objeto é criado, atualizado, destruído, etc. Este guia ensina como executar uma ação durante este ciclo de vida de objetos Active Record.
- Active Record Associations
-
No Active Record, uma associação é uma conexão entre dois models Active Record. Este guia cobre todas as associações fornecidas pelo Active Record.
- Active Record Query Interface
-
Em vez de usar SQL bruto para encontrar registros de banco de dados, o Active Record oferece melhores maneiras de realizar as mesmas operações. Este guia abrange diferentes maneiras de recuperar dados do banco de dados usando o Active Record.
- Active Model Basics
-
O Active Model permite que você crie objetos Ruby simples que se integram com o Action Pack, mas não precisa do Active Record para persistência do banco de dados. O Active Model também ajuda a construir ORMs personalizados para uso fora do framework Rails. Este guia fornece tudo que você precisa para começar a usar classes Active Model.
Views
- Action View Overview
- Work in progress
-
Action View é responsável por gerar o HTML para as respostas da web. Este guia fornece uma introdução ao Action View.
- Layouts and Rendering in Rails
-
Este guia aborda os recursos básicos de layout do Action Controller e do Action View, incluindo renderização e redirecionamento, uso de blocos de content_for e como utilizar partials.
- Action View Helpers
- Work in progress
-
Action View tem métodos auxiliares para lidar com tudo, desde a formatação de datas e links para imagens, para limpar e localizar conteúdo. Este guia apresenta alguns dos métodos do Action View mais comuns.
- Action View Form Helpers
- Work in progress
-
Formulários HTML podem rapidamente se tornar tediosos de escrever e manter por causa da necessidade de lidar com a nomenclatura de controle de formulário e seus numerosos atributos. O Rails acaba com essa complexidade, fornecendo viewers helpers para gerar a marcação de formulário.
Controllers
- Action Controller Overview
- Work in progress
-
Controllers são o núcleo de uma requisição web no Rails. Este guia cobre como os controllers funcionam e como eles se encaixam no ciclo de solicitação da sua aplicação. Inclui sessões, filtros, cookies, streaming de dados e lidar com exceções levantadas por uma solicitação, entre outros tópicos.
- Rails Routing from the Outside In
-
O roteador Rails reconhece URLs e os despacha para um controller. Este guia cobre os recursos voltados para o usuário usar no roteamento de requisição com Rails. Se você quiser entender como usar o roteamento em suas aplicações Rails, comece por aqui.
Outros componentes
- Active Support Core Extensions
- Work in progress
-
O Active Support fornece extensões e utilitários da linguagem Ruby. Enriquece a linguagem Ruby para o desenvolvimento de aplicações Rails e para o desenvolvimento do próprio Ruby on Rails.
- Action Mailer Basics
- Work in progress
-
Este guia fornece tudo que você precisa para começar a enviar e-mails da sua aplicação e muitos componentes internos do Action Mailer.
- Action Mailbox Basics
- Work in progress
-
Este guia aborda como usar o Action Mailbox para receber emails.
- Action Text Overview
- Work in progress
-
Este guia aborda como usar o Action Rext para com conteúdo de texto com marcações.
- Active Job Basics
- Work in progress
-
O Active Job é uma estrutura para declarar tarefas em segundo plano e torná-los executáveis em uma variedade de back-ends de enfileiramento. Este guia fornece tudo o que você precisa para começar a criar, enfileirar e executar tarefas (jobs) em segundo plano (background).
- Active Storage Overview
- Work in progress
-
Active Storage facilita o upload de arquivos para um serviço de armazenamento em nuvem, transformar uploads e extrair metadados. Este guia aborda como anexar arquivos aos seus models do Active Record.
- Action Cable Overview
- Work in progress
-
Action Cable integra WebSockets com o resto da sua aplicação Rails. Ele permite que recursos em tempo real sejam escritos em Ruby no mesmo estilo e forma do resto de sua aplicação Rails. Este guia explica como funciona o Action Cable e como usar WebSockets para criar funcionalidades em tempo real.
- Webpacker
- Work in progress
-
Este guia mostrará como instalar e usar o Webpacker para empacotar JavaScript, CSS e outros ativos para o lado do cliente da sua aplicação Rails.
Indo mais fundo
- Rails Internationalization (I18n) API
- Work in progress
-
Este guia aborda como adicionar internacionalização para suas aplicações. Sua aplicação poderá traduzir conteúdo para diferentes idiomas, alterar regras de pluralização, usar formatos de data corretos para cada país e assim por diante.
- Testing Rails Applications
- Work in progress
-
Este é um guia é bastante abrangente para as várias facilitades de testar no Rails. Abrange tudo, desde 'O que é um teste?' à teste de integração. Divirta-se.
- Securing Rails Applications
- Work in progress
-
Este guia descreve problemas comuns de segurança em aplicações web e como evitá-los com o Rails.
- Debugging Rails Applications
- Work in progress
-
Este guia descreve como depurar (debug) aplicações Rails. Abrange as diferentes maneiras de realizar e entender o que está acontecendo "nos bastidores" do seu código.
- Configuring Rails Applications
- Work in progress
-
Este guia aborda as configurações básicas de uma aplicação Rails.
- The Rails Command Line
- Work in progress
-
Existem alguns comandos que são absolutamente essenciais para o uso do Rails no dia a dia. Este guia aborda as ferramentas de linha de comando fornecidas pelo Rails.
- The Asset Pipeline
- Work in progress
-
A asset pipeline fornce uma estrutura para concatenar e minimizar ou comprimir JavaScript, CSS e recursos de imagem. Também adiciona a capacidade de escrever esses ativos em outras linguagens e pré-processadores, como CoffeeScript, Sass e ERB.
- Working with JavaScript in Rails
- Work in progress
-
Este guia explica como usar mapas de importação ou jsbundling-rails para incluir JavaScript em aplicações Rails e cobre os conceitos básicos de trabalho com Turbo no Rails.
- The Rails Initialization Process
- Work in progress
-
Este guia explica os aspectos internos do processo de inicialização do Rails. É um guia extremamente aprofundado e recomendado para pessoas desenvolvedoras mais experientes.
- Autoloading and Reloading Constants
- Work in progress
-
Este guia documenta como funcionam o carregamento automático e recarregamento de constantes funciona (modo Zeitwerk).
- Classic para Zeitwerk - Como Fazer
- Work in progress
-
Este guia documenta como migrar aplicações Rails do modo clássico para o modo
zeitwerk
. - Caching with Rails: An Overview
- Work in progress
-
Este guia é uma introdução para acelerar sua aplicação Rails com cache.
- Active Support Instrumentation
- Work in progress
-
Este guia explica como usar a API de instrumentação dentro do Active Support para medir eventos dentro do Rails e outros códigos Ruby.
- Using Rails for API-only Applications
- Work in progress
-
Este guia explica como usar efetivamente o Rails para desenvolver uma API JSON.
- Active Record and PostgreSQL
- Work in progress
-
Este guia aborda o uso específico do Active Record com PostgreSQL.
- Multiple Databases with Active Record
- Work in progress
-
Este guia aborda o uso de múltiplos banco de dados na sua aplicação.
- Active Record Encryption
- Work in progress
-
Este guia cobre a criptografia das informações do seu banco de dados usando Active Record.
Estendendo o Rails
- The Basics of Creating Rails Plugins
- Work in progress
-
Este guia aborda como construir um plugin para estender as funcionalidades do Rails.
- Rails on Rack
- Work in progress
-
Este guia aborda a integração do Rails com o Rack e as interfaces com outros componentes do Rack.
- Creating and Customizing Rails Generators & Templates
- Work in progress
-
Este guia cobre o processo de adicionar um novo gerador ou fornecer uma alternativa a um elemento de um gerador embutido no Rails (como o fornecimento de stubs alternativos para o gerador scaffold).
- Getting Started with Engines
- Work in progress
-
Os engines (motor) podem ser considerados aplicações em miniatura que fornecem funcionalidades adicionais para sua aplicação principal. Neste guia você aprenderá como criar seu próprio motor e integrá-lo a uma aplicação.
- Threading and Code Execution in Rails
- Work in progress
-
Este guia descreve as considerações necessárias e as ferramentas disponíveis ao trabalhar diretamente com a concorrência em uma aplicação Rails.
Contribuições
- Contributing to Ruby on Rails
- Work in progress
-
O Rails não é o framework 'de outras pessoas'. Este guia aborda uma variedade de maneiras que você pode se envolver no desenvolvimento em andamento do Rails.
- API Documentation Guidelines
- Work in progress
-
Este guia documenta as diretrizes de documentação da API do Ruby on Rails.
- Ruby on Rails Guides Guidelines
- Work in progress
-
Este guia documenta as diretrizes dos guias do Ruby on Rails.
Políticas
- Maintenance Policy for Ruby on Rails
- Work in progress
-
Quais versões do Ruby on Rails são suportadas atualmente e quando esperar novas versões.
Release Notes
- Upgrading Ruby on Rails
- Work in progress
-
Este guia fornece etapas a serem seguidas ao atualizar sua aplicação para uma versão mais recente do Ruby on Rails.
- Version 7.0 - Dezembro 2021
- Work in progress
-
Notas de versão para o Rails 7.0.
- Version 6.1 - Dezembro 2020
- Work in progress
-
Notas de versão para o Rails 6.1.
- Version 6.0 - Agosto 2019
- Work in progress
-
Notas de versão para o Rails 6.0.
- Version 5.2 - April 2018
- Work in progress
-
Notas de versão para o Rails 5.2.
- Version 5.1 - April 2017
- Work in progress
-
Notas de versão para o Rails 5.1.
- Version 5.0 - June 2016
- Work in progress
-
Notas de versão para o Rails 5.0.
- Version 4.2 - December 2014
- Work in progress
-
Notas de versão para o Rails 4.2.
- Version 4.1 - April 2014
- Work in progress
-
Notas de versão para o Rails 4.1.
- Version 4.0 - June 2013
- Work in progress
-
Notas de versão para o Rails 4.0.
- Version 3.2 - January 2012
- Work in progress
-
Notas de versão para o Rails 3.2.
- Version 3.1 - August 2011
- Work in progress
-
Notas de versão para o Rails 3.1.
- Version 3.0 - August 2010
- Work in progress
-
Notas de versão para o Rails 3.0.
- Version 2.3 - March 2009
- Work in progress
-
Notas de versão para o Rails 2.3.
- Version 2.2 - November 2008
- Work in progress
-
Notas de versão para o Rails 2.2.
Feedback
Você é incentivado a ajudar a melhorar a qualidade deste guia.
Por favor, contribua caso veja quaisquer erros, inclusive erros de digitação. Para começar, você pode ler nossa sessão de contribuindo com a documentação.
Você também pode encontrar conteúdo incompleto ou coisas que não estão atualizadas. Por favor, adicione qualquer documentação em falta na main do Rails. Certifique-se de checar o Edge Guides (en-US) primeiro para verificar se o problema já foi resolvido ou não no branch main. Verifique as Diretrizes do Guia Ruby on Rails para estilo e convenções.
Se, por qualquer motivo, você encontrar algo para consertar, mas não conseguir consertá-lo, por favor abra uma issue no nosso Guia.
E por último, mas não menos importante, qualquer tipo de discussão sobre a documentação do Ruby on Rails é muito bem vinda na forum oficial do Ruby on Rails e nas issues do Guia em português.